Resubscribe Email API

What is resubscribe API?

When you send promotional emails, users might unsubscribe from your mailing lists. When a user unsubscribes from your mailing list, MoEngage makes sure that this user won't receive any more emails in future. If the user changes his decision later, you can use this API to resubscribe this user to your mailing lists. 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. Please contact MoEngage support to enable this service.

Usage

Request details

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

Request body

/*
  All fields are mandatory
*/
{
  "recipients": ["[email protected]","[email protected]"]
}

Headers

Header Field	Description	Mandatory	Example
Content-Type	Type of content	Yes	application/json
MOE-REQUEST-ID	Header containing unique request ID (UUID).	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

MOE-REQUEST-ID - Generate a UUID for each request you send. This will be used for debugging purposes if you face any issue with email delivery.

Response

/*
  Response code: 200
*/
{
    "status": "success",
    "message": "Resubscribe request is processed",
    "req_id": "c1912fbc-89fc-11e8-9a94-a6cf71072f73"
}