Skip to main content
POST
Call brand_kit.retire

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
fact_id
string<uuid>
required

The fact's id, exactly as brand_kit.read returned it.

expected_updated_at
string

The updated_at brand_kit.read returned with the fact. A fact that changed since is refused. Omit to retire it as it reads now.

Required string length: 1 - 64
confirmation_id
string<uuid>

Omit to propose: the first call says what would happen, returns a confirmation_id and changes nothing. To go ahead, send the same arguments again with that confirmation_id, on a member's own API key; a service account's key can propose but never confirm.

workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
state
required
Allowed value: "confirmation_required"
fact_id
string<uuid>
required
kind
required

The kit's own name for the fact.

item_key
string | null
required
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.

confirmation_id
string<uuid>
expires_in_seconds
integer
request_summary
string

What will happen, in one sentence, for a person to approve before confirming.

fact_state
enum<string>

confirmed: retiring removes it from the kit. suggested: retiring declines it, and the same suggestion is not brought back.

Available options:
confirmed,
suggested
value
any

The fact exactly as it would be retired.

updated_at
string
declined
boolean

true when the retired fact was a suggestion, now declined.

read_outcome_with
object

brand_kit.read with this kind no longer lists the fact.

line
string