| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Move um card específico para uma fase final do fluxo, permitindo concluir um processo e registrar informações adicionais exigidas pela fase de destino.
Este endpoint é utilizado quando a fase final possui campos obrigatórios ou formulários que precisam ser preenchidos durante a conclusão do card.
Além de definir a fase final de destino, a requisição permite enviar os valores dos campos necessários para finalizar corretamente o processo.
É recomendado para integrações que realizam encerramento automatizado de fluxos, aprovações, conclusões de atendimentos, vendas ou qualquer outro processo controlado por fases finais.
Parâmetros utilizados
id da Fase
id da FaseIdentificador único do card que será movido para a fase final.
O ID deve ser informado diretamente na rota da requisição.
Exemplo:
POST https://api.goalfy.com.br/api/cards/moveToDonePhase/12345Neste exemplo:
12345
Corresponde ao ID do card que será finalizado.
Campos utilizados no Body
| Campo | Tipo | Descrição |
|---|---|---|
model | string | Identificador do formulário utilizado na fase final. |
phaseId | string | Identificador da fase final de destino. |
fields | array | Lista de campos que serão preenchidos durante a finalização. |
fieldInfoId | string | Identificador único do campo. |
value | string | array | null | Valor atribuído ao campo. |
Body da Requisição
Exemplo de Body
{
"modelId":"12345",
"phaseId":"12345",
"fields":[
{
"value":[
"Goalfy"
],
"fieldInfoId":"12345",
...
},
...
]
}Exemplo de Resposta
{
"createdAt": "2026-05-22T00:00",
"dateInCurrentPhase": "2026-06-08T00:00",
"formId": "12345",
"id": "12345",
"index": 10.0,
"phaseId": "12345",
"responsibles": [
{
...
}
],
"subtitleFields": [],
"tags": [],
"title": "Rascunho",
"updatedAt": "2026-06-08T00:00"
}
Respostas esperadas
Sucesso 200Move o card para a fase final informada e registra os valores enviados nos campos da requisição.
Possíveis erros
400 Bad RequestRetornado quando algum campo obrigatório não foi enviado ou possui formato inválido.
404 Not FoundRetornado quando o card, formulário ou fase informada não existem ou não foram localizados.
401 UnauthorizedRetornado quando o token de autenticação é inválido ou não foi enviado corretamente.
403 ForbiddenRetornado quando o usuário não possui permissão para movimentar o card ou acessar a fase final informada.
Observações
ImportanteAlgumas fases finais podem exigir o preenchimento de campos obrigatórios para que a movimentação seja concluída com sucesso.
- O modelId deve corresponder ao formulário associado à fase final.
- O phaseId deve corresponder a uma fase final válida.
- Os fieldInfoId enviados devem existir dentro do formulário informado.
- Dependendo da configuração do fluxo, alguns campos podem ser obrigatórios.
- A movimentação para uma fase final normalmente gera registros no histórico (logs) do Board.
- Recomenda-se consultar previamente os campos da fase antes de executar a movimentação.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas:
200