Create phase

Creates a new phase (stage) within an existing flow.

The fields name, color, index, start, and latenessTime are required: the API explicitly requires start in the creation payload (true for the starting phase, false for all others), returning a 400 error if the field is missing.

The latenessTime field is also required — omitting it may affect later operations on cards in that phase, returning a 500 error. Always send a value in minutes; the recommended default is 2880 (48 hours).

The color field accepts a fixed set of 10 values, not a free hex color: start, lost, won, turquoise, blue, orange, violet, pink, purple, and light_blue.

The doneType field is only required when done is true, and must be either won or lost.

The sortingPreference.field field accepts only 5 values; the value createdAt is not accepted — use enteredCurrentPhaseAt instead.

The cardsCanBeMovedToPhase field takes an array of allowed source phase identifiers. This is a UI guideline shown in the flow editor, and is not enforced by the API or by trigger automations.

curl --location '/v1/flows//phases' \ --header 'Content-Type: application/json' \ --data '{ "name": "string", "color": "start", "index": 0, "start": true, "done": false, "doneType": "won", "description": "string", "latenessTime": 2880, "sortingPreference": { "field": "name", "order": "asc" }, "cardsCanBeMovedToPhase": [ "string" ] }'

{ "id": "string", "name": "string", "color": "string", "index": 0, "start": true, "done": true, "doneType": "string", "latenessTime": 0, "sortingPreference": {}, "cardsCanBeMovedToPhase": [ "string" ], "flowId": "string" }

Requisição

Respostas