Sign in

v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create Company

This API endpoint creates a company.

post/v1/companies

Request body

namestring required

The company's name

iconImageUrlstring

Link (URL) to an image to use as the company's icon. Must be a publicly accessible URL.

fallbackColorstring

Hexadecimal value (i.e. "#9BBFFF") of the color used to create an icon if an iconImageUrl is not defined on the company

customFieldsstring json

The keys are the key of the custom field property, and the values are an array of custom field option 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": "b3be03e0-4e92-4483-997e-f6c351bfbd34",
  "object": "company",
  "createdAt": "2024-02-14T22:41:58.09460254Z",
  "name": "RocketRides4",
  "fallbackColor": "#7CAE7A"
}