Criar envelope a partir de modelo

Sandbox

POST

/v4/api/templates/{templateId}/envelopes

Cria um envelope usando um modelo como base, preenchendo cada vaga com os dados reais do participante. Pode enviar o envelope na mesma chamada (send: true) ou deixá-lo em rascunho para revisão posterior. A resposta segue o mesmo formato de GET /v4/api/envelopes/{envelopeId}.

Requisição

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢201Criado

application/json

Criado

Headers

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

🟠409

🟠422Erro de Parâmetro

🟠429

🔴503Serviço Indisponível

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/templates//envelopes' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "deadline": null,
    "folderId": "string",
    "participants": [
        {
            "templateParticipantId": "string",
            "name": "string",
            "email": "user@example.com",
            "phoneNumber": "string",
            "deliveryMethod": "EMAIL"
        }
    ],
    "send": false
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "message": "string",
    "status": "DRAFT",
    "deadline": "2019-08-24T14:15:22.123Z",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "folder": {
        "id": "string",
        "name": "string"
    },
    "sender": {
        "id": "string",
        "name": "string"
    }
}

Modificado em 2026-09-18 17:26:44

Página anterior

Consultar modelo