Criar ação de fase

POST

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

Habilita um módulo — como aprovação, parecer, motores de crédito/decisão ou mensageria — em uma fase.

Recomendamos seguir um padrão de ativação em duas etapas, sempre nesta ordem: primeiro configurar o módulo correspondente (approval-config, opinion-config, credit-engine-config, entre outros), e só então criar esta ação de fase. Sem a configuração prévia, a criação retorna erro 400.

O campo action aceita exatamente 11 valores: approval, agrisk, opinion, decision-engine, create-document-enable, create-document-auto, credit-engine, messaging, conversation, financial-report e income-tax. Consultas de bureau/AgRisk utilizam o valor agrisk.

Quanto ao campo blocksMovement: para opinion e approval, deve ser sempre true, já que o card não pode avançar sem que o módulo seja concluído; para messaging, deve ser sempre false; para os motores (credit-engine e decision-engine), o padrão é false, reservando true para exceções pontuais.

O campo conditions é obrigatório e não pode ser enviado vazio — a API retorna erro 400 nesse caso. Um valor padrão seguro é [{rule:[{field:"card.value",condition:"gte",target:0}]}]. Dentro de rule[], a chave que identifica o campo avaliado é field; o uso de path retorna erro 400.

A ordem de configuração é importante: configurar approval-config ou opinion-config com suas regras, sem criar a ação de fase correspondente, não gera erro na API — porém o botão de voto ou parecer simplesmente não aparece para os usuários na fase. Recomendamos sempre criar a ação de fase logo após configurar o módulo.

Os módulos create-document-enable e create-document-auto funcionam em conjunto: habilitar apenas um deles deixa o botão de geração manual sem efeito, caso faltem o modelo de documento e a configuração de geração automática correspondentes.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Ação criada

application/json

A ação foi criada com sucesso.

Bodyapplication/json

🟠400Configuração ausente ou payload inválido

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//phases//actions' \
--header 'Content-Type: application/json' \
--data '{
    "action": "approval",
    "blocksMovement": true,
    "conditions": [
        {
            "rule": [
                {
                    "field": "string",
                    "condition": "string",
                    "target": null
                }
            ]
        }
    ]
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "action": "string",
    "blocksMovement": true,
    "conditions": []
}

Modificado em 2026-07-29 12:58:18