TAtalon
Coupons

Create coupons for multiple recipients

Changed on

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Create coupons according to some pattern for up to 1000 recipients.

post/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

Query parameters

silentstring

Possible values: yes or no.

  • yes: Increases the performance of the API call by returning a 204 response.
  • no: Returns a 200 response that contains the updated customer profiles.

Request body

usageLimitinteger required

The number of times the coupon code can be redeemed. 0 means unlimited redemptions but any campaign usage limits will still apply.

discountLimitnumber

The total discount value that the code can give. Typically used to represent a gift card value.

reservationLimitinteger

The number of reservations that can be made with this coupon code.

startDatestring date-time

Timestamp at which point the coupon becomes valid.

expiryDatestring date-time

Expiration date of the coupon. Coupon never expires if this is omitted.

batchIdstring

The batch ID that all coupons created by the request will bear. If omitted, a batch ID is generated automatically.

attributesobject

Arbitrary properties associated with this item.

recipientsIntegrationIdsstring[] required

The integration IDs for recipients.

validCharactersstring[]

List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the [A-Z, 0-9] regular expression.

couponPatternstring

The pattern used to generate coupon codes. The character # is a placeholder and is replaced by a random character from the validCharacters set.

Example request

{
  "usageLimit": 100,
  "discountLimit": 30,
  "reservationLimit": 45,
  "startDate": "2020-01-24T14:15:22Z",
  "expiryDate": "2023-08-24T14:15:22Z",
  "batchId": "3rdparty_fjsieoaa",
  "attributes": {
    "venueId": 12
  },
  "recipientsIntegrationIds": [
    "URNGV8294NV",
    "BZGGC2454PA"
  ],
  "validCharacters": [
    "A",
    "B",
    "C",
    "D",
    "E",
    "F",
    "G",
    "H",
    "I",
    "J",
    "K",
    "L",
    "M",
    "N",
    "O",
    "P",
    "Q",
    "R",
    "S",
    "T",
    "U",
    "V",
    "W",
    "X",
    "Y",
    "Z"
  ],
  "couponPattern": "SUMMER-#####"
}

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "campaignId": 211,
      "value": "XMAS-20-2021",
      "usageLimit": 100,
      "discountLimit": 30,
      "reservationLimit": 45,
      "startDate": "2020-01-24T14:15:22Z",
      "expiryDate": "2023-08-24T14:15:22Z",
      "limits": [
        {
          "action": "createCoupon",
          "limit": 1000,
          "period": "yearly",
          "entities": [
            "Coupon"
          ]
        }
      ],
      "usageCounter": 10,
      "discountCounter": 10,
      "discountRemainder": 5,
      "reservationCounter": 1,
      "referralId": 326632952,
      "recipientIntegrationId": "URNGV8294NV",
      "importId": 4,
      "batchId": "32535-43255"
    }
  ]
}

Changes