curl -X POST "https://dash.lockii.app/api/v1/coupon/{id}" \ -H "x-api-key: $LOCKII_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "uses": -9007199254740991, "used": 0, "staticDiscount": 0, "percentageDiscount": 0, "companyID": "string", "archived": true }'

API referenceCoupon

Update Coupon

Update a coupon by ID. Include only fields you want to change; omit the rest. Empty strings, null, and 0 are ignored so they cannot wipe existing values. App connections need the booking:write or inventory:write scope.

POST

/api/v1/coupon/{id}

POST

/coupon/{id}

curl -X POST "https://dash.lockii.app/api/v1/coupon/{id}" \
  -H "x-api-key: $LOCKII_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "uses": -9007199254740991,
  "used": 0,
  "staticDiscount": 0,
  "percentageDiscount": 0,
  "companyID": "string",
  "archived": true
}'

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Parameters

id
string
path
required
Coupon ID

Body

application/json

name
string
Coupon name/code Omit to leave unchanged.
uses
integer
Maximum uses, or -1 for unlimited uses Omit to leave unchanged.
used
integer
Times used Omit to leave unchanged.
staticDiscount
number
Fixed discount in cents Omit to leave unchanged.
percentageDiscount
number
Percentage discount points Omit to leave unchanged.
companyID
string
Company ID. Defaults to the authenticated user's company. Omit to leave unchanged.
archived
boolean
Omit to leave unchanged.

Response

application/json

JSON result for this operation.

object

{}