Skip to content

Retire a rule

POST
/v1/memory/rules/{id}/retire
curl --request POST \
--url https://beta-api.plune.ai/v1/memory/rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/retire \
--header 'Authorization: Bearer <token>'

A person retires a rule (#2198), in a session: an API token is 403 session_required, as on the approval of a candidate. The rule is kept with who retired it and when, and is no longer read by default nor exported. Logged as an update of the queue entry the rule came from. Twice is a 409.

id
required
string format: uuid

Retired

Media type application/json

A rule of the project’s memory (#2198): what a person accepted, from where, and whether it is still in force.

object
id
required
string format: uuid
text
required
string
source
required

Where a candidate rule came from (#2198), and its identity: one source is one candidate and one rule. answer: a person’s answer to a question; decline: the reason a person rejected a queue entry with; failure_choice (#2195): the action a person picked in a question on a failed test; report_lesson (#2193): a lesson of an approved mission report.

object
kind
required
string
Allowed values: answer decline failure_choice report_lesson
id
required

The record: a review item; for report_lesson, <the report’s review item>:<the lesson’s questionId>.

string
>= 1 characters <= 200 characters
reviewItemId
required

The candidate entry a person approved.

string format: uuid
acceptedBy
required

The user who approved it, in a session.

string
acceptedAt
required
string format: date-time
inForce
required

False once retired. A retired rule is kept, and is neither read by default nor exported.

boolean
retiredBy

Present on a retired rule.

string
retiredAt

Present on a retired rule.

string format: date-time
Example
{
"id": "6f1c2b3a-0000-4000-8000-000000002198",
"text": "Which flow is the checkout: the one-page form or the three steps?\nAnswer: Three steps",
"source": {
"kind": "answer",
"id": "6f1c2b3a-0000-4000-8000-0000000021a9"
},
"reviewItemId": "6f1c2b3a-0000-4000-8000-0000000021c8",
"acceptedBy": "6f1c2b3a-0000-4000-8000-0000000000a2",
"acceptedAt": "2026-09-16T09:12:04.151Z",
"inForce": false,
"retiredBy": "6f1c2b3a-0000-4000-8000-0000000000a2",
"retiredAt": "2026-09-16T09:12:04.151Z"
}

No / invalid session

An API token (code: session_required), or a reader

Media type application/json
object
error
required
string
Example
{
"error": "a rule is retired by a person in a session - a token cannot",
"code": "session_required"
}

Not found or not yours

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

code: already_retired

Media type application/json
object
error
required
string
Example
{
"error": "the rule is retired already",
"code": "already_retired"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over