👍

How to use this endpoint

• To see example requests, click Examples in the payload on the right.
• For example responses, click the relevant status code on the right.

📘

Note:

• Currently, the returned unsubscribers.id is not supported in the Yotpo API.
• For multiple requests, Yotpo recommends passing batches of 150 emails per request.
• If you use the async parameter, the response does not contain "unsubscribers".
• If you use the validate_data parameter, the response will contain errors if the requested parameters are not valid.

email_list request body

The email_list object is a hash of email addresses grouped by email type. Each key must be the Number from the Email types table below (for example 1, 2, or 3). The value for each key is an array of email addresses to re-add for that email type.

For example, to re-add addresses to email type 1 (Mails After Purchase and other reminder emails):

{
  "email_list": {
    "1": [
      "[email protected]"
    ]
  }
}

To target multiple email types in one request, add a separate key for each Number from the table:

{
  "email_list": {
    "1": [
      "[email protected]"
    ],
    "3": [
      "[email protected]"
    ]
  }
}

Email types

Use the Number column below as the key in your email_list request body.