Companies

Delete a company

Changed on

Permanently deletes a company and cascades to delete every job attached to it (along with each job’s child records). It cannot be undone. Pass block=true to delete and block: the company is removed from the board and stays on the blocklist, so automated sourcing cannot recreate it. Deleting a company that is on the blocklist never takes it off the blocklist: the company stays blocked and is removed from the board instead of being purged (ADR-0124). To purge a blocked company completely, unblock it first and then delete it.

delete/companies/{id}

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/companies/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The company's opaque object id: the id field returned by the company endpoints (e.g. p17xq4c2b9r5gz3e8j0r6t4k7m2n9d5w). This is NOT the slug or display name; passing a slug like antler returns 404. To look up a company by name or slug, use GET /v1/companies, POST /v1/companies/search, or POST /v1/companies/find-or-create and read the returned id.

Query parameters

block'true' | 'false'

Pass true to delete and block: the company is removed from the board and kept on the blocklist, so backfill, imports and the API cannot add it back until it is unblocked. Defaults to false, a plain delete after which backfill may add the company again if it still matches the board’s sources. Ignored for a company whose website domain is shared with another company on the board, which is always a plain delete.

Response

Successful response.

Changes