Skip to main content

CreateCouponDto

stripstring<binary>required
barcodeFormatstringrequired

Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

namestringrequired
descriptionstringrequired
promoCodestring
valuestring
expirationDatestring<date-time>
isMultipleInstanceboolean
isWelcomeCouponboolean
statusstring

Possible values: [ACTIVE, INACTIVE, EXPIRED]

sourcestring

Possible values: [INTERNAL, EXTERNAL, CRM, ALL]

valueLabelstring

Possible values: [VALUE, AMOUNT, PRESTATION]

colors objectrequired
backgroundColorstringrequired
labelColorstringrequired
foregroundColorstringrequired
emailSubscriptionMessagestring
subscriptionMessagestring
security object
oneTimeToUseJwtLinkboolean
disableIOSPassSharingboolean
enableOneTimeUseboolean
disableMultipleHoldersboolean
enableSecurityAnimationboolean
enableRotatingBarcodeboolean
iosHeader object
labelEnumstringrequired

Possible values: [FULLNAME, CUSTOM_TEXT, INACTIVE]

valueEnumstringrequired

Possible values: [FULLNAME, CUSTOM_TEXT, INACTIVE]

customLabelstring
customValuestring
CreateCouponDto
{
"strip": "string",
"barcodeFormat": "AZTEC",
"name": "string",
"description": "string",
"promoCode": "string",
"value": "string",
"expirationDate": "2024-07-29T15:51:28.071Z",
"isMultipleInstance": true,
"isWelcomeCoupon": true,
"status": "ACTIVE",
"source": "INTERNAL",
"valueLabel": "VALUE",
"colors": {
"backgroundColor": "string",
"labelColor": "string",
"foregroundColor": "string"
},
"emailSubscriptionMessage": "string",
"subscriptionMessage": "string",
"security": {
"oneTimeToUseJwtLink": true,
"disableIOSPassSharing": true,
"enableOneTimeUse": true,
"disableMultipleHolders": true,
"enableSecurityAnimation": true,
"enableRotatingBarcode": true
},
"iosHeader": {
"labelEnum": "FULLNAME",
"valueEnum": "FULLNAME",
"customLabel": "string",
"customValue": "string"
}
}

API news, once a month

New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

Report a technical problem

An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

For a fast answer, include:

  • The method and endpoint (e.g. POST /clients)
  • The error code returned (errorCode) and the body sent
  • The date and time of the call
  • The identifiers involved (customer, template, pass)

Never include an API token or a password.

AI assistant

Beta

Loading…

AI-generated answers (Claude): double-check important details.

Sign in to use the assistant