Introduction to Customers

Use Customers endpoints to sync store customers to Yotpo. You can sync information such as contact details, order history, and whether the customer agreed to receive marketing messaging.

Good to know

  • While you can create customers explicitly using the below endpoints, in certain scenarios customer records can also be enriched implicitly by Yotpo after interacting with a customer. For example, Yotpo will automatically enrich customer records for shoppers who reviewed a product or engaged with Loyalty features.
  • To manage subscriptions for various types of messaging, for example, SMS messaging, review requests, etc., dedicated endpoints should be used.

Customer endpoints

Customer properties

Please note that support for given operators and fields is highly specific to each endpoint. Not all properties are relevant for every endpoint, and some field names may differ slightly across endpoints.

FieldTypeDescription
external_idstringThe identifier of the customer in the shop.
email / customer_emailstringThe email address of the customer.
phone_numberstringThe phone number of the customer in E.164 format.

This number will be used for SMS messaging.
first_namestringThe first name of the customer.
last_namestringThe last name of the customer.
genderstringValid values:
- F (Female)
- M (Male)
- Other
account_created_atdatetimeThe date the account was originally created in the store. Must be in ISO 8601 format.
account_statusstringThe status of the store account.
Valid values:
- enabled
- disabled
- invited
- declined
default_languagestringThe default language of the customer's account in ISO 639-1 format.
default_currencystringThe default currency for this customer. Must be valid ISO code of 3 characters. See currency codes
tagsstringComma-separated string of tags. The merchant can later segment customers by tags.
addressobjectThe default address for this customer. See address object description
accepts_sms_marketingbooleanA flag indicating whether the customer chose to accept SMS marketing messages.

Please note that whether or not the customer is ultimately subscribed to messaging may be determined by additional factors.
accepts_email_marketingbooleanA flag indicating whether the customer chose to accept email marketing messages.

Please note that whether or not the customer is ultimately subscribed to messaging may be determined by additional factors.