Update a company

patch

https://api.dotfile.com/v1/companies/{id}

Updates the company with the given ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Id of the company

Body Params

name

string

length between 1 and 160

Name for the company (at most 160 characters).

commercial_name

string | null

Commercial name for the company (at most 160 characters).

registration_number

string | null

registration_date

date | null

Date in format ISO 8601(yyyy-MM-dd eg 2023-01-31)

status

string

enum

Defaults to not_reported

Allowed:

legal_form

string | null

entity_legal_form

string | null

ISO 20275 code (eg: 6CHY)

country

string | null

ISO 3166-1 alpha-2 country code (eg FR)

address

object

classifications

array of objects

Defaults to

classifications

banking_information

object

share_capital

string | null

tax_identification_number

string | null

website_url

string | null

employer_identification_number

string | null

custom_properties

object

Optional partial custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to update the company.

Archived custom properties are not accepted.

Responses

400

The request is either malformed or contain invalid parameters.

Make sure the identifier specified in the URL is a valid UUID
Make sure the body payload matches the expected schema

404

No company can be found.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns information of the updated company ℹ️ Click to see full payload