Set template fields

PUT

/templates/{id}/fields

Defines (or fully replaces) the field list of an existing template — the mandatory second step of template creation, and also the way to fix a field's origin (for example, switching from a phase field to a field from the initial form).

The request body only accepts the properties key, title, type, path, reference, required, options, section, uiComponent, children and rules on each field — properties such as active, editable, category, index, id, createdAt, updatedAt and sectionKey are rejected. If a field references a section (section) through its key, that section must have been previously declared when the template was created — referencing a section that doesn't exist results in an error stating the section was not found.

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

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Fields set

application/json

Illustrative example of the response, with the persisted fields. The template stays active:false until the next activation.

Bodyapplication/json

🟠400Section not found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/templates//fields' \
--header 'Content-Type: application/json' \
--data '{
    "fields": [
        {
            "key": "string",
            "title": "string",
            "type": "default",
            "path": "string",
            "reference": "string",
            "required": true,
            "uiComponent": "short-text",
            "section": "string",
            "options": [
                "string"
            ],
            "children": [
                {}
            ]
        }
    ]
}'

Response Example

200 - Exemplo 1

{
    "fields": [
        {
            "key": "string",
            "title": "string",
            "type": "default",
            "path": "string",
            "reference": "string",
            "required": true,
            "uiComponent": "short-text",
            "section": "string",
            "options": [
                "string"
            ],
            "children": [
                {}
            ]
        }
    ],
    "active": true
}

Modificado em 2026-07-28 20:38:32

Página anterior

List templates

Próxima página

Configure template conditional rules