v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Update Company

This API endpoint updates a specific company.

patch/v1/companies/{id}

Path parameters

idstring required

The ID of the company to be updated.

Request body

namestring

The company’s new name. Note: an existing company name cannot be used.

customFieldsstring json

The key is the key of the custom field property, and the value is an array of keys (in the case of multiSelect custom fields), or the direct value in the case of all other types of custom fields.

Response

200

idstring

objectstring

createdAtstring

namestring

fallbackColorstring

iconImageUrlstring

isPlaceholderboolean

Example response

{
  "id": "f22094b2-4e30-439e-a742-312f6c09519a",
  "object": "company",
  "createdAt": "2023-05-02T21:10:12Z",
  "name": "Rocket Rides 2",
  "fallbackColor": "#7CAE7A"
}