About customers

Sync your store customers to Yotpo, to be used as contacts for messaging. This includes information about your shop's customers such as their contact details, their order history, and whether they've agreed to receive marketing messaging.

📘

Customers endpoints are available for SMS Marketing.

Good to know

  • While you can create your 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

Listed below are all of the available properties for customers. To see which properties are required per endpoint, refer to the endpoint pages below.

Field

Type

Description

external_id

string

The identifier of the customer in the shop.

email

string

The email address of the customer.

phone_number

string

The phone number of the customer in E.164 format.

This number will be used for SMS messaging.

first_name

string

The first name of the customer.

last_name

string

The last name of the customer.

gender

string

Valid values:

  • F (Female)
  • M (Male)
  • Other

account_created_at

datetime

The date the account was originally created in the store. Must be in ISO 8601 format.

account_status

string

The status of the store account.
Valid values:

  • enabled
  • disabled
  • invited
  • declined

default_language

string

The default language of the customer's account in ISO 639-1 format.

default_currency

string

The default currency for this customer. Must be valid ISO code of 3 characters. See currency codes

tags

string

Comma-separated string of tags. The merchant can later segment customers by tags.

address

object

The default address for this customer. See address object description

accepts_sms_marketing

boolean

A 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_marketing

boolean

A 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.