--- title: Claim or unassign a review — POST /api/v1/executions/{id}/review_assignment description: "assignee: \"me\" claims the review for the calling api_user; assignee: null releases it. An assigned / unassigned audit event is recorded when the assignee…" canonical_url: "https://cascades.crscreditapi.com/docs/api/executions/assign-review" doc_version: "1.0.0" last_updated: "2026-10-09T18:04:24Z" source: "public/api-docs/v1/swagger.yaml#assignReview" --- # Claim or unassign a review — POST /api/v1/executions/{id}/review_assignment `POST https://cascades.crscreditapi.com/api/v1/executions/{id}/review_assignment` - Operation id: `assignReview` - Scopes: `executions:write` - Idempotent: no - OpenAPI: https://cascades.crscreditapi.com/openapi.json · https://cascades.crscreditapi.com/openapi.yaml (operationId `assignReview`) `assignee: "me"` claims the review for the calling api_user; `assignee: null` releases it. An `assigned` / `unassigned` audit event is recorded when the assignee actually changes. Requires `executions:write`. ## Path parameters | Name | Type | Required | Description | |---|---|---|---| | `id` | integer | yes | Execution id. Scoped to the calling api_client; a foreign id returns 404. | ## Request body `application/json` — `ReviewAssignmentRequest` | Field | Type | Required | Description | |---|---|---|---| | `assignee` | string, nullable | no | `me` claims for the calling api_user; null unassigns. One of: `"me"`, `nil`. | | `note` | string | no | | ```json { "assignee": "me" } ``` ## Responses ### 200 — Updated assignment `application/json` | Field | Type | Required | Description | |---|---|---|---| | `data` | Execution | no | | |   `id` | integer | yes | | |   `object` | string | yes | | |   `workflow_id` | integer | yes | | |   `status` | string | yes | Lifecycle of an execution. `queued` (batch rows not yet dispatched), `pending`, `running` and `waiting` (paused on a Wait node or adverse-action waiting period) are in flight; `awaiting_review` is paused on human review; `completed`, `failed`, `cancelled` and `skipped` are terminal. One of: `"queued"`, `"pending"`, `"running"`, `"waiting"`, `"awaiting_review"`, `"completed"`, `"failed"`, `"cancelled"`, `"skipped"`. | |   `execution_key` | string, nullable | no | | |   `external_reference` | string, nullable | no | | |   `needs_human_review` | boolean | yes | | |   `review_status` | string | yes | One of: `"none"`, `"in_review"`, `"approved"`, `"denied"`. | |   `assigned_to_user_id` | integer, nullable | no | The reviewer who claimed this execution, if any. | |   `started_at` | string (date-time), nullable | no | | |   `completed_at` | string (date-time), nullable | no | | |   `created_at` | string (date-time) | yes | | |   `updated_at` | string (date-time), nullable | no | | |   `input_context` | object | no | The payload originally sent at trigger time, plus resolved fields such as `execution_mode`, `submitted_by_user_id`, `user_approved`, `external_reference`, (for a test-mode run of a draft) `allow_inactive` and (for a test-mode run that replays a registered test subject) `sandbox_replay`. | | `meta` | Meta | no | | |   `request_id` | string | yes | Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support. | ```json { "data": { "id": 1842, "object": "execution", "workflow_id": 27, "status": "queued", "execution_key": "api_client:12:3fa85f64-5717-4562-b3fc-2c963f66afa6", "external_reference": "rv-app-20491", "needs_human_review": true, "review_status": "none", "assigned_to_user_id": 1, "started_at": "2026-05-08T18:41:05Z", "completed_at": "2026-05-08T18:41:05Z", "created_at": "2026-05-08T18:41:05Z", "updated_at": "2026-05-08T18:41:05Z", "input_context": {} }, "meta": { "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f" } } ``` ### 401 — Missing, malformed, expired or revoked bearer token. The `WWW-Authenticate` header carries the RFC 6750 challenge. `application/json` — `ErrorEnvelope` ```json { "error": { "code": "unauthorized", "message": "A valid bearer token is required.", "details": [], "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f", "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/unauthorized" } } ``` ### 403 — Token does not hold the required scope. `details` lists the scope(s) that were checked. `application/json` — `ErrorEnvelope` ```json { "error": { "code": "insufficient_scope", "message": "This token does not have the required scope.", "details": [ { "field": "scope", "message": "executions:write" } ], "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f", "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/insufficient_scope" } } ``` ### 404 — Resource does not exist or belongs to another tenant / api_client `application/json` — `ErrorEnvelope` ```json { "error": { "code": "not_found", "message": "The requested resource was not found.", "details": [], "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f", "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/not_found" } } ``` ### 422 — `validation_failed` — `assignee` must be `"me"` or `null` `application/json` — `ErrorEnvelope` ```json { "error": { "code": "validation_failed", "message": "The request could not be processed.", "details": [ { "field": "assignee", "message": "must be 'me' to claim or null to unassign" } ], "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f", "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/validation_failed" } } ``` ### 429 — Rate limit exceeded (60 req/min per IP on `/api/v1`, 600 req/hour per token prefix, or 300 req/5 min per IP globally). The body is the standard error envelope and `Retry-After` gives the seconds until the window resets. `application/json` — `ErrorEnvelope` ```json { "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry later.", "details": [], "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f", "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/rate_limited" } } ``` ## Code samples ### cURL ```shell curl -X POST "https://cascades.crscreditapi.com/api/v1/executions/1842/review_assignment" \ -H "Authorization: Bearer {{API_KEY}}" \ -H "Content-Type: application/json" \ -d '{ "assignee": "me" }' ``` ### Node.js ```javascript const response = await fetch("https://cascades.crscreditapi.com/api/v1/executions/1842/review_assignment", { method: "POST", headers: { "Authorization": "Bearer {{API_KEY}}", "Content-Type": "application/json" }, body: JSON.stringify({ "assignee": "me" }) }); const { data, meta } = await response.json(); console.log(response.status, data, meta.request_id); ``` ### Python ```python import requests response = requests.post( "https://cascades.crscreditapi.com/api/v1/executions/1842/review_assignment", headers={ "Authorization": "Bearer {{API_KEY}}", }, json={ "assignee": "me" }, ) response.raise_for_status() payload = response.json() print(payload["data"], payload["meta"]["request_id"]) ``` ### Ruby ```ruby require "net/http" require "json" uri = URI("https://cascades.crscreditapi.com/api/v1/executions/1842/review_assignment") request = Net::HTTP::Post.new(uri) request["Authorization"] = "Bearer {{API_KEY}}" request["Content-Type"] = "application/json" request.body = <<~JSON { "assignee": "me" } JSON response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end payload = JSON.parse(response.body) puts payload["data"], payload.dig("meta", "request_id") ``` ### Go ```go package main import ( "bytes" "fmt" "io" "net/http" ) func main() { body := []byte(`{ "assignee": "me" }`) req, err := http.NewRequest("POST", "https://cascades.crscreditapi.com/api/v1/executions/1842/review_assignment", bytes.NewBuffer(body)) if err != nil { panic(err) } req.Header.Set("Authorization", "Bearer {{API_KEY}}") req.Header.Set("Content-Type", "application/json") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() out, _ := io.ReadAll(resp.Body) fmt.Println(resp.StatusCode, string(out)) } ``` ### Agent ```shell claude mcp add cascades \ -e CASCADES_API_KEY={{API_KEY}} \ -e CASCADES_PROD_BASE_URL=https://cascades.crscreditapi.com \ -- npx -y @crscreditapi/cascades-mcp-server # Then ask your assistant: # "Claim or unassign a review 1842 using the Cascades API." # No MCP tool covers this endpoint yet; the assistant can call POST /executions/{id}/review_assignment with curl. ``` ## Related - [Human review](https://cascades.crscreditapi.com/docs/concepts/human-review) - [Handle human review](https://cascades.crscreditapi.com/docs/guides/handle-human-review) ## Sitemap See the full [sitemap](https://cascades.crscreditapi.com/sitemap.md) for all pages.