MOmoengage
Resubscribe

Bulk Resubscribe Users

This API resubscribes users who have previously unsubscribed on the MoEngage platform and an external email vendor platform simultaneously. This API resets the unsubscribe flag to “false” for users on MoEngage and makes a call to an External Service Provider (ESP) like SendGrid to remove the email addresses (associated with the unsubscribed users) from their suppression list.

post/emails/v1.0/bulk-resubscribe

Request

Headers

MOE-APPKEYstring 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).

MOE-PROJECT-CODEstring

This is the project ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > Portfolio > Project ID. Note: This parameter is mandatory for workspaces with the Portfolio feature enabled.

Request body

recipientsstring required

This field contains the email ids of the users who have resubscribed. Note: If an email address matches multiple profiles, all the profiles will be marked as resubscribed on the MoEngage dashboard (the unsubscribe flag will be set to false for the user).

customer_idstring

This field denotes the unique identifier used to identify a user in MoEngage. Note that devices can be created for existing users only.

espstring required

This field contains information about the Email Service Provider (esp) whose suppression list needs to be updated. For example, “esp”: “SENDGRID” would imply that the email address of the customers who have resubscribed to your brand need to be removed from SendGrid’s suppression list.

update_espboolean

This field’s default value is false when it is not sent in the request payload. MoEngage calls the ESP to remove the email addresses from their email suppression list when this field is true.

request_idstring required

This field contains the value of the identifier for the request.

Response

The request has been successfully submitted for asynchronous processing.

messagestring

This field contains a brief description of the request status.

response_idstring

This field contains the unique identifier for the response and is present in the response only when the request is successful.

Example response

{
  "message": "The request is submitted successfully.",
  "response_id": "SrTuWVlPsq"
}

Changes

No recorded changes to this operation across all 1 revision of this API.