post
https://{host}/v2/coupon/issue
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This API allows you to issue a series of coupons to a customer, enabling them to redeem the coupons.
Example request
curl --location 'https://eu.api.capillarytech.com/v2/coupon/issue' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Z2VvcmdlLmRvY2RlbW86NjVhMDgzYjk1MWY5MGY1NTY5NDk1YmNkNzUxYmJiY2U=' \
--header 'Cookie: _cfuvid=iUU642id2lwK4uBGHYKi7aKv0EaF6GgKEIXn1f._QJI-1768893329218-0.0.1.1-604800000' \
--data '{
"seriesId": 868760,
"customer": {
"id": "",
"mobile": "1234512345",
"externalId": "",
"email": ""
}
}'Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
Resource information
| URI | /v2/coupon/issue |
| HTTP method | POST |
| Pagination | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/v2/coupon/issue
Body parameter
| Field | Type | Required | Description |
|---|---|---|---|
| seriesId | Integer | Yes | Specifies the valid coupon series ID linked with the create coupon series. |
| customer | Object | Yes | Defines the object containing customer details. |
| ..id | Integer | Optional | Indicates the unique identifier for the customer. |
| ..mobile | String | Optional | Specifies the mobile number of the customer. |
| ..externalId | String | Optional | Indicates an external identifier for the customer. |
| String | Optional | Specifies the email address of the customer. |
NoteAny one among the customer identifiers is mandatory.
Example response
{
"code": "5875447216353555",
"seriesId": 868760,
"description": "Gold star coupons",
"discountCode": "gold1234",
"validTill": "2026-06-11T00:00:00Z",
"discountType": "ABS",
"discountValue": 1000,
"discountUpto": 0,
"discountOn": "BILL",
"detailedInfo": "Gold star coupons",
"customer": {
"id": 566881933,
"profiles": [
{
"firstName": "Dead",
"lastName": "fool",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "mobile",
"value": "1234512345"
},
{
"type": "email",
"value": "[email protected]"
},
{
"type": "externalId",
"value": "12341234"
}
],
"commChannels": [],
"userId": 566881933,
"accountId": "",
"autoUpdateTime": "2025-10-09T06:45:52Z",
"identifiersAll": [
{
"type": "mobile",
"value": "1234512345"
},
{
"type": "email",
"value": "[email protected]"
},
{
"type": "externalId",
"value": "12341234"
}
]
}
]
},
"redemptionCount": 0,
"id": 0,
"validTillDateTime": "2026-06-11T23:59:59Z",
"warnings": []
}Response parameter
| Parameter | Data Type | Description |
|---|---|---|
| code | String | The unique coupon code generated. This code is used for redeeming the coupon. |
| seriesId | Integer | The unique identifier for the coupon series. |
| description | String | Description of the coupon. |
| discountCode | String | This code is defined during the creation of the coupon series and is used as a POS identifier on member care. This will be used by the cashier at the Point of sale machine. |
| validTill | String | Expiry date and time of the coupon in ISO 8601 format, returned in the server time zone. EU server example 2026-06-11T00:00:00Z → 11 June 2026, 00:00:00 (UTC) India server example 2026-06-11T05:30:00+05:30 → 11 June 2026, 05:30:00 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| validTillDateTime | string | Specifies the exact expiry date and time of a coupon in ISO 8601 format, returned in the server time zone. EU server example 2026-06-11T23:59:59Z → 11 June 2026, 23:59:59 (UTC) India server example 2026-06-12T05:29:59+05:30 → 12 June 2026, 05:29:59 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| discountType | String | Specifies the type of discount provided by the coupon. This is created during the creation of coupon series. |
| discountValue | Integer | The value of the discount. This is created during the creation of coupon series. |
| discountUpto | Integer | The maximum value up to which the discount can be applied. This is created during the creation of coupon series. |
| discountOn | String | The aspect on which the discount is applied. This is created during the creation of coupon series. |
| detailedInfo | String | Additional information about the coupon. This is created during the creation of coupon series. |
| customer | Object | Object containing customer details. |
| customer.id | Integer | The unique identifier of the customer. |
| customer.profiles | Object | Object containing profile details of the customer |
| customer.profiles.firstName | String | The first name of the customer. |
| customer.profiles.lastName | String | The last name of the customer. |
| customer.profiles.fields | Object | Additional fields related to the profile. |
| customer.profiles.allFields | Object | All fields related to the profile. |
| customer.profiles.identifiers | Object | Object containing the details of customer identifiers. |
| customer.profiles.identifiers.type | String | Type of identifier. Supported values: mobile, externalId. |
| customer.profiles.identifiers.value | String | Value of the identifier. |
| customer.profiles.commChannels | Objet | Object containing the details of the mode of communication with the customer. |
| customer.profiles.userId | Integer | The unique identifier of the customer. |
| customer.profiles.accountId | String | Account ID associated with the customer. |
| customer.profiles.autoUpdateTime | String | The date and time when the customer profile was last automatically updated, in ISO 8601 format, returned in the server time zone. EU server example 2025-10-09T06:45:52Z → 09 October 2025, 06:45:52 (UTC) India server example 2025-10-09T12:15:52+05:30 → 09 October 2025, 12:15:52 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request. |
| customer.profiles.identifiersAll | Object | The object containing identifier objects of the profile. |
| customer.profiles.identifiersAll.type | String | Type of identifier. Supported values: mobile, externalId. |
| customer.profiles.identifiersAll.value | String | Value of the identifier. |
| redemptionCount | Integer | Number of times the coupon has been redeemed. |
| id | Integer | ID generated for the issued coupon. |
| warnings | Array of Strings | The array of warning messages related to the coupon. |
{
"code": "ICJE1X12P6",
"seriesId": 544770,
"description": "Festival coupon",
"discountCode": "erg123",
"validTill": "2026-05-09T00:00:00Z",
"discountType": "ABS",
"discountValue": 500.0,
"discountUpto": 0.0,
"discountOn": "BILL",
"detailedInfo": "Evil coupon",
"customer": {
"id": 555567088,
"profiles": [
{
"firstName": "Tom",
"lastName": "Hills",
"fields": {},
"allFields": {},
"identifiers": [
{
"type": "mobile",
"value": "11223569865"
},
{
"type": "externalId",
"value": "000003873472"
}
],
"commChannels": [],
"userId": 555567088,
"accountId": "",
"autoUpdateTime": "2024-06-25T06:51:13Z",
"identifiersAll": [
{
"type": "mobile",
"value": "11223569865"
},
{
"type": "externalId",
"value": "000003873472"
}
]
}
]
},
"redemptionCount": 0,
"id": 0,
"warnings": []
}