Move card to another phase

Moves a card from its current phase (given in the path) to another phase of the same flow, given in the request body.

The request path must always contain the card's CURRENT phase (the path's phaseId is the origin phase); the body contains only the destination phase identifier, also under the field phaseId. doneType cannot be sent in the body — that value is always resolved from the destination phase's configuration and cannot be overridden by this call.

The destination phase must be among the phases enabled as a destination from the current phase — this set is more restrictive than the full set of theoretically reachable phases shown in the flow's UI; moving to a phase outside this set returns a 422 error, as does attempting to move the card to the phase it is already in.

If the origin phase has pending required modules configured to block movement (for example, an unresolved technical opinion or approval alçada), the call returns a 400 error stating which actions or fields are still pending — the move is only allowed once those modules are completed. This block is applied consistently when this call is made directly; automatic moves triggered by other automations configured on the flow may not go through the same checks.

After moving a card into a closing phase, the completed-card indicator returned when reading the card may not reflect the new state immediately: negative-closing phases tend to update this indicator synchronously, while positive-closing phases may take a short interval to reflect it. We recommend basing integration logic on the card's current phase identifier combined with that phase's own configuration (whether it is a closing phase, and of which type) rather than relying solely on this indicator right after a move.

{ "id": "string", "flowId": "string", "currentPhaseId": "string", "title": "string", "value": 0, "done": true, "assignee": { "userId": "string", "userName": "string", "userEmail": "string" }, "labels": [ { "label": "string", "color": "string" } ], "fields": [ { "id": "string", "value": null } ], "createdAt": "string" }

Move card to another phase

Requisição

Respostas