Skip to main content
POST
Criar envelope rascunho
Inicia a criação de um envelope em etapas. Esta chamada cria o envelope no estado “Enviar arquivos”, armazenando apenas as configurações gerais. Ninguém é notificado ainda — o signatário é convidado apenas quando você chama POST .../send no fim do fluxo. Use esta abordagem quando quiser um assistente passo a passo na interface (upload, depois signatários, depois revisão). Para criar um envelope completo em uma única chamada, use POST /signer/v1/envelopes em vez deste. Autenticação: x-api-key no header. A solicitação também aceita Authorization: Bearer com headers de projeto/organização (x-project-id, x-organization-id).

Parâmetros

string
required
Título do envelope, ex.: "Contrato de Serviços 2025". Máximo 255 caracteres.
string
required
Data limite de assinatura (ISO 8601), ex.: "2025-12-31T23:59:59Z". Deve ser no futuro.
integer
Frequência de lembretes ao signatário (em horas). Mínimo 1, máximo 720 (30 dias). Padrão: 24.
enum
Modo de assinatura: sequential (fila, um após o outro) ou parallel (todos ao mesmo tempo). Padrão: parallel.

Respostas

string
UUID do envelope rascunho recém-criado. Use-o em chamadas subsequentes.
string
Título do envelope.
integer
ID numérico do estado (1 = “Enviar arquivos”). Útil para interfaces que precisam comparar sem strings com acentuação.
string
Nome do estado (legível).
string
Data limite.
integer
Frequência de lembretes.
string
Modo de assinatura escolhido.
string
Timestamp de criação (ISO 8601).

Erros

Veja Autenticação e erros.
  • 400: Título vazio, vencimento no passado/inválido, ou frequência de lembretes inválida.
  • 401: API key ou Bearer token inválido.

Exemplo

Fluxo do assistente

Após criar o rascunho, você está no passo 1 (“Enviar arquivos”):
  1. Passo 1 (Enviar arquivos): use POST .../:uuid/documents para anexar um ou mais PDFs. Depois chame POST .../:uuid/advance.
  2. Passo 2 (Inserir signatários): use PUT .../:uuid/signers para definir a lista de signatários. Depois chame advance de novo.
  3. Passo 3 (Conferência): mostre um resumo ao operador. Depois chame POST .../:uuid/send para enviar aos signatários.

Importante

  • Nenhum arquivo ou signatário ainda: o envelope nasce vazio. Adicione ambos nos passos seguintes.
  • Sem notificações: nem o operador nem os signatários recebem e-mail até o send.
  • Edição até o envio: você pode revisar e voltar usando PATCH .../:uuid/settings ou POST .../:uuid/back.

Próximas etapas

  1. Anexe documentos: POST .../:uuid/documents
  2. Defina signatários: PUT .../:uuid/signers
  3. Avance no fluxo: POST .../:uuid/advance
  4. Finalize enviando: POST .../:uuid/send

Relacionado