Substituir campos do documento

Sandbox

https://api.sandbox.supersign.com.br

PUT

/v4/api/envelopes/{envelopeId}/documents/{documentId}/fields

Substitui o conjunto completo de campos de um documento do envelope. Envie todos os campos que devem permanecer: um campo existente omitido de fields é removido, e fields: [] remove todos os campos. Cada ID de campo deve ser único no documento e não pode ser reutilizado por outro documento. As páginas começam em 1. Posição e tamanho usam pontos de PDF, com origem no canto superior esquerdo da página, x crescendo para a direita e y crescendo para baixo. Cada retângulo deve permanecer dentro da página de destino. Este endpoint PUT não exige Idempotency-Key.

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK

application/json

Headers

Bodyapplication/json

🟠401Não Autorizado

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.sandbox.supersign.com.br/v4/api/envelopes//documents//fields' \
--header 'Authorization: Bearer <token>' \
--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 Example

200 - Exemplo 1

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

Modificado em 2026-09-06 20:28:54

Página anterior

Listar documentos do envelope

Próxima página

Listar campos do documento