Remove contacts from List

Remove specific contacts from an existing List.

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

Request statuses

Each customer entry can have a different status when sent to Yotpo. The statuses are:

ResponseDescription
removal_request_receivedThe removal request was successfully received and is pending processing
not_in_listThe customer does not exist in this List
contact_not_foundThe customers could not be found and removed from the List using the given identifier (email or phone)
errorError in handling the specific profile
📘

Please note:

This endpoint operates asynchronously - due to fluctuating system workloads, the processing of the received data can vary.

To check the status of your data processing, you can query the Retrieve Customers endpoint and check the customers’ lists.

Path Params
string
required

The store ID (app_key)

string
required

The ID of the List from which the customer will be removed

Body Params
string

The email of the contact you want to remove from the list

string

The phone number of the contact you want to remove from the list

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json