Companies

Block a company

Changed on

Puts a company on the board-scoped blocklist. Blocking always stops company-vertical backfill and rejects automated sourcing writes that match this company. Two outcomes are available. The default (remove omitted or false) keeps the public profile, archives currently published jobs, and still allows non-automated human posts. With remove: true the profile, its jobs, and its directory, sitemap, and search entries are removed from the board while the company stays on the blocklist, and every write that resolves to it is rejected (ADR-0124). Idempotent: blocking an already-blocked company succeeds and reports was_already_blocked: true, and remove: true upgrades an already-blocked company to the removed outcome. The response reports removed (the resulting state) and removal_scheduled (whether this call started the removal).

post/companies/{id}/block

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/companies/{id}/block
  • 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.

Request body

reasonstring

Optional free-text reason recorded on the blocklist audit.

removeboolean

When true, also removes the company profile and its jobs from the board while keeping it on the blocklist (ADR-0124); default false keeps the profile and archives published jobs.

Response

Successful response.

idstring required

The blocked company id.

blockedtrue required
jobs_archived_scheduledboolean required

Whether a published-job archive pass was scheduled.

was_already_blockedboolean required

True when the company was already on the blocklist.

removedboolean required

True when the company is removed from the board as well as blocked.

removal_scheduledboolean required

Whether this call scheduled the removal of the profile and its jobs.

Changes