Add contacts to List

Add specific contacts to 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
addition_request_receivedThe addition request was successfully received and is pending processing
already_in_listThe customer already exists in this List
profile_not_existThe customers could not be found and added to 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 to which the customers will be added

Body Params
string

The email address of the contact you want to add to the list

string

The phone number of the contact you want to add to the list

Responses

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