Create customer company

Creates a new customer company (B2B client).

Body Fields

FieldTypeRequiredDescription
namestringYesCompany legal name
siretstringNoSIRET number (French business ID)
vatNumberstringNoVAT identification number
tradeNamestringNoCommercial/trade name
addressobjectNoCompany address (see Address object below)
customFieldsobjectNoCustom field values

Address Object

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

Response Fields

FieldTypeDescription
idintegerNewly created customer company unique identifier
namestringCompany legal name
siretstringSIRET number
vatNumberstringVAT identification number
tradeNamestringCommercial/trade name
addressobjectCompany address
archivedbooleanArchived status (default: false)
customFieldsobjectCustom field values
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 201 Created: Customer company 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
address
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!