Update a stage within a pipeline

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Pipeline UUID

stageId*string

Stage UUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Stage name (English)

Lengthlength <= 255

nameHe?string

Stage name in Hebrew

Lengthlength <= 255

color?string

Hex color code (e.g. #9333EA)

Lengthlength <= 7

sortOrder?number

Sort order position

Range0 <= value

winProbability?number

Win probability percentage (0–100)

Range0 <= value <= 100

isClosed?boolean

Whether this stage is a closed (terminal) state

isWonStage?boolean

Whether this stage marks a deal as Won

isLostStage?boolean

Whether this stage marks a deal as Lost

rottingDays?number

Number of days a deal can sit in this stage before being flagged as rotting (omit/null = never rots)

Range0 <= value

stageKind?string

Semantic role of this stage for automation (lead/contacted/quote_sent/negotiation/awaiting_payment/won/lost)

Lengthlength <= 30

Response Body

`application/json`

curl -X PATCH "https://example.com/crm/pipelines/string/stages/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "nameHe": "string",  "color": "string",  "sortOrder": 0,  "winProbability": 0,  "isClosed": true,  "isWonStage": true,  "isLostStage": true,  "rottingDays": 0,  "stageKind": "string"}