Update customer company

Updates an existing customer company by its ID.

Path Parameters

ParameterTypeRequiredDescription
idintegerYesCustomer company unique identifier

Body Fields

FieldTypeRequiredDescription
namestringNoCompany legal name
siretstringNoSIRET number (French business ID)
vatNumberstringNoVAT identification number
tradeNamestringNoCommercial/trade name
addressobjectNoCompany address (see Address object below)
archivedbooleanNoSet to true to archive the company
customFieldsobjectNoCustom field values

Address Object

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

Response Fields

FieldTypeDescription
idintegerCustomer company unique identifier
namestringCompany legal name
siretstringSIRET number
vatNumberstringVAT identification number
tradeNamestringCommercial/trade name
addressobjectCompany address
archivedbooleanArchived status
isDeletablebooleanWhether the company can be deleted
customFieldsobjectCustom field values
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 200 OK: Customer company successfully updated
  • 400 Bad Request: Invalid request body or validation error
  • 401 Unauthorized: Invalid or missing API key
  • 404 Not Found: Customer company not found
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
string
boolean
Responses
200

Resource updated

400

Bad request

401

Unauthorized

404

Resource not found

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