Criar e enviar envelope numa chamada

Sandbox

POST

/v4/api/envelopes/send-now

Cria o envelope com documentos, participantes e campos numa só chamada e devolve as URLs para enviar os arquivos. O envio aos participantes acontece sozinho quando todos os documentos terminam de processar. Consulte o andamento por webhook ou por GET /v4/api/envelopes/{envelopeId}. Equivale ao POST /v3/envelopes da API legada.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Criado

Headers

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠409

🟠413

🟠422Erro de Parâmetro

🟠429

🔴503Serviço Indisponível

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/envelopes/send-now' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "folderId": "string",
    "title": "string",
    "deadline": null,
    "message": "string",
    "documents": [
        {
            "ref": "string",
            "filename": "string",
            "contentType": "string",
            "fileSize": 9007199254740991
        }
    ],
    "signatories": [
        {
            "type": "INDIVIDUAL",
            "deliveryMethod": "EMAIL",
            "groupId": "string",
            "order": 0,
            "name": "string",
            "email": "user@example.com",
            "phoneNumber": "string",
            "ref": "string",
            "qualification": "string",
            "isForeigner": true,
            "authMethod": "EMAIL"
        }
    ],
    "approvers": [
        {
            "type": "INDIVIDUAL",
            "deliveryMethod": "EMAIL",
            "groupId": "string",
            "order": 0,
            "name": "string",
            "email": "user@example.com",
            "phoneNumber": "string"
        }
    ],
    "observers": [
        {
            "type": "INDIVIDUAL",
            "deliveryMethod": "EMAIL",
            "groupId": "string",
            "order": 0,
            "name": "string",
            "email": "user@example.com",
            "phoneNumber": "string",
            "mandatoryView": false
        }
    ],
    "carbonCopies": [
        {
            "name": "string",
            "email": "user@example.com"
        }
    ],
    "fields": [
        {
            "id": "string",
            "documentRef": "string",
            "signatoryRef": "string",
            "pageNumber": 1,
            "position": {
                "x": 0,
                "y": 0
            },
            "size": {
                "width": 0,
                "height": 0
            },
            "type": "SIGNATURE",
            "properties": {}
        }
    ]
}'

Response Example

201 - Exemplo 1

{
    "envelopeId": "string",
    "uploadDetails": [
        {
            "documentId": "string",
            "documentRef": "string",
            "filename": "string",
            "uploadUrl": "string",
            "uploadHeaders": {
                "property1": "string",
                "property2": "string"
            }
        }
    ]
}

Modificado em 2026-09-16 16:49:00

Página anterior

Consultar histórico do envelope

Próxima página

Consultar envelope