Skip to main content
PUT
/
coupon-list
/
{coupon_list_id}
/
activate
Activate Coupon List
curl --request PUT \
  --url https://api-{dc}.moengage.com/v1/coupon-list/{coupon_list_id}/activate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "expires_at": "2023-12-25"
}
'
{
  "error": {
    "code": "bad-request",
    "message": "Possible issues include duplicates, such as coupon list names, invalid data types, or missing mandatory attributes."
  }
}
Information
  • Only active coupon lists can be utilized in campaigns.
  • If you need to modify the expiry date and activate a coupon list, you must use the Update a Coupon List API.

​
Rate Limit

You can activate 100 coupon lists per day.

Authorizations

​
Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

Headers

​
MOE-APPKEY
string
required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Path Parameters

​
coupon_list_id
string
required

The unique identifier for the coupon list.

Body

application/json
​
expires_at
string<date>
required

Add a new expiry date for the coupon list in yyyy-mm-dd format.

Note: Your request could fail if the mandatory attributes are absent from your payload.

Response

Success (No content) Coupon list activation is successful.