Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Update coupon series

Lets you update existing coupon series details.

put/coupon/series/{id}

Path parameters

idinteger required

Unique ID of the coupon series to update.

Request body

storeIdsJsoninteger[]

Unique IDs of the stores where the series is applicable.

isDvsEnabledboolean

Whether DVS is enabled for the coupon series or not. Pass true for DVS coupons.

dvsExpiryDatestring date

Date and time of expiry of the DVS campaign associated with the coupon series in YYYY-MM-DDThh:mm:ssZ.

shortSMSTemplatestring

Short message to send to users. Pass voucher_code to insert coupon code in the message.

campaignIdinteger

Unique ID of the campaign associated with the series.

maxRedemptionsInSeriesPerUserinteger

Limit number of time same user can redeem the coupon

minDaysBetweenRedemptioninteger

Minimum number of days between any two redemption

Response

200

OR

Example response

{
  "id": 791560,
  "orgId": 100737,
  "description": "April 777",
  "discountCode": "XYZ12345",
  "validTillDate": "1970-01-01T00:00:00Z",
  "validDaysFromCreation": 30,
  "expiryStrategyValue": -1,
  "maxCreate": -1,
  "maxRedeem": -1,
  "anyUser": true,
  "createdBy": 75161973,
  "createdOn": "2025-06-12T12:34:49Z",
  "lastUsed": "2025-06-12T12:58:18Z",
  "seriesCode": "39262223334841478347",
  "smsTemplate": "Hi {{first_name}}",
  "info": "April 777",
  "mutualExclusiveSeriesIds": "[-1]",
  "storeIdsJson": "[-1]",
  "dvsExpiryDate": "2025-06-12T00:00:00Z",
  "shortSMSTemplate": "Hello {{cust_name}}, your voucher code is {{voucher_code}}",
  "maxVouchersPerUser": -1,
  "minDaysBetweenVouchers": -1,
  "maxReferralsPerReferee": -1,
  "discountValue": 500,
  "dvsItems": "items",
  "redemptionRange": "{\"dom\" : [-1], \"dow\": [-1], \"hours\": [-1]}",
  "minBillAmount": -1,
  "maxBillAmount": -1,
  "redeemAtStore": "[-1]",
  "campaignId": -1,
  "tag": "April 777",
  "maxRedemptionsInSeriesPerUser": -1,
  "minDaysBetweenRedemption": -1,
  "redemptionValidFrom": "2025-06-12T00:00:00Z",
  "sourceOrgId": -1,
  "redeemStoreType": "redeemable_stores",
  "termsAndConditions": "T&C",
  "ownedBy": "NONE",
  "ownerId": -1,
  "resendMessageEnabled": true,
  "redemptionPerCouponMaxLimit": -1,
  "seriesType": "UNDEFINED",
  "clientHandlingType": "DISC_CODE",
  "expiryStrategyType": "DAYS",
  "discountOn": "BILL",
  "discountType": "ABS"
}