Skip to content

Create a customer

POST
/customers

Create a new customer in the organization

object
external_id
string
first_name
string
last_name
string
name
string
metadata
object
email_notifications
boolean
text_notifications
boolean
phone_notifications
boolean
email
string format: email
contact_email
string format: email
text_number
string
phone_number
string
time_window
string
start_time
string
end_time
string
po_required
boolean
timezone
string
is_active
boolean
default: true
preferences
object
key
additional properties
any
archived
boolean
sales_reps
Array<string>
credit_status
string
organizations
Array<string>
default_payment_type
string
profile_id
string
area
string
units
Array<string>
delivery_fee_exempt
boolean
class_1
string

Customer created

object
id
string
external_id
string | null
company_id
string
first_name
string | null
last_name
string | null
name
string | null
metadata
object
email_notifications
boolean
text_notifications
boolean
phone_notifications
boolean
email
string format: email
contact_email
string format: email
text_number
string
phone_number
string
time_window
string
start_time
string
end_time
string
po_required
boolean
date_created
string | null format: date-time
date_modified
string | null format: date-time
timezone
string | null
is_active
boolean
default: true
preferences
object | null
archived
boolean
sales_reps
array | null
credit_status
string | null
organizations
array | null
default_payment_type
string | null
profile_id
string | null
area
string | null
units
array | null
delivery_fee_exempt
boolean | null
class_1
string | null
last_modified_date
string | null format: date-time

Invalid request

object
success
required
boolean
error
required
string
Example
An error occurred

Unauthorized