Mover card de fase

Move um card da fase atual (informada no caminho) para outra fase do mesmo flow, informada no corpo da requisição.

O caminho da requisição deve sempre conter a fase ATUAL do card (o phaseId do caminho é a fase de origem); o corpo contém apenas o identificador da fase de destino, também no campo phaseId. Não é possível enviar doneType no corpo — esse valor é sempre resolvido a partir da configuração da fase de destino e não pode ser sobrescrito por esta chamada.

A fase de destino precisa estar entre as fases habilitadas como destino a partir da fase atual — esse conjunto é mais restrito do que o total de fases teoricamente alcançáveis exibido na interface do flow; mover para uma fase fora desse conjunto retorna erro 422, assim como tentar mover o card para a fase em que ele já se encontra.

Se a fase de origem tiver módulos obrigatórios pendentes configurados para bloquear a movimentação (por exemplo, um parecer técnico ou uma alçada de aprovação ainda não concluídos), a chamada retorna erro 400 informando quais ações ou campos ainda estão pendentes — a movimentação só é permitida após a conclusão desses módulos. Esse bloqueio é aplicado de forma consistente quando esta chamada é feita diretamente; movimentações automáticas disparadas por outras automações configuradas no flow podem não passar pelas mesmas verificações.

Após mover um card para uma fase de encerramento, o indicador de card finalizado retornado na leitura do card pode não refletir o novo estado de forma imediata: fases de encerramento negativo tendem a atualizar esse indicador de forma síncrona, enquanto fases de encerramento positivo podem levar um curto intervalo até refleti-lo. Recomendamos basear a lógica de integração no identificador da fase atual do card combinado com a configuração da própria fase (se é uma fase de encerramento e de que tipo), em vez de depender isoladamente desse indicador logo após a movimentação.

{ "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" }

Mover card de fase

Requisição

Respostas