Rensei docs
API ReferenceOrg

Edit the fields of the org-scope stage row for a key (org admin).

Edit the fields of the org-scope stage row for a key (org admin). - Rensei REST API operation reference.

PATCH
/api/org/{orgId}/stages/{key}

Authorization

headerAuthorizationBearer <rsk_live_*>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

Path Parameters

orgId*string

Organization id (must match the authenticated org).

key*string

The stage key (lowercase kebab-case).

Match^[a-z0-9]+(-[a-z0-9]+)*$
Length1 <= length <= 64

Request Body

application/json
  1. body
role?string

A define only; an override never sets a role.

Value in"hold""intake""inflight""review""rework""done""closed"
name?|

Display name; required on a define.

Length1 <= length <= 200
description?|
Lengthlength <= 2000
disabled?|

true hides an inherited stage; null inherits.

modelSelection?|||||

The stage default; a bare inherit is stored as null.

outcomes?|

Targets must be keys of the effective set of this scope, or stay.

retry?|null
policies?|null

Response Body

The updated org-scope stage row.

application/json
  1. response
stage*
Example Request
curl -X PATCH 'https://app.rensei.ai/api/org/string/stages/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "stage": {    "id": "string",    "scope": "system",    "scopeId": "string",    "key": "string",    "kind": "define",    "role": "hold",    "name": "string",    "description": "string",    "disabled": true,    "modelSelection": {      "mode": "inherit",      "effort": "low"    },    "outcomes": {      "start": {        "target": "string"      },      "success": {        "target": "stay"      },      "failure": {        "target": "stay"      },      "blocked": {        "target": "stay"      },      "close": {        "target": "stay"      }    },    "retry": {      "retries": 0,      "backoffSeconds": 0    },    "policies": {      "version": 1    },    "createdAt": "string",    "updatedAt": "string"  }}

Create a stage define or override at org scope (org admin).

Create a stage define or override at org scope (org admin). - Rensei REST API operation reference.

Archive the org-scope stage row for a key (org admin).

Archive the org-scope stage row for a key (org admin). - Rensei REST API operation reference.