Update company

Updates an existing company by its ID.

Use this same endpoint to upload, replace, or remove the company logo and cover images via the setLogo and setCover body fields.

Path Parameters

ParameterTypeRequiredDescription
idintegerYesCompany unique identifier

Body Fields

FieldTypeRequiredDescription
namestringNoCompany name
countrystringNoCountry code (e.g., FR, US)
sirenstringNoSIREN number (French business ID)
addressstringNoStreet address
address2stringNoAdditional address line
postCodestringNoPostal code
citystringNoCity name
companySizestringNoCompany size: 1, 2-10, 11-50, 51-200, 201-500, 500+
currencystringNoCurrency code (e.g., EUR, USD)
currencyFormatobjectNoCurrency formatting settings
showUnboardingbooleanNoShow onboarding flag
dealSettingsobjectNoDeal-specific settings
setLogostringNoAdd/replace or remove the company logo. Pass a base64-encoded image (data URI prefix like data:image/png;base64, is accepted and stripped), or the literal string "remove" to delete the current logo. The resulting public URL is stored in logo. Omit the field to leave the logo unchanged.
setCoverstringNoAdd/replace or remove the company cover image. Pass a base64-encoded image (data URI prefix like data:image/png;base64, is accepted and stripped), or the literal string "remove" to delete the current cover. The resulting public URL is stored in cover. Omit the field to leave the cover unchanged.

Examples — Logo & Cover

Upload (or replace) a logo:

{
  "setLogo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}

Remove the current logo:

{
  "setLogo": "remove"
}

Update both logo and cover at once:

{
  "setLogo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "setCover": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA..."
}

Response Fields

FieldTypeDescription
idintegerCompany unique identifier
namestringCompany name
logostringCompany logo URL
coverstringCompany cover image URL
countrystringCountry code
sirenstringSIREN number
addressstringStreet address
address2stringAdditional address line
postCodestringPostal code
citystringCity name
companySizestringCompany size: 1, 2-10, 11-50, 51-200, 201-500, 500+
currencystringCurrency code
currencyFormatobjectCurrency formatting settings
archivebooleanWhether the company is archived
showUnboardingbooleanShow onboarding flag
dealSettingsobjectDeal-specific settings
numberingSettingobjectNumbering configuration
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 200 OK: Company successfully updated
  • 400 Bad Request: Invalid request body or validation error
  • 401 Unauthorized: Invalid or missing API key
  • 404 Not Found: 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
string
string
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!