Substituir campos do documento
Sandbox
https://api.sandbox.supersign.com.br
Sandbox
https://api.sandbox.supersign.com.br
PUT
https://api.sandbox.supersign.com.br
fields: [] remove todos. Cada ID deve ser único no documento e não pode ser reutilizado em outro documento. As páginas começam em 1. Posição e tamanho usam pontos de PDF, com origem no canto superior esquerdo. Cada campo traz exatamente um entre pages + position e anchor (texto âncora): com anchor, a SuperSign® procura o texto no PDF antes de gravar (uma busca por documento) e grava a página e a posição achadas; a âncora não é guardada. Texto não achado responde 422 ANCHOR_NOT_FOUND (ou o campo é omitido com ifNotFound: "ignore": como o PUT substitui todos os campos, um campo existente com aquele id é removido); details.anchors lista todas as âncoras não achadas; occurrence: "all" gera um campo por ocorrência, com ids derivados estáveis. Só com anchor o PUT pode responder os erros da busca: 409 DOCUMENT_NOT_READY, 422 DOCUMENT_HAS_NO_TEXT/DOCUMENT_TEXT_UNREADABLE/DOCUMENT_TOO_LARGE_FOR_ANCHOR e 503 com Retry-After; em qualquer erro nada é gravado. Campos sem anchor não disparam busca. Este endpoint PUT não exige Idempotency-Key; com anchor, o resultado depende do texto do documento. Veja o guia Posicionar campos por texto âncora.Requisição
Parâmetros de Caminho
Parâmetros Bodyapplication/jsonNecessário
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.sandbox.supersign.com.br/v4/api/envelopes//documents//fields' \
--header 'Content-Type: application/json' \
--data '{
"fields": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"participantId": "string",
"pages": [
1
],
"position": {
"x": 0,
"y": 0
},
"size": {
"width": 1,
"height": 1
},
"type": "SIGNATURE",
"properties": {}
}
]
}'Response Response Example
200 - Exemplo 1
{
"created": 0,
"updated": 0,
"deleted": 0
}Modificado em 2026-10-10 22:15:13