Set/clear the per-inbox review-policy override (console plane, human authority)

PATCH

/v1/admin/orgs/{org_id}/projects/{project_id}/inboxes/{addr}/review-policy

• Production
• Local

Set the per-inbox review-policy override (a non-null policy) or clear it back to inherit the account default (explicit JSON null; D6). A foreign address is 404; an invalid non-null policy value is 400. Console-only (never an MCP tool, D17).

Authorizations

• ClerkSession

Parameters

Path Parameters

org_id

required

string

project_id

required

string

addr

required

string

Request Body ^required

Set the per-inbox override (a non-null policy) or clear it back to inherit the account default (explicit JSON null; D6).

object

policy

A value SETS the override; explicit null CLEARS it (= inherit).

string

nullable

Allowed values: require_review allow_direct auto_send_graduated

Responses

200

Ok

The per-inbox review-policy override view after a set/clear: the raw override (empty = inherit), the account default it inherits from, and the resolved effective policy for this inbox (override-or-account-or-floor; D6).

object

address

required

string

override

required

Per-inbox override; empty = inherit the account default.

string

account

required

string

Allowed values: require_review allow_direct auto_send_graduated

effective

required

string

Allowed values: require_review allow_direct auto_send_graduated

400

Invalid request.

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

401

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

403

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

404

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