Create or update customer

patch

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

Creates a customer in your Yotpo store.

Path Params

store_id

string

required

The store ID (app_key).

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.

string

Email of the customer associated with the action.

custom_properties

json

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

Language

Credentials

Header

Response

Choose an example:

application/json

200200

400400