Skip to main content
POST
Criar envelope a partir de template
Cria um novo envelope usando um template como base. Você pode pré-preencher valores de campos, atribuir campos a signatários específicos e configurar signatários.

Parâmetros

string
required
UUID do template.
string
required
Título do envelope (ex: "Contrato do cliente ACME").
string
Código externo único (ex: "CONT-2025-ACME"). Deve ser único por projeto.
string
required
Data limite para assinatura (ISO 8601).
string
URL origem do seu app (para links em e-mails).
string
URL webhook para notificações de status.
array
required
Lista de signatários.
object
Atalho para pré-preencher campos: { key: value }. Locked (não editável por signatários).
array
Fine-grained field filling com controle de editabilidade.
array
Atribui campos de dados a signatários.
array
Atribui campos de assinatura a signatários.

Respostas

Retorna envelope criado (mesmo shape de POST /v1/envelopes):
string
UUID do envelope.
array
Signatários com sessionToken.

Erros

Veja Autenticação e erros.
  • 400: Campo desconhecido, valor inválido, campo obrigatório sem valor.
  • 401: API key inválido.
  • 404: Template não encontrado.
  • 409: externalCode duplicado.

Exemplo

Fluxo recomendado

  1. Criar template: POST /v1/templates
  2. Criar envelope: POST /v1/templates/:uuid/envelopes (pré-preenche valores)
  3. Signatário assina: POST /signature/envelope-sessions/:sessionToken/submit
  4. Obter assinado: GET /v1/sign/:sessionToken/signed-document

Relacionado