POST Send request with template

O envio de solicitação de assinatura com templates é mais simples do que o envio com documentos, uma vez que não é necessário definir os campos (pois já foram definidos no upload).

Porém, é importante se atentar a um ponto fundamental: o envio com templates é INDIVIDUAL. Portanto, se você passar 3 e-mails no array "emails", o sistema vai gerar 3 documentos únicos e enviar um para cada e-mail, de forma que cada signatário assinará um documento distinto.

Lembre-se também que o template original não será assinado. Em vez disso, serão assinadas as cópias geradas com base no modelo original.

Regras do envio por template:

  • Os campos de assinatura vêm do template (definidos no upload); recipients[].fields não é usado. Um template sem campos responde 422.
  • A API gera uma cópia do template para cada envio: o document da resposta é a document key da cópia.
  • sender aceita apenas o id numérico de um colaborador da sua empresa (e-mail responde 422; id inexistente, 404).
  • Sem recipients, a API usa o formato legado, em que email[] e message são obrigatórios.
  • due_months e auto_resend são aceitos, mas não têm efeito no momento. send_finished vale a partir do nível raiz para o primeiro destinatário.
  • As regras de certificado, carimbo de tempo, doubleauth_cpf e lembrete são as mesmas de POST /api/requests/documents.

Formatos da resposta: os mesmos de POST /api/requests/documents (envio normal, silent_mode e chain: false).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A document_key do template que será enviado.

integer

Id do colaborador que aparecerá como remetente (apenas id numérico; e-mail responde 422).

observer
array of strings

Os observadores irão receber comunicados referentes à situação da solicitação. Para isso, inclua uma lista de emails

observer
boolean

Quando ativado (True), o request não gera um e-mail para o cliente. Apenas o URL de assinatura e o e-mail serão retornados

int32

Validade do documento em meses. Aceito, mas não é gravado no momento (a solicitação fica com 0).

boolean

Aceito pela validação, mas sem efeito no momento.

recipients
array of objects

Destinatários. Sem este campo a API usa o formato legado (email[] e message obrigatórios).

recipients
Responses

500

document_key inexistente (erro interno atual)

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json