Set start form conditional rules

Defines, fully replacing the current rule set, the conditional behavior of the start form — reactions to a field's value changing, or the automatic calculation of a field's value.

Each rule is bound to a trigger field (fieldId) and uses a trigger: onChange (fires when the field's value changes), onLoad (fires when the form loads — an empty condition list means it always fires) or onCalculate (calculates a field's value from a mathematical expression involving other fields).

For onChange/onLoad, each operation combines a list of conditions (conditions, with fieldId, operator and value) with a list of actions (actions, with type and targetFieldId). The value field is required on every condition, even for unary operators such as is_empty/is_not_empty, which do not use it semantically — in those cases, send an empty string.

For onCalculate, use calculation, with a free-form mathematical expression (expression) referencing other fields by their identifier, the target field (targetFieldId), the decimal precision (precision) and whether the calculated field remains editable (editable).

This call fully replaces the current rule set — always send the complete desired list, not just the new rules.

An important side effect: this call clears the help text (help) on every field of the form. We recommend applying conditional rules before a field update that sets help text, always finishing the form's configuration with that field update.

If the value used in a condition does not exactly match one of the options registered on a select-type field (including accents and spacing), the corresponding rule will never fire — without producing any error.

curl --location --request PUT '/v1/flows//start-form/rules' \ --header 'Content-Type: application/json' \ --data '{ "items": [ { "fieldId": "string", "rules": { "trigger": "onChange", "active": true, "operations": [ { "conditions": [ { "fieldId": "string", "operator": "=", "value": null } ], "actions": [ { "type": "show", "targetFieldId": "string", "value": null } ] } ], "calculation": { "expression": "string", "targetFieldId": "string", "precision": 0, "editable": true } } } ] }'

Set start form conditional rules

Requisição

Respostas