Atualizar fase

PATCH

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

Atualiza os campos de uma fase existente por meio de uma atualização parcial.

Ao reordenar fases pelo campo index, a API rejeita a alteração com erro 422 quando o novo valor já está em uso por outra fase do mesmo flow. Para reordenar múltiplas fases, recomendamos enviar as chamadas de forma sequencial, sempre movendo para uma posição momentaneamente livre — chamadas simultâneas podem gerar um conflito transitório mesmo quando o resultado final seria válido.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Fase atualizada

application/json

A fase foi atualizada com sucesso.

Bodyapplication/json

🟠422Conflito de posição

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

Página anterior

Atualizar ação de fase

Próxima página

Phase — Overview