Skip to main content
Este endpoint permite enviar envelopes baseados em templates criados previamente, com possibilidade de ajustar dados específicos do template. Não há criação isolada de envelopes; o envio é imediato.
cURL
curl -X POST "https://api.formsign.com.br/api/envelopes/send/template" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "tpl_abc123456789",
    "subject": "Contrato Personalizado",
    "fields": [
      {
        "type": "signature",
        "name": "Assinatura do Cliente",
        "identifier": "assinatura_cliente",
        "value": "",
        "required": true,
        "placeholder": "Assinatura do destinatário",
        "x": 246,
        "y": 291,
        "w": 269,
        "h": 74,
        "pageNumber": 1,
        "recipientRole": "signer"
      },
      {
        "type": "date",
        "name": "Data da Assinatura",
        "identifier": "data_assinatura",
        "value": "",
        "required": true,
        "x": 70,
        "y": 80,
        "w": 20,
        "h": 6,
        "pageNumber": 1,
        "recipientRole": "signer"
      }
    ],
    "recipients": [
      {
        "email": "[email protected]",
        "name": "João Silva",
        "signatureType": "draw",
        "role": "signer"
      }
    ]
  }'

​
Parâmetros (Body)

​
templateId
string
required
ID do template a ser usado como base.
​
subject
string
Sobrescrever o assunto do template.
​
message
string
Sobrescrever a mensagem do template.
​
recipients
array
Sobrescrever os destinatários do template.
​
observers
array
Adicionar observadores além dos do template.
​
fields
array
Sobrescrever os campos do template.
​
advancedOptions
object
Sobrescrever as opções avançadas do template.
​
base64Document
string
Sobrescrever o documento do template.
​
s3Key
string
Sobrescrever a chave S3 do template.
​
documentSettings
object
Sobrescrever as configurações do documento.

​
Lógica de Sobrescrita

  1. Prioridade de Documento: base64Document > s3Key (request) > s3Key (template)
  2. Campos Obrigatórios: Se não fornecidos no request, usa os do template
  3. Validação: Combinação final deve ter ao menos um destinatário, assunto e documento

​
Validações

  • Template Existente: O template deve existir e pertencer ao usuário
  • Documento Válido: Deve haver um documento (do template ou request)
  • Destinatários: Pelo menos um destinatário após aplicar sobrescritas
  • Assunto: Deve ter um assunto após aplicar sobrescritas

​
Respostas

{ 
  "message": "Success",
  "envelopeId": "env_abc123456789"
}
Base64 vs S3Key: Se fornecer base64Document, ele terá prioridade sobre qualquer s3Key do template ou request. O sistema fará upload automático para S3 e atualizará os metadados.