<- Customers API

Customers API

All versions ->

Create customer

POST

 /v2/customers

Creates a new customer for a business.

You must provide at least one of the following values in your request to this endpoint:

  • given_name
  • family_name
  • company_name
  • email_address
  • phone_number
Permissions:CUSTOMERS_WRITE

Guide

Create a customer profile

Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

The idempotency key for the request. For more information, see Idempotency.

Link to section

given_name

string

The given name (that is, the first name) associated with the customer profile.

Link to section

family_name

string

The family name (that is, the last name) associated with the customer profile.

Link to section

company_name

string

A business name associated with the customer profile.

Link to section

nickname

string

A nickname for the customer profile.

Link to section

email_address

string

The email address associated with the customer profile.

Link to section

address

The physical address associated with the customer profile.

Link to section

phone_number

string

The 11-digit phone number associated with the customer profile.

Link to section

reference_id

string

An optional second ID used to associate the customer profile with an entity in another system.

Link to section

note

string

A custom note associated with the customer profile.

Link to section

birthday

string

The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed. For example, 0000-09-21T00:00:00-00:00 represents a birthday on September 21 and 1998-09-21T00:00:00-00:00 represents a birthday on September 21, 1998. You can also specify this value in YYYY-MM-DD format.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

customer

The created customer.