Remove a set of email addresses from email distribution lists

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
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