Skip to navigation
API ReferenceCustomers

Create a customer

View as Markdown
Create a customer.

Authentication

x-api-keystring

Account API key used to authenticate server-side requests. Use the credentials issued for the same environment as the API base URL.

Headers

Idempotency-KeystringOptional<=255 characters

Unique key used to safely retry the same state-changing request.

Request

This endpoint expects an object.
client_reference_idstringRequired<=64 characters
Your own stable identifier for this customer.
first_namestringOptional<=60 characters
last_namestringOptional<=60 characters
emailstringOptionalformat: "email"<=180 characters
phonestringOptional<=32 characters

Response

Customer created successfully.
messagestring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error