Rename or restyle a stage
Changing name is safe — integrations key off key. Changing key is not: any
lead whose status holds the old value stops matching.
Authorizations
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.
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
Body
Response
The updated stage.
Stable slug stored in a lead's status. This is what you send to move a lead.
Display name. Tenants rename these — do not match on it.
Hex accent for the board column.
Board order.
Default stage; cannot be deleted.
Where new leads land.
Terminal success stage. Judge conversion by this flag, never by comparing key to "won".
Terminal failure stage. Mutually exclusive with is_won.

