Delete a company

Delete an existing company in the workspace.

DELETE /v1/companies/{companyId}

Delete a company

cURL

curl --request DELETE \
  --url https://api.folk.app/v1/companies/{companyId} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "com_183ed5cc-3182-45de-84d1-d520f2604810"
  }
}

This action is not reversible. When removing a company from the workspace, all of its information is deleted, including its custom field values, notes, and any associations with groups, people, and other entities.

Authorizations

Authorization · string · header · required

API key for authentication

Path Parameters

companyId · string · required

The ID of the company to delete.

Required string length: 40

Response

200

application/json

The ID of the deleted company.

data · object · required

Show child attributes

Example:

{
  "id": "com_183ed5cc-3182-45de-84d1-d520f2604810"
}

deprecations · string[]

Example:

["This field is deprecated"]