Create or update customer
Create or update a customer profile. Uses the email address as the upsert key — if a customer with that email exists, their profile is updated; otherwise, a new customer is created.
Profile fields
firstNameandlastNameare set directly on the customer. A full display name is automatically generated from these fields.phoneNumbershould be in E.164 format (e.g.,+12345678900). If the number is new, it is added to the customer’s contact information.
Location
Providing location sets the customer’s current location. Only the fields
you include are updated.
Custom fields
Use customFields to store arbitrary key-value data on the customer (e.g.,
pricing_plan, subscription_source). Values can be strings, numbers, or
booleans. If a custom field doesn’t exist yet, it is created automatically.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Store ID
"64e5a8a1af49a89df37e4ee7"
Body
Request body for creating or updating a customer profile. The email address is used as the upsert key.
Customer email address. Used as the upsert key to find or create the customer.
Customer first name
Customer last name
Customer phone number in E.164 format (e.g., +12345678900). Appended to the existing phone list if not already present.
"+12345678900"
Customer location information.
Custom field values as key-value pairs. Keys are field names and values can be strings, numbers, or booleans. New fields are created automatically if they don't exist yet.
{
"subscription_source": "web",
"status": "Active",
"loyalty_points": 1250,
"vip_member": true
}