When set to true, only campaigns marked as 'active' will be returned

If defined, the response will only contain coupons in the specified folder

If defined, the response will only contain coupons containing that tag. Comma separated for each new tag

If defined, the response will only contain coupons of that category

Can be found in the list of all coupons

Defaults to false, will add the total number of custom validation codes and number of claimed custom codes

Can be found in the list of all coupons

Page ID. If there are 5000 or more records these will be split in multiple pages.

Start date of the sessions in UTC. Inclusive.

End date of the sessions in UTC. Inclusive.

Unique session code (example: ac6s7u3g8a25ja7x9qg87). Can be found in the URL, webhooks, statistics or through API call

Unique session code (example: ac6s7u3g8a25ja7x9qg87). Can be found in the URL, webhooks, statistics or through API call

void: sets coupon session to voided status
unvoid: unsets the voided status
lock: sets coupon session to locked status
unlock: unsets the locked status
claim: sets coupon session to claimed status.
validate: sets coupon session to validated status.
unvalidate: sets coupon session to unvalidated status.
activate: will unvoid and start the session, if the coupon has a flexible expiry date, the expiration time will be calculated.

Custom field 1 through 7. Max. 50 characters

Max. 50 characters (az-AZ-09)

Money spent. (Format: 0.000) Do not use special characters

Can be found in the list of all coupons

Returned in multiplesingleuse/create. Only 1 of "startsequence" or "endsequence" is required

Returned in multiplesingleuse/create.  Only 1 of "startsequence" or "endsequence" is required

void: sets coupon session to voided status
unvoid: unsets the voided status
lock: sets coupon session to locked status
unlock: unsets the locked status
claim: sets coupon session to claimed status.
activate: will unvoid and start the session, if the coupon has a flexible expiry date, the expiration time will be calculated.

Max. 50 characters

Only required when searching in specific coupon. Can be found in the list of all coupons.

Custom validation code. Minimum 5 characters

Minimum 5 characters

Minimum 5 characters

Can be found in the list of all coupons

Unique session code (example: ac6s7u3g8a25ja7x9qg87). Can be found in the URL, webhooks, statistics or through API call

Unique session code (example: ac6s7u3g8a25ja7x9qg87). Can be found in the URL, webhooks, statistics or through API calls

Type of the barcode.

Can be found in the list of all coupons

Custom ID. Max. 50 characters (az-AZ-09)

Custom field 1 through 7 Max. 50 characters

Custom validation code Max. 100 characters (az-AZ-09). Cannot be combined with 'autovalcode'

Automatically generates unique validation code. Cannot be combined with 'customvalcode'

Defaults to false. If enabled, we will verify if the same user input already received a single-use url for that coupon based on the selected field (email, phone or customid), and return the duplicated session instead of creating a new session

Google Analytics tags. Will appear in exported statistics

This expiration date is for this single use session and will override the campaign expiration date. The existing timezone from the campaign is used.

Can be found in the list of all coupons

Amount of single-use URLs to generate. Defaults to 10

Defaults to normal

If true, requires the parameters below. Defaults to false

Prefix of custom validation code

Number between 10 and 25 inclusive

The type of the custom validation code

Can be found in the list of all coupons

Email address receiving coupon

Unique session code (example: ac6s7u3g8a25ja7x9qg87). If not defined, we'll generate a new coupon session

Subject of email

Personalize email with a first name. The email body must contain [FIRSTNAME]

Personalize email with a last name. The email body must contain [LASTNAME]

Check if email address already received coupon. When not unique, email is not send

Can be found in the list of all coupons

Phone number receiving coupon. International E.164 notation

Unique session code (example: ac6s7u3g8a25ja7x9qg87). If not defined, we'll generate a new coupon session

SMS body text. The unique coupon URL will be added to each message

Can be found in the list of all coupons

Push notification message