Resubscribe Email API

Resubscribe Email API enables you to add or remove users from mailing lists.

When a user unsubscribes from your mailing list, the API is used to ensure that the user does not receive any more emails in the future.
If the user changes the decision later, you can use this API to resubscribe this user to your mailing list.

A typical use case will be to show a 'Resubscribe' option on the landing page to which the user is redirected after unsubscribing.

 

Enable access to API

This service is not enabled by default. Contact support@moengage.com to use this service.

API Endpoint

URL
 

APP_ID

The APP_ID for your MoEngage account is available on the MoEngage Dashboard in Settings > App Settings > Account Settings > APP ID.

Request Headers

Header Field Description Mandatory Example
Content-Type Type of content Yes application/json
MOE-REQUEST-ID Header containing unique request ID (UUID).
Generate a UUID for each request you send. This will be used for debugging purposes if you face any issue with email delivery.
Yes c1912fbc-89fc-11e8-9a94-a6cf71072f73
MOE-APPKEY App key of the user. Can be found in dashboard Yes MAZWXU1IMIKR5H67C4W9KBHD
MOE-APPSECRET Secret key to access the API. This will be shared with you when the service is enabled. This will be shown in the dashboard soon. Yes KUZCXU1IMIK7JH65TKT8L6UHD

Examples

Request Details

Request Details
HTTP request type: DELETE
URL: https://emails.moengage.com/api/v1/resubscribe
Request timeout: 4sec

Request Body

Request Body
/*
  All fields are mandatory
*/
{
  "recipients": ["user_one@mail.com","user_two@mail.com"]
}

Response

Response
/*
  Response code: 200
*/
{
    "status": "success",
    "message": "Resubscribe request is processed",
    "req_id": "c1912fbc-89fc-11e8-9a94-a6cf71072f73"
}
Was this article helpful?
0 out of 0 found this helpful