Update a coupon

Admin or branch manager only. Patches the active flag, expiry, use cap, or description. An empty patch answers 400 and an unknown coupon 404; deactivating a coupon is a soft delete.

PUT/api/v1/coupons/{couponId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

couponIdstringrequired

The coupon id.

Request body

requiredapplication/json

is_activeboolean | null

valid_untilstring | null

max_usesinteger | null

Show properties

Any of:

integer

integer

null

null

descriptionstring | null

Responses

200

Coupon updated

idstringrequired

updatedbooleanrequired

400

Nothing to update

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin or branch manager

detailstringrequired

404

Coupon not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

couponIdpath*The coupon id.

Bodyapplication/json

is_activebooleanvalid_untilstringmax_usesstringdescriptionstring

Request

curl -X PUT 'http://localhost:8000/api/v1/coupons/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "is_active": true,
  "valid_until": "string",
  "max_uses": -9007199254740991,
  "description": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/coupons/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"is_active\": true,\n  \"valid_until\": \"string\",\n  \"max_uses\": -9007199254740991,\n  \"description\": \"string\"\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/coupons/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"is_active\": true,\n  \"valid_until\": \"string\",\n  \"max_uses\": -9007199254740991,\n  \"description\": \"string\"\n}",
)

Response

{
  "id": "string",
  "updated": true
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}