Reordenar documentos do envelope

Sandbox

PATCH

/v4/api/envelopes/{envelopeId}/documents/reorder

Define a ordem dos documentos de um envelope em rascunho ou em ajuste. Envie em documentIds todos os documentos do envelope, uma vez cada, na ordem desejada; lista incompleta, repetida ou com documento de outro envelope responde 400, e envelope fora de rascunho ou ajuste responde 403. Não altera o conteúdo dos arquivos.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢204Sem Conteúdo

Sem conteúdo

Headers

Esta resposta não possui corpo.

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v4/api/envelopes//documents/reorder' \
--header 'Content-Type: application/json' \
--data '{
    "documentIds": [
        "string"
    ]
}'

Response Example

400 - documentIds does not match the envelope documents

{
    "error": {
        "code": "BAD_REQUEST",
        "message": "Document ID 7b1f... is missing from the provided list."
    }
}

Modificado em 2026-09-29 14:03:50

Página anterior

Validar um documento selado

Próxima página

Adicionar documento ao envelope