Skip to main content
GET
/
category-subscription
/
user-preferences
Get Subscription Preferences
curl --request GET \
  --url https://api-{dc}.moengage.com/v1/category-subscription/user-preferences \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'MOE-APPKEY: <moe-appkey>'
{
  "categories": {
    "Promotional": true,
    "Product Update": true,
    "Newsletter": true,
    "Conferences and Events": true,
    "Special Offers": true,
    "Recommended Music": true,
    "New Music": true,
    "Playlist Updates": false,
    "Concert Notifications": true,
    "Artist Updates": true,
    "test": true
  }
}

​
Rate Limit

The rate limit is 100 RPM and 360k 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 Data 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).

Query Parameters

​
user_id
string
required

This is the MoEngage ID that uniquely identifies the customer for whom the subscription preferences are being updated.

Note: MoEngage ID is encrypted using 16 bits DES and is encoded in the URL of the landing page. It must be sent as-is (encrypted).

​
cid
string
required

This is the campaign id of the email campaign. This field contains the information about the email campaign received by the customer.

Note: The campaign ID is encrypted using 16-bit DES and is encoded within the landing page URL. You must fetch the encrypted <campaign Id> from the URL and send it directly to MoEngage; it is not necessary to perform any decryption.

Response

Success. This response is returned when the request is processed successfully.

​
categories
object

A JSON Object that contains the subscription preferences of the customer. category_name is the unique category name in MoEngage.

Example:
{
  "Promotions": true,
  "Updates": false,
  "Recommendations": true,
  "Newsletter": false
}