Archive a Coupon List

This API transitions an active coupon list to an archived status. Upon archival, the coupon codes within the list are deleted. Consequently, any campaigns that were previously dependent on this list will no longer be able to utilize the dynamic coupon allocation.

PUT /coupon-list/{coupon_list_id}/archive

Archive a Coupon List

cURL

curl --request PUT \
  --url https://api-0{dc}.moengage.com/v1/coupon-list/{coupon_list_id}/archive \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'MOE-APPKEY: <moe-appkey>'

400

{
  "error": {
    "code": "bad-request",
    "message": "Possible issues include duplicates, such as coupon list names, invalid data types, or missing mandatory attributes."
  }
}

Information

Verify the usage of a given coupon list in active or planned campaigns before archiving it.

Rate Limit

You can archive 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.

Response

204

Success (No content) The request is successful, and the coupon list is archived.