Fetch Coupon List Details

This API retrieves the specifications of a particular coupon list. It includes information such as configurations, statuses, expiry dates, and alert conditions with real-time counts of added and currently available coupons. Using this API, you can easily access and manage critical data about individual coupon lists.

GET /coupon-list/{coupon_list_id}

Fetch Coupon List Details

cURL

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

200

{
  "name": "signup coupons",
  "label": "signup_coupons",
  "expires_at": "2024-10-26T18:29:00.000Z",
  "status": "ACTIVE",
  "total_coupons": 0,
  "created_at": "2024-10-01T11:29:00.000Z",
  "updated_at": "2024-10-01T11:39:00.000Z",
  "email_alert_subscribers": [
    "[e-mail]"
  ],
  "alert_conditions": {
    "success_alert": true,
    "failure_alert": true,
    "expiry_alert": {
      "alert": true,
      "days_before": 100
    },
    "coupon_shortage_alert": {
      "alert": true,
      "threshold_count": 100
    }
  },
  "available_coupons": 0,
  "personalization_snippet": "{{Coupons.CouponListName[signup_coupons]}}",
  "created_by": "test_user",
  "_id": "{{coupon_list_id}}"
}

Information

There is no request body or content to send for this request except for headers and parameters.

Rate Limit

You can fetch 10000 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

200

application/json

Success Indicates that the request is successful and the coupon list is fetched.

name · string

This field consists of the unique name of the coupon list.

label · string

This field consists of the label name for the fetched coupon list.

expires_at · string

This field consists of the expiry date of the coupon list in yyyy-mm-dd format.

status · string

This field shows one of the following statuses of the fetched coupon list:

• ACTIVE
• EXPIRED
• ARCHIVED

total_coupons · integer

This field consists of the total number of coupons in the coupon list.

created_at · string

This field consists of the date and time the coupon list was created.

updated_at · string

This field consists of the date and time of the most recent update to the coupon list.

email_alert_subscribers · string[]

This field consists of the email address of the coupon list subscriber.

alert_conditions · object

This field consists of the alert conditions and their statuses specified while creating the coupon list.

available_coupons · integer

This field consists of the available number of coupons in coupon list.

personalization_snippet · string

This field consists of the personalization snippet of the coupon list.

created_by · string

This field consists of the user name who created the fetched coupon list.

_id · string

This field contains the unique ID corresponding to a successful coupon list fetch request. This ID is also used to update and archive coupon lists.