API ReferenceCompanies

Delete company

View as Markdown

Soft deletes a single workspace company. Requires the companies:write scope.

Authentication

AuthorizationBearer

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

Path parameters

company_idstringRequired

Response headers

X-Api-Versionstring

Response

Delete confirmation response.
idstringformat: "^cmp_[A-Za-z0-9]+$"
objectenum
Allowed values:
deletedboolean

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error