Create or Update Customer

patch

https://developers.yotpo.com/core/v3/stores/{store_id}/customers

Create or update customer in the Yotpo platform

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
How to use this endpoint

Required parameters are listed below. For the full list of properties, see Introduction to Customers.

To see an example request, click Examples in the payload on the right.

To skip a parameter, enter "null" or exclude it from the payload.

🚧
Deprecated parameters
The following parameters are deprecated and will be removed in a future release. Please discontinue use and remove them from any existing integrations:

custom_properties — deprecated.

phone_number — deprecated. Phone number can no longer be set via this endpoint.

👍
Want to check if a customer was registered successfully with Yotpo?
Wait 60 seconds and then use the Retrieve customers endpoint.

Path Params

store_id

string

required

The store ID (app_key)

Query Params

access_token

string

required

Your Yotpo access token. Click here to learn how to generate one

Body Params

customer

json

required

Identifiers and properties of the customer associated with this action. You must identify the customer by only one of the following identifiers: phone_number or email. We cannot accept both identifiers in the payload

string

Email of the customer associated with the action.

phone_number

string

deprecated

Phone number of the customer associated with the action. E.164 format is required.

custom_properties

json

deprecated

Metadata associated with the customer is represented as a JSON object with < string key >:< primitive type value > pairs. Supported primitive types include string, boolean, int, long, double, and date (ISO). 'null' values are not supported. Property names must use underscores (_) instead of spaces. These properties can be used for segmentation or to personalize campaigns.

Responses

How to use this endpoint

Deprecated parameters

Want to check if a customer was registered successfully with Yotpo?

200200

400400