Create/Update Customer Records

post

https://loyalty.yotpo.com/api/v2/customers

This endpoint both creates and updates a customer’s record in the Yotpo system. Use this primarily to notify Yotpo when you add a customer manually in your admin, or a customer changes their email address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

The identifier used to uniquely identify the customer in your system. Required if implementing a generic e-commerce integration.

string

required

The customer's email address.

first_name

string

The customer's first name.

last_name

string

The customer's last name.

phone_number

string

The customer's phone number in E.164 format. e.g +14155552671

country_iso_code

string

Only use if unable to send phone_number in full E.164 format. If phone_number is passed in full E.164 format with country_iso_code, this string will be ignored. Example: "US", "GB", i.e.

has_account

boolean

Whether the customer has an account with the eCommerce platform.

platform_account_created_at

date

Date and time when the customer created an account with your store. The parameter can can be date only, or include the exact time as well.

opted_in

boolean

Whether the customer should be opted in to loyalty program. If null, will rely on the account settings of opt in.

pos_account_id

string

The Point of Sale unique account identifier. This parameter is used to integrate Yotpo with a Point of Sale interface and can be retrieved using the Fetch Customer Details endpoint.

201201

400400