Create phase action
POST
/v1/flows/{id}/phases/{phaseId}/actions
approval-config, opinion-config, credit-engine-config, among others), and only then create this phase action. Without the prior configuration, creation returns a 400 error.action field accepts exactly 11 values: approval, agrisk, opinion, decision-engine, create-document-enable, create-document-auto, credit-engine, messaging, conversation, financial-report, and income-tax. Bureau/AgRisk lookups use the value agrisk.blocksMovement field: for opinion and approval, it should always be true, since the card cannot advance until the module is completed; for messaging, it should always be false; for the engines (credit-engine and decision-engine), the default is false, with true reserved for specific exceptions.conditions field is required and cannot be sent empty — the API returns a 400 error in that case. A safe default value is [{rule:[{field:"card.value",condition:"gte",target:0}]}]. Inside rule[], the key that identifies the evaluated field is field; using path returns a 400 error.approval-config or opinion-config along with their rules, without creating the matching phase action, does not produce an API error — but the vote or opinion button simply will not appear to users on that phase. We recommend always creating the phase action right after configuring the module.create-document-enable and create-document-auto modules work together: enabling only one of them leaves the manual generation button without effect if the corresponding document template and auto-generation configuration are missing.Requisição
Parâmetros de Caminho
Parâmetros Bodyapplication/jsonNecessário
Respostas
Request 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 Response Example
201 - Exemplo 1
{
"id": "string",
"action": "string",
"blocksMovement": true,
"conditions": [
"string"
]
}Modificado em 2026-07-28 20:38:32