Create or update customer

Creates a customer in your Yotpo store.

Recipes
🏪
Initial store sync
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

  • Required parameters are listed below. For the full list of properties, see About 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.

📘

Identifying the customer

Send external_id, email, or both. A customer sent with only phone_number is rejected with a 400 error. If a customer with the same identifier already exists, it's updated.

Path Params
string
required

The store ID (app_key).

Body Params
customer
object
required

Identifiers and properties of the customer. Send external_id or email (or both); a customer identified only by phone_number is rejected. If a customer with the same identifier exists, it's updated.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK. The response has no body.

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