Skip to main content
Este endpoint permite cancelar um envelope que foi enviado, impedindo que destinatários façam novas assinaturas. O cancelamento é irreversível.
cURL
curl -X POST "https://api.formsign.com.br/api/envelopes/void" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "envelopeId": "env_abc123456789",
    "justificativa": "Cliente informou que desistiu da compra do imóvel. Cancelamento solicitado via telefone em 15/08/2024 às 14:30h por João Silva (CPF: 123.456.789-00)."
  }'

​
Parâmetros (Body)

​
envelopeId
string
required
ID do envelope a ser cancelado.
​
justificativa
string
required
Motivo do cancelamento (para auditoria).

​
Como Funciona

  1. Validação: Verifica se o envelope existe e pertence ao usuário
  2. Status Check: Confirma se o envelope pode ser cancelado
  3. Cancelamento: Altera status para voided e invalida todos os links
  4. Notificação: Envia emails informando o cancelamento aos destinatários
  5. Log: Registra o cancelamento no histórico com a justificativa

​
Quando Usar

  • Erro no documento ou dados enviados
  • Cliente desistiu do processo
  • Necessidade de enviar nova versão
  • Problemas legais ou contratuais
  • Envelope enviado por engano

​
Regras de Cancelamento

  • Status Válidos: Apenas envelopes com status sent
  • Irreversível: Cancelamento não pode ser desfeito
  • Justificativa Obrigatória: Para fins de auditoria e compliance
  • Notificação Automática: Destinatários são informados por email

​
Status Válidos para Cancelamento

StatusPode Cancelar?Motivo
sent✅Status normal para cancelamento
draft❌Use exclusão ao invés de cancelamento
completed❌Envelope já foi concluído
voided❌Envelope já está cancelado
expired❌Envelope já expirou naturalmente

​
Respostas

{
  "message": "Envelope cancelado com sucesso",
  "envelopeId": "env_abc123456789"
}

​
Campos da Response

​
message
string
Mensagem de confirmação do cancelamento.
​
envelopeId
string
ID do envelope cancelado.

​
Efeitos do Cancelamento

  1. Status: Envelope alterado para voided
  2. Links: Todos os links de assinatura são invalidados
  3. Emails: Destinatários recebem notificação de cancelamento
  4. Histórico: Ação registrada com timestamp e justificativa
  5. Dashboard: Envelope aparece na lista com status cancelado
Ação Irreversível: O cancelamento não pode ser desfeito. Se precisar reenviar, será necessário criar um novo envelope.
Justificativa Clara: Use justificativas descritivas para facilitar auditoria futura. Ex: “Erro na versão do documento”, “Cliente solicitou alteração no prazo”.