Skip to main content
POST
Release a company

Authorizations

Authorization
string
header
required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Headers

Idempotency-Key
string
required

Required client-supplied key scoped to the Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.

Path Parameters

id
string<uuid>
required

UUID of the managed company in this request.

Body

application/json

Body of POST /partner/v2/companies/{id}/release/.

reason is validated for shape only: the release event carries the fixed machine reason partner_released and never free text.

reason
string | null

Optional single-line note for the partner's own records, up to 5000 characters. It is not stored on the company and never appears in webhook payloads.

Maximum string length: 5000

Response

case_access
enum<string>
required

Partner case access after the release: always unavailable — the company's cases are no longer reachable on behalf of this partner.

  • unavailable - unavailable
Available options:
unavailable
id
string<uuid>
required
read-only

Identifier of the released company.