Sign in
Customers

Create customer

Create a new customer record with address information.

Set is_taxable to false to create a tax-exempt customer (for example resellers, government agencies, or qualifying non-profits). Omit the field to use the default (false).

post/public/v1/customers/

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

custom_fieldsobject[] nullable
namestring required
unique_idstring nullable
emailstring required
addressstring required
countrystring required
phonestring required
websitestring required
is_taxableboolean

Whether tax is calculated for this customer. Set to false to mark the customer as tax-exempt.

allowed_company_idsinteger[] nullable

Company IDs allowed to use this customer. Empty list means global (all companies).

Response

Created

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

approval_statusstring nullable
idinteger required
codestring nullable
addressstring required
countrystring required
namestring required
unique_idstring nullable required
websitestring required
emailstring required
customer_typestring required
is_activeboolean required
phonestring required
record_statusstring required
is_taxableboolean required
default_tax_codestring required
tax_registration_numberstring required
allowed_company_idsinteger[]

Changes

Changed in 5 of the 27 revisions of this API.17

  • 456ef8c02f623See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • d0cd912ee42d2See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • db5c5da9869c1See the full diff
    • ●

      changed the pattern of the request property from ^[0-9\s\+\-\.\(\)]*$ to (?i)^(?:[0-9\s+\-.\(\)]*|[0-9\s+\-.\(\)]+(?:\s*(?:x|ext\.?|extension)\s*\d+))$

      request-property-pattern-changed

  • af0ec77e52771See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • 1f38ce6f7ff21See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

Of the 27 revisions, 1 has no diff computed.