Skip to main content
PATCH
Rename or restyle a stage

Authorizations

x-api-key
string
header
required

Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.

Keys are scoped. A key needs conversations:send to send, conversations:read to read threads and messages, templates:read to list templates, and channels:read to list channels. A key missing the scope for an endpoint gets 403.

The CRM endpoints use the same resource:action form: leads:read, leads:create, leads:update, leads:delete, customers:read, customers:create, customers:update, customers:delete, customers:manage.

Several resources have no scope of their own and borrow one:

Grant only what the integration needs — a key that only sends notifications should hold conversations:send and nothing else.

X-Tenant-Id
string
header
required

Your workspace UUID. Required on every request in addition to x-api-key.

It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.

Path Parameters

id
string<uuid>
required

Body

application/json
key
string

Changing this orphans leads holding the old value.

name
string
color
string

Hex accent.

position
integer
is_default
boolean
is_won
boolean
is_lost
boolean

Response

The updated stage.

id
string<uuid>
key
string

Stable slug stored in a lead's status. This is what you send to move a lead.

name
string

Display name. Tenants rename these — do not match on it.

color
string

Hex accent for the board column.

position
integer

Board order.

is_system
boolean

Default stage; cannot be deleted.

is_default
boolean

Where new leads land.

is_won
boolean

Terminal success stage. Judge conversion by this flag, never by comparing key to "won".

is_lost
boolean

Terminal failure stage. Mutually exclusive with is_won.

created_at
string<date-time>
updated_at
string<date-time>