Skip to content

Withdraw a pending review (composing agent)

POST
/v1/reviews/{id}/cancel

The composing agent withdraws its own pending review to the terminal cancelled state (M5; spec §3.2 “agent withdraws”). Only the composer may cancel its own review (a foreign id, or another agent’s draft, 404s; no cross-agent existence leak). A terminal review 409s (you cannot withdraw a sent message; D17).

id
required
string

Ok (the review, now cancelled)

A review request (rr_…); the server-owned pre-send record of a message under the Review Loop. Carries intent, the current proposed draft, category, state machine fields, and (once sent) the sent body + diff.

object
category_name

Human-readable category name; absent when unavailable.

string
recheck_status

Pending reconsideration; does not assert that the composer is online.

string
Allowed values: queued
recheck_completed_through_seq

Durable composer completion watermark independent of acknowledgement.

integer
recheck_outstanding_seq

Highest available unresolved recheck event sequence.

integer
recheck_reason

Cause of pending reconsideration.

string
id
required
string
state
required
string
Allowed values: needs_review in_review chatting stale approved sent auto_sent rejected stalled cancelled failed
mode
required
string
Allowed values: review direct
review_path

Console path to this draft. Sign in and claim the workspace if prompted before reviewing.

string
effective_mode
required
string
Allowed values: review direct
kind
required
string
Allowed values: send reply forward
from_address
string
from_display_name

Captured sender name for this review; empty means bare address. Absent on legacy reviews.

string
agent_id
string
category_id
string
intent_summary
string
intent_meta
object
key
additional properties
any
revision
required
integer
version
required
integer
proposed_subject
string
proposed_body_text
string
proposed_body_html
string
proposed_to
Array<string>
proposed_cc
Array<string>
proposed_bcc
Array<string>
thread_ref

Mail conversation ID for fetching reply or forward context; distinct from reviewer feedback.

string
context_version

Conversation snapshot used for this draft. Absent on legacy drafts whose composition context is unknown.

string
context_last_message_id

Newest message observed when composing this draft.

string
context_message_ids

Message selectors in the conversation snapshot used for this draft; does not certify semantic comprehension.

Array<string>
in_reply_to_message_id

Opaque parent message ID for replies; raw RFC5322 Message-ID for plain sends.

string
sent_subject
string
sent_body_text
string
diff_unified
string
sent_message_id
string
gate_outcome
string
stale_reason
string
decision_feedback
string
closed

True once this review will never move again; sent, auto_sent, cancelled OR failed. It is the definitive per-review “am I done?” answer and the poll-side companion to the terminal review events; use it after a restart when your event cursor is gone. failed is included deliberately: nothing re-approves a failed review, so treating it as open means waiting forever.

boolean
send_error

Vendor-scrubbed delivery failure, present on a failed review.

string
send_path

How the message was released, once sent.

string
Allowed values: human_reviewed delegated_reviewed reviewer_approved graduated_auto agent_direct human_recipient_auto project_recipient_auto organization_recipient_auto
created_at
string format: date-time
updated_at
string format: date-time
decided_at
string format: date-time
sent_at
string format: date-time

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

Resource not found.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

A Review Loop conflict, as problem+json. Branch on code, NOT on the 409 status; the four codes demand opposite behavior. stale: the revision/version you named is no longer current (a human moved the draft) and NOTHING was mutated; errors[] carries the current state, revision and version, so re-apply your change on top and resubmit with the new parent_revision (retry, bounded to ~3). born_stale: the redraft was built against an older rule high-water; re-read the rules and resubmit, or restamp_review if nothing genuinely changed (at most one retry per high-water). wrong_state: this VERB is illegal from the current state but the draft is still live; NEVER retry the same verb; errors[] repeats an allowed_action entry per verb that IS legal right now. terminal: the review is already sent/auto_sent/cancelled; nothing will ever succeed, stop retrying, and a front_run_next review event carries the outcome. send_needs_reconciliation: a prior attempt is unconfirmed and parked for recover-by-Message-ID; do NOT resend, poll the review.

RFC-9457 problem+json error body. code is a closed machine enum clients switch on; type is a dereferenceable URI under https://extrovert.dev/problems/. Served as application/problem+json.

object
reason

Structured support failure reason without changing the existing code.

string
next_action

Suggested recovery action within existing access.

string
projects
object
object
required
string
Allowed values: list
data
required
Array<object>
object
id
required
string
org_id
required
string
name
required
string
has_more
required
boolean
next_cursor
required
string
current_state
object
id
required
string
number
required
string
project_id
required
string
title
required
string
status
required
string
Allowed values: received working waiting_on_customer resolved
impact
required
string
Allowed values: blocked workaround_available recovered unknown
version
required
integer format: int64
created_ms
required
integer format: int64
updated_ms
required
integer format: int64
resolved_ms
integer format: int64
customer_confirmed_ms
integer format: int64
resolution_kind
string
resolution_summary
string
feedback_id
required
string
org_id
string
console_url
string
latest_update
object
id
required
string
sequence
required
integer format: int64
kind
required
string
actor_kind
required
string
Allowed values: customer staff
body
required
string
created_ms
required
integer format: int64
observed_runtime
object
source
string
package_version
string
profile
string
profile_version
string
build
string
transport
string
catalog_digest
string
instance_id
string
request_id
string
observed_ms
integer format: int64
truncated
required
boolean
unsent_text

Retained text after a concurrent case change.

string
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required

The CLOSED machine code. The Review Loop members split what used to be a single opaque conflict, because an agent must take a DIFFERENT action on each: stale (the revision/version you named is no longer current; nothing was mutated; re-read, re-apply, resubmit; retryable, bounded) and born_stale (built against an older rule high-water; re-read the rules or restamp_review; at most one retry per high-water) are the ONLY retryable 409s. wrong_state means this VERB is illegal from the current state while the draft is still live; never retry the same verb, read the state and the repeated allowed_action hints in errors[] and pick a legal one. terminal means the review is already sent/auto_sent/cancelled and nothing will EVER succeed; stop, and drain your review events for the outcome. send_needs_reconciliation means a prior send is unconfirmed and parked. Do not resend. Poll instead. unavailable (503) is the retryable fail-closed answer when a dependency could not be read; it carries Retry-After and is distinct from not_configured, which is permanent for this deployment.

string
Allowed values: bad_request unauthorized forbidden_scope not_found conflict support_record_deleted idempotency_conflict breadth_required quota_exceeded rate_limited domain_not_allowed recipient_blocked recipient_suppressed not_configured domain_unavailable internal reply_context_required reply_context_changed reply_workflow_required reply_already_pending intent_required wrong_state terminal stale born_stale send_needs_reconciliation graduation_locked maturity_gate_unmet scope_taken unavailable
request_id
string
errors
Array<object>
object
field
string
code
string
detail
string