Update phase

PATCH

/v1/flows/{id}/phases/{phaseId}

Updates the fields of an existing phase through a partial update.

When reordering phases via the index field, the API rejects the change with a 422 error if the new value is already in use by another phase in the same flow. To reorder multiple phases, we recommend sending the calls sequentially, always moving into a momentarily free position — concurrent calls may cause a transient conflict even when the final result would be valid.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Phase updated

application/json

The phase was updated successfully.

Bodyapplication/json

🟠422Position conflict

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Exemplo 1

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

Modificado em 2026-07-28 20:38:32