Create company

View as Markdown

Creates a workspace company. Requires the companies:write scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
domainslist of objectsRequired
namestringOptional1-255 characters
descriptionstringOptional1-2000 characters

Response headers

X-Api-Versionstring

Response

Created company response.
objectenum
Allowed values:
idstringformat: "^cmp_[A-Za-z0-9]+$"
created_atdatetime
updated_atdatetime
namestring or null
descriptionstring
industrystring
websitestringformat: "uri"
number_of_employeesinteger
logo_urlstringformat: "uri"
crm_associationobject
CRM record linked to this company. Present when the company has been matched to a CRM record via integration or API.
domainslist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error