Skip to main content
POST
Bulk create customers

Authorizations

Authorization
string
header
required

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

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string<uuid>
required

The UUID of the business to create customers for.

Body

application/json
external_id
string | null

External ID for the customer.

individual_name
string | null

Name of individual customer or contact.

company_name
string | null

Name of company customer.

email
string | null

Email address.

mobile_phone
string | null

Mobile phone number.

office_phone
string | null

Office phone number.

address_string
string | null

Physical address.

memo
string | null

Memo for any text you would like to associate with the customer (for example, to display to end users).

tags
object[]

Response

Customers created successfully.

data
object[]
required