Criar Envelope

POST

/v2/envelopes/

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢201Criado

application/json

Created

Body

🟠400Solicitação Incorreta

🟠403Proibido

🟠404Registro Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/envelopes/' \
--header 'x-account-id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "folderId": "string",
    "title": "string",
    "deadline": null,
    "message": "string",
    "documents": [
        {
            "id": "string",
            "fileName": "string",
            "contentType": "string"
        }
    ],
    "signatories": [
        {
            "id": "string",
            "name": "string",
            "email": "user@example.com",
            "qualification": "string",
            "authMethod": "EMAIL",
            "phoneNumber": "string",
            "signingOrder": 0
        }
    ],
    "observers": [
        {
            "email": "user@example.com",
            "notifyOnSent": false,
            "notifyOnCompletion": true
        }
    ],
    "fields": [
        {
            "type": "SIGNATURE",
            "documentId": "string",
            "signatoryId": "string",
            "pageNumber": 1,
            "position": {
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
            },
            "properties": {}
        }
    ]
}'

Response Example

201 - Exemplo 1

{
    "envelopeId": "string",
    "uploadDetails": [
        {
            "documentId": "string",
            "fileName": "string",
            "uploadUrl": "string"
        }
    ]
}

Modificado em 2025-10-13 19:43:48