position that
defines its order. Every route on this page requires the pipeline.manage permission.
To create or reorder several stages at once, prefer
Configure a pipeline — it is a
transactional operation that saves the complete list.
The Stage object
Stage UUID
Name displayed at the top of the column
Color in the token format
"H S% L%" (HSL triple without the hsl() wrapper)won, lost, or absent for a regular stageColumn order on the board (0-based)
Create a stage
POST
/backend/pipelines/{id}/stageswon or lost stages —
they already exist from the moment the pipeline is created.
Request Body
Stage name
Color in the
"H S% L%" format. When omitted, the default gray "215 16% 47%" is used.Update a stage
PUT
/backend/pipeline/stages/{id}Request Body
New name
New color in the
"H S% L%" formatNew position on the board
The
won and lost stages can be renamed and recolored normally — it is the kind that
does not change. This is how you replace the Portuguese default names (Ganho, Perdido)
with English ones.Delete a stage
DELETE
/backend/pipeline/stages/{id}Query Parameters
Stage that will receive the deals from the deleted stage. Required when the stage still
contains deals.
Error
message strings are returned by the API in Portuguese. Match on code
(ERR_CONFLICT, ERR_INVALID_INPUT), never on the message text.