Skip to main content
POST
Create Promotion Code

Authorizations

X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

Headers

X-Timestamp
string
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Example:

"1783513683000"

Path Parameters

id
string
required

Unique identifier of the coupon

Body

application/json

Parameters required to create a promotion code

code
string

Customer-facing promotion code. If omitted, a code can be generated by the platform.

Pattern: ^[a-zA-Z0-9]{1,32}$
Example:

"SUMMER2026"

firstOrderOnly
boolean

Whether this promotion code is limited to first orders only

restrictedCustomerIds
string[]

Customer IDs allowed to redeem this promotion code. Empty means unrestricted.

minimumSpend
object

Minimum spend by currency. Key is an ISO currency code.

Example:
perCustomerRedemptionLimit
integer<int32>

Redemption limit per customer

maxRedemptionLimit
integer<int32>

Maximum total redemptions for this promotion code

validPeriodStart
integer<int64>

Promotion code validity start time as a 13-digit Unix timestamp in milliseconds

Example:

1780660800000

validPeriodEnd
integer<int64>

Promotion code validity end time as a 13-digit Unix timestamp in milliseconds

Example:

1780660800000

Response

Promotion code created successfully

Body of the response message

code
integer<int32>

Response status code, 200 when success

Example:

200

msg
string

Brief description of what happened, 'success' when happy case

Example:

"success"

data
object