v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Create or Update Customer

Create or update customer in the Yotpo platform

patch/core/v3/stores/{store_id}/customers

Path parameters

store_idstring required

The store ID (app_key)

Query parameters

access_tokenstring required

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

Request body

customerstring 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_idstring

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_numberstring

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.

emailstring

Email of the customer associated with the action.

Response

200

object required