API ReferenceCompanies

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-RateLimit-Limitinteger

Maximum number of authenticated requests allowed for the workspace in the current 60-second window. The limit is 1000 and applies to all /api/v2 resource routes (GET, POST, PATCH, and DELETE), shared across every credential for the workspace.

X-RateLimit-Remaininginteger
Number of requests remaining in the current window before the limit is exceeded.
X-RateLimit-Resetinteger

Unix epoch seconds when the current rate-limit window resets.

X-Api-VersionstringOptional

Response

Created company response.
objectenum
idstringformat: "^cmp_[A-Za-z0-9]+$"
created_atdatetime
updated_atdatetime
namestring or nullOptional
descriptionstringOptional
industrystringOptional
websitestringOptionalformat: "uri"
number_of_employeesintegerOptional
logo_urlstringOptionalformat: "uri"
crm_associationobjectOptional
CRM record linked to this company. Present when the company has been matched to a CRM record via integration or API.
domainslist of objectsOptional

Errors

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