Create coupon

GET {{integrationBaseUrl}}/customer_engagement/coupon?applicationId={{applicationId}}&campaignId={{campaignId}}&externalCampaignId=testCampaignId&startDate=2022-09-30T15:35:02Z&expiryDate=2022-10-30T15:35:02Z&discountLimit=155&recipientIntegrationId=URN-GV8294NV&usageLimit=1&.firstName=john&.country=DE&identifier=3495-4323

Create a coupon code in Talon.One. See the tutorial.

Request Params

KeyDatatypeRequiredDescription
applicationIdstring(Required) The ID of the Application in Talon.One.
campaignIdstring(Required) The ID of the campaign in Talon.One.
externalCampaignIdstring(Required) The ID of the campaign in the third-party platform.
startDatestringThe date when the code becomes usable.
expiryDatestringThe date when the code becomes unusable.
discountLimitnumberThe discount amount the coupon is worth. Can be blank if for example the coupon provides a 10% discount or something other than a set value of discounts.
recipientIntegrationIdstringThe integration ID of the only customer that can use the generated coupon code. Leave blank to allow any user to use the coupon.
usageLimitnumberThe number of times the coupon code can be redeemed. 0 means unlimited redemptions but any campaign usage limits will still apply. The default value is 1.
.firstNamestringOptional parameter to set the value of custom attributes. They are defined in the Campaign Manager,
see Managing attributes.

Prefix each attribute name with ..

Certain attributes can also be set to mandatory in your Application settings. If your Application uses mandatory attributes, you must use this parameter to set their value.

Full URI example: https://<url>?applicationId=5&.myAttribute1=1234&.myAttribute2=abc. | | .country | string | | Optional parameter to set the value of custom attributes. They are defined in the Campaign Manager, see Managing attributes.

Prefix each attribute name with ..

Certain attributes can also be set to mandatory in your Application settings. If your Application uses mandatory attributes, you must use this parameter to set their value.

Full URI example: https://<url>?applicationId=5&.myAttribute1=1234&.myAttribute2=abc. | | identifier | string | | Optional parameter to indicate the identifier of the request. Providing a new value creates a new coupon. Providing an existing value retrieves the existing coupon of that ID and does not create a new coupon. |

HEADERS

KeyDatatypeRequiredDescription
customer-engagement-platform-namestring(Required) The name of the third-party platform.
destination-hostnamestring(Required) The base URL of your Talon.One deployment.
X-DRY-RUNbooleanIndicates whether to persist the changes. Changes are ignored when X-DRY-RUN=true.
Acceptstring