Customers

Create

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
firstNamestringRequired
Customer first name.
lastNamestringRequired
Customer last name.
emailstringRequired

Contact email. Not an identity key — two customers may share an email.

phonestringRequired

Phone number in any parseable format; stored canonicalized to E.164. This is THE customer identity within your company — creating with an already-registered phone returns 409.

externalIdstringOptional

Your own identifier for this customer (CRM id, member number, …). Unique within your company; a conflicting value returns 409.

birthdaystringOptional

Birthday as an ISO date (YYYY-MM-DD).

genderenumOptional
Customer gender.
addressstringOptional

Postal address, free-form.

Response