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.

👍
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 an external_id. If there isn’t an external_id that can be used - you must identify the customer by only one of the following identifiers: phone_number or email. If an external_id is not specified, we cannot accept both email and phone_number in the payload.

external_id

string

A unique customer identifier. This ID will be used to identify the customer in our database, it is used for creating profiles, attributing events to profiles, and merging profiles. If you don’t have a unique identifier for the customer, avoid using this property. If you’re using Shopify as your eCommerce platform, please use the Shopify customer ID.

phone_number

string

Phone number of the customer associated with the action. E.164 format is required. Phone number is no longer a unique identifier - multiple customers may share a phone number.

string

Email of the customer associated with the action.

Responses

How to use this endpoint

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

200200

400400