Enviar Lembrete
Reenvia o link de assinatura. Há duas opções: lembrete por e-mail para todos os signatários que ainda não finalizaram, ou mensagem de WhatsApp para um signatário específico.
Lembrete por E-mail (todos os pendentes)
Endpoint
POST /v1/envelopes/{id}/remind
Headers
| Header | Valor |
|---|---|
| Authorization | Bearer {token} |
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do envelope |
Exemplo de Requisição
curl -X POST https://api.tapsign.com.br/v1/envelopes/1523/remind \
-H "Authorization: Bearer {token}"
Resposta de Sucesso
Status: 200 OK
{
"message": "Lembretes enviados com sucesso"
}
Todos os signatários que ainda não assinaram nem recusaram (status PENDING, NOTIFIED ou VIEWED) recebem um e-mail com o link https://tapsign.com.br/signing/{accessToken}. Quem está SIGNED ou DECLINED não recebe.
A API não confere o status do envelope nem limita a quantidade de lembretes por envelope. Envie lembretes apenas para envelopes já enviados e ainda em andamento, e evite repetições para não incomodar os signatários. As chamadas contam no rate limit da sua chave.
Erros
| Código | Quando acontece |
|---|---|
401 | Chave de API ou token ausente ou inválido |
404 | Envelope inexistente ou de outro usuário |
Lembrete via WhatsApp (signatário individual)
Envia ao signatário uma mensagem de WhatsApp com o link de assinatura. O signatário precisa ter o campo phone preenchido.
Endpoint
POST /v1/envelopes/{id}/signers/{signerId}/whatsapp
Headers
| Header | Valor |
|---|---|
| Authorization | Bearer {token} |
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | ID do envelope |
signerId | integer | Sim | ID do signatário |
Exemplo de Requisição
curl -X POST https://api.tapsign.com.br/v1/envelopes/1523/signers/4821/whatsapp \
-H "Authorization: Bearer {token}"
Resposta de Sucesso
Status: 200 OK
{
"message": "Mensagem WhatsApp enviada com sucesso"
}
O 200 indica que a API processou o pedido, não que a mensagem chegou: se o envio pelo WhatsApp falhar, a resposta continua sendo 200. Para acompanhar, consulte whatsappLastStatus, whatsappLastErrorCode e whatsappOwnerMessage do signatário em Detalhar Documento. Esses campos são atualizados conforme os avisos de status do WhatsApp.
A API também não confere o status do signatário nem do envelope antes de enviar.
Erros
| Código | Quando acontece |
|---|---|
400 | O signatário não tem telefone cadastrado ou não pertence ao envelope informado. Nesses casos o corpo de erro traz uma mensagem genérica de validação |
401 | Chave de API ou token ausente ou inválido |
404 | Envelope inexistente ou de outro usuário, ou signatário inexistente |
O formato do corpo de erro está em Status de Erros.