Remove a set of email addresses from email distribution lists

Unsubscribes email addresses from one or more Yotpo email types. Each key of email_list is an email type number from the Email types table and each value is an array of addresses. With async and validate_data, invalid addresses are reported in response.errors and the rest are processed. Unknown type keys are ignored.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

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 types

NumberEmail Type
1Post-purchase automatic review request emails and other reminder emails.
Path Params
string
required

The store ID

Body Params
email_list
object
required

Hash of email addresses by email type. Use the Number from the Email types table on this page as each key (for example 1, 2, or 3).

boolean

Perform subscription changes asynchronously.

boolean

Validate the email_list. You can only use this parameter with async.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain