Create customer

Creates a new customer (contact).

Body Fields

FieldTypeRequiredDescription
firstNamestringNoCustomer first name
lastNamestringNoCustomer last name
emailstringNoCustomer email address
civilitystringNoCivility/title (Mr, Mrs, etc.)
phonestringNoPrimary phone number
jobTitlestringNoJob title/position
billingAddressobjectNoBilling address (see Address object below)
differentDeliveryAddressbooleanNoSet to true if delivery address differs
deliveryAddressobjectNoDelivery address (required if differentDeliveryAddress is true)
customerCompanyobjectNoLink to customer company: {"id": companyId}
customFieldsobjectNoCustom field values

Address Object

FieldTypeRequiredDescription
countrystringNoCountry code (e.g., FR, US)
addressstringNoStreet address
postCodestringNoPostal code
citystringNoCity name

Response Fields

FieldTypeDescription
idintegerNewly created customer unique identifier
numberstringAuto-generated customer reference number
firstNamestringCustomer first name
lastNamestringCustomer last name
fullNamestringComputed full name
emailstringCustomer email address
archivedbooleanArchived status (default: false)
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 201 Created: Customer successfully created
  • 400 Bad Request: Invalid request body or validation error
  • 401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
string
string
string
billingAddress
object
boolean
customerCompany
object
customFields
object
Responses
201

Resource created

400

Bad request

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!