Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json

Request payload

first_name

First name of customer

last_name

Last name of customer

email

Email of customer

phone

Phone number of customer

dob
string<date> | null

Date of birth (YYYY-MM-DD). The date belongs to the user account, which is shared across companies, so it is saved only when this request creates the account; an existing account's date of birth is not changed.

account_id

A unique Account Id for customer. If empty, one is generated by the system

external_id

A unique External Id for customer that is used to identify them in external systems

notes

Note for customer

metadata
object | null

Can hold JSON object of arbitrary structure

default_address_attributes
object | null
customer_notes_attributes
(object | null)[] | null
metafields_attributes
(object | null)[] | null

Metafields for custom data storage

Response

Created

A single customer.

customer
object

A customer of the company. Every customer response carries the base fields. Some fields appear only on particular endpoints: active_subscriptions_count, inactive_subscriptions_count, metafields, member_id and jwt are added for company admins; points and attributable_rep are added by the detail, update and attributable-rep endpoints; the sponsor, rank, identity and agreement fields are added by the detail and update endpoints only.

meta
object | null