Posicionar campos no documento do modelo

Sandbox

PUT

/v4/api/templates/{templateId}/documents/{documentId}/fields

Define os campos de um documento do modelo e a vaga de cada um. A lista substitui a anterior daquele documento. Só em rascunho: modelo ativo responde 409 TEMPLATE_NOT_DRAFT.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK

application/json

Sucesso

Headers

Bodyapplication/json

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠409

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/v4/api/templates//documents//fields' \
--header 'Content-Type: application/json' \
--data '{
    "fields": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "templateParticipantId": "string",
            "pages": [
                1
            ],
            "position": {
                "x": 0,
                "y": 0
            },
            "size": {
                "width": 0,
                "height": 0
            },
            "type": "SIGNATURE",
            "properties": {}
        }
    ]
}'

Response Example

200 - Exemplo 1

{
    "created": 0,
    "updated": 0,
    "deleted": 0
}

Modificado em 2026-09-29 13:44:48

Página anterior

Definir vagas do modelo

Próxima página

Listar envelopes anulados