POST Send request with template

Changed on Nov 3, 2026

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).

post/api/requests/templates

Request

Base URL
https://app.plugsign.com.br
URL
https://app.plugsign.com.br/api/requests/templates
Auth
API key in header Authorization

Request body

document_keystring required

A document_key do template que será enviado.

senderinteger

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

observerstring[]

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

silent_modeboolean

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

due_monthsinteger

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

auto_resendboolean

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

Response

200

messagestring

"Sua solicitação foi enviada com sucesso!" no envio normal ou "Sua solicitação foi criada com sucesso!" com silent_mode.

Example response

{
  "data": {
    "id": 1601469,
    "signing_key": "5BKLud7blQX2m3NFzhSBgca0S8KD7stu",
    "document": "LuJrWJ01duSEWxHsZoaZ1aU3rHf7QYOg",
    "email": "signatario@exemplo.com",
    "message": "Por favor, assine o contrato.",
    "signature_type": "Testemunha",
    "expire_date": "31/12/2026 23:59:59",
    "send_time": "13/10/2026 14:45:43",
    "update_time": "13/10/2026 14:45:43",
    "creted_at": "13/10/2026 14:45:43",
    "status": "Pending",
    "doubleauth": "1"
  },
  "message": "Sua solicitação foi enviada com sucesso!"
}

Changes

Nov 3, 20263db1513040ea Revision changes
- breaking
  the request property type changed from string to integer
- breaking
  the / response's property type changed from boolean to integer for status
- breaking
  the / response's property type changed from boolean to integer for status
- breaking
  the / response's property type changed from boolean to integer for status
- warning
  the // request property's maxLength was set to 500
- warning
  the // request property's maxLength was set to 255
- warning
  removed the request property //
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  added the new Cancelled enum value to the / response property for the response status
- warning
  added the new Declined enum value to the / response property for the response status
- warning
  added the new Pending enum value to the / response property for the response status
- warning
  added the new Signed enum value to the / response property for the response status
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  the request property default value all was added
- info
  added the new 3.00 enum value to the request property //
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status

Operation history