Coupon Codes
Generate coupon codes
Enables you to generate coupon codes based on given parameters
POST
/
api-offers
/
coupon
/
generate-codes
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-site-context
string
requiredThe x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
Body
application/json
prefix
string
requiredPrefix string to generate the coupon
Required string length:
2 - 12
start
number
requiredInitial number to begin generating the coupon codes
Required range:
x > 1
count
number
requiredNumber of coupon codes to be generated
Required range:
x > 1
Response
200 - application/json
codes
string[]
List of generated coupon codes
Was this page helpful?