Skip to main content
Create customer

Authorizations

X-API-Key
string
header
required

Body

application/json
first_name
string
required
Required string length: 1 - 100
last_name
string
required
Required string length: 1 - 100
email
string<email>
required
Required string length: 1 - 254
custom_fields
object[]
required
billing_email

An optional email address to CC on invoices and receipts.

phone
string
default:""
Maximum string length: 50
company_name
string
default:""
Maximum string length: 255
bigcommerce_customer_group_id
integer
bigcommerce_tax_exempt_category
string
default:""
Maximum string length: 255
send_account_creation_email
boolean
default:false
write-only

Send a welcome email to the customer. Only valid on create.

organization_id
string<uuid> | null
write-only
label_ids
string<uuid>[]
write-only

Response

201 - application/json
id
string<uuid>
required
read-only
bigcommerce_id
integer
required
read-only
created_at
string<date-time>
required
read-only
first_name
string
required
Required string length: 1 - 100
last_name
string
required
Required string length: 1 - 100
email
string<email>
required
Required string length: 1 - 254
organization
object
required
is_approved
boolean
required
read-only
approved_at
string<date-time> | null
required
read-only
approval_expiration
string<date> | null
required
read-only
approved_by
object
required
created_by
object
required
custom_fields
object[]
required
labels
object[]
required
read-only
billing_email

An optional email address to CC on invoices and receipts.

phone
string
default:""
Maximum string length: 50
company_name
string
default:""
Maximum string length: 255
bigcommerce_customer_group_id
integer
bigcommerce_tax_exempt_category
string
default:""
Maximum string length: 255