Configure template conditional rules

Configures conditional rules for the template's fields — for example, showing, hiding, making required/optional, or clearing the value of a field based on the value of another field (onChange).

Each item in the payload associates a trigger field (fieldId) with a set of operations: each operation lists the conditions (conditions, with fieldId, operator and value) that, when met, fire one or more actions (actions, with type — show, hide, setRequired, setOptional or clearValue — and targetFieldId). The field identifiers used here (fieldId and targetFieldId) are the internal identifiers returned by the template lookup, not the key declared by the user.

To disable an existing rule, send the rule object with active: false and operations as an empty list — sending a null value for the rule object is rejected with a validation error.

Calling this endpoint deactivates the template as a side effect. The template needs to be activated again (see the activation endpoint) right afterward to become available for document generation again.

curl --location --request PUT '/templates//fields/rules' \ --header 'Content-Type: application/json' \ --data '{ "items": [ { "fieldId": "string", "rules": { "trigger": "string", "active": true, "operations": [ { "conditions": [ { "fieldId": "string", "operator": "string", "value": null } ], "actions": [ { "type": "show", "targetFieldId": "string" } ] } ] } } ] }'

Configure template conditional rules

Requisição

Respostas