Update Subscription Preferences API
 

Beta

Subscription Categories is a Beta Feature. To enable the feature, please reach out to your CSM or mail us at support@moenage.com.

Update Preferences API helps update the subscription preferences for custom landing pages.

API Endpoint


PUT https://api-0X.moengage.com/v1/category-subscription/user-preferences

Each customer is hosted on a different data center; you can find your data center number (value of X) by checking the data center and API endpoint mapping page.

Authentication

All Subscription Categories API requests will be authenticated through Basic Authentication.

To generate the Basic Authentication header:

      1. Navigate to Settings > APIs > DATA API Settings
      2. Copy the DATA API ID and DATA API KEY
      3. Generate the Authentication Header String

        Basic Authentication encodes a 'username:password' using base64 and prepends it with the string 'Basic '. To generate the Auth header:

            • Add a colon after the user name (DATA API ID) and concatenate it with the password (DATA API KEY).
            • Encode the concatenated string using base64 encoding.
            • Pass the encoded string in the HTTP authorization header as follows: {"Authorization":" Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U=="}

Request Parameters

Key Type Value Description

user_id

Mandatory

String

This is the MoEngage ID that uniquely identifies the customer for whom the subscription preferences are being updated. This is encrypted using 16 bits DES and is encoded in the URL of the landing page. The same can be fetched from the URL of the landing page.

cid

Mandatory

String

This is the campaign id of the email campaign. This field contains the information about the email campaign received by the customer from where they have navigated to the subscription preferences page to update their preferences. The campaign ID is encrypted using 16 bits DES and is encoded in the URL of the landing page. The same can be fetched from the URL of the landing page. 

moe_event_id

Optional

String

This is used to update the unsubscribe event when the user chooses the unsubscribe all option.   

Request Headers

Key Sample Values Description

Content-Type

application/json 

Set the Content-Type header to application/json for using the Bulk Update Preferences API.

MOE-APPKEY

{"MOE-APPKEY": "APP ID"}

This is your MoEngage account's APP ID that has to be passed along with the request. You can find your MoEngage APP ID in the MoEngage Dashboard API Settings. Navigation: Settings -> API -> General Settings -> DATA API section. For more information, refer to Authentication.

Note: You can also fetch the APP ID from the following navigation: Settings -> App -> General Settings.

Authorization

{"Authorization": "Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U=="}

This is the authentication parameter for access control and needs to be passed along with the request. The APPKEY and API SECRET need to be picked up from the Inform API Settings in MoEngage Dashboard, and a Basic Authorization header needs to be created and set in the header. For more information, refer to Authentication.

Request Body

Key Type Value Description

categories

Mandatory

JSON Object

This field contains the details about the updated subscription preferences of the user.

“categories”:{

<catergory_name>:<true/false>,

<catergory_name>:<true/false>,

<catergory_name>:<true/false>

}

The categories object contains the subscription preferences of the customer for all the categories.

unsubscribe_all

Mandatory

Boolean 

This field contains information about whether the customer has unsubscribed from all the categories.

Response Parameters

Key Description

message

This field contains a brief description of the request status in the case of success.

title

This field is present in the response body only when the request was unsuccessful and contains the error type.

description

This field is present in the response body only when the request was unsuccessful and contains the error description.

Response Codes

Status Code Request State Description

200

Success

This response is returned when the request is processed successfully. 

400

Bad Request

This response is returned when the required parameters APP KEY, user_id, cid, moe_event_id, and categories are missing from the request or when the provided params are invalid.

401

Authorization Failure

This response is returned when the authorization fails due to incorrect values for the APP KEY/ HTTP Auth Header.

409

API SECRET not configured

This response is returned when the authorization fails due to the APP SECRET key not being set on the Dashboard.

429

Rate Limit Breach

This response is returned when the number of requests per minute has exceeded the rate limit.

5xx

Internal Server Error

This response is returned when the system runs into an unexpected error.

Rate Limit

The rate limit is 100 RPM and 360k per day.

Sample cURL Request


curl --location -g --request PUT 'https://api-{{0X}}.moengage.com/v1/category-subscription/user-preferences?user_id={{user_id}}&cid={{cid}}&moe_event_id={{moe_event_id}}' \
--header 'Content-Type: application/json' \
--header 'MOE-APPKEY: {{DATA API ID}}' \
--header 'Authorization: Basic e3tEQVRBIEFQSSBJRH19Ont7REFUQSBBUEkgS0VZfX0=' \
--data-raw '{
    "unsubscribe_all": true,
    "categories": {
    	"Promotional": true,
        "Transactional": false,
        "Special Offers": true,
        "Product Updates": true,
        "New arrivals": false,
        "Recommendations": true,
        "Newsletter": true
    }
}'

Sample Response

200400 401 409 429 500
Success Response
{
    "message": "Success"
}    

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.

FAQs

  1. How do we fetch the parameters to be passed in the request?

    The user_id (MoEngage ID) and the cid (Campaign ID) fields should be fetched from the landing page URL.

Was this article helpful?
0 out of 0 found this helpful