Issue a unique code

Issue a unique coupon code to a customer from a specific promotion.

Additional parameters can be passed to link the unique code to a customer using a unique identifier or to specify when the code should expire.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body

string

A two-letter ISO 639-1 language code. This is required for error message translations. See https://iso639-3.sil.org/code_tables/639/data?title=&field_iso639_cd_st_mmbrshp_639_1_tid=255291.

string
required

The ID of the Promotion. This can be found as the Long ID on the promotion details page

string | null

A unique reference for linking a unique coupon code to a customer. This can be any attribute as long as it's unique to the customer e.g. an email address.

customer
object
date-time

Indicates when this code should expire. Only applies to promotions using the dynamic expiry setting.

Format according to RFC3339 Section 5.6. (Y-m-d\\TH:i:s.vP or without the optional time-secfrac part Y-m-d\\TH:i:sP).

date-time

Indicates when this code should start the count down to expiry as configured for the promotion.

Format according to RFC3339 Section 5.6. (Y-m-d\\TH:i:s.vP or without the optional time-secfrac part Y-m-d\\TH:i:sP).

metadata
object

This field allows storing any related metadata. The keys of the object can be strings and the values can be any type.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json