Pular para o conteúdo principal

Enviar Lembrete

Envia um lembrete para todos os signatarios pendentes de um envelope. Tambem e possivel enviar um lembrete individual via WhatsApp para um signatario especifico.

Lembrete por Email (todos os pendentes)

Endpoint

POST /v1/envelopes/{id}/remind

Headers

HeaderValor
AuthorizationBearer {token}

Parametros de URL

ParametroTipoObrigatorioDescricao
idstring (UUID)SimID do envelope

Exemplo de Requisicao

curl -X POST https://api.tapsign.com.br/v1/envelopes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/remind \
-H "Authorization: Bearer {token}"

Resposta de Sucesso

Status: 200 OK

{
"message": "Lembrete enviado com sucesso",
"remindedSigners": [
{
"id": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
"name": "Joao da Silva",
"email": "joao@empresa.com.br",
"status": "PENDING"
},
{
"id": "a9b8c7d6-e5f4-3210-9876-543210fedcba",
"name": "Ana Costa",
"email": "ana@empresa.com.br",
"status": "VIEWED"
}
],
"totalReminded": 2
}
Quem recebe o lembrete?

O lembrete e enviado apenas para signatarios com status PENDING ou VIEWED. Signatarios que ja assinaram (SIGNED) ou recusaram (DECLINED) nao recebem lembrete.

Erros

CodigoDescricao
404Envelope nao encontrado
409Envelope nao esta no status SENT -- lembretes so funcionam para envelopes enviados
429Limite de lembretes excedido (maximo 3 por dia por envelope)
Limite de lembretes

Para evitar spam, o TapSign limita o envio de lembretes a 3 vezes por dia por envelope. Apos atingir o limite, aguarde 24 horas para enviar novamente.


Lembrete via WhatsApp (signatario individual)

Envia um lembrete via WhatsApp para um signatario especifico. O signatario deve ter o campo phone preenchido.

Endpoint

POST /v1/envelopes/{id}/signers/{signerId}/whatsapp

Headers

HeaderValor
AuthorizationBearer {token}

Parametros de URL

ParametroTipoObrigatorioDescricao
idstring (UUID)SimID do envelope
signerIdstring (UUID)SimID do signatario

Exemplo de Requisicao

curl -X POST https://api.tapsign.com.br/v1/envelopes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/signers/f7e6d5c4-b3a2-1098-7654-321fedcba098/whatsapp \
-H "Authorization: Bearer {token}"

Resposta de Sucesso

Status: 200 OK

{
"message": "Lembrete via WhatsApp enviado com sucesso",
"signer": {
"id": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
"name": "Joao da Silva",
"phone": "+5511999999999"
},
"sentAt": "2026-03-29T14:30:00Z"
}

Erros

CodigoDescricao
400Signatario nao possui telefone cadastrado
404Envelope ou signatario nao encontrado
409Signatario ja assinou ou recusou
429Limite de mensagens WhatsApp excedido
Dica

O envio via WhatsApp consome creditos do seu plano. Verifique seu saldo de mensagens no painel do TapSign antes de usar esta funcionalidade em larga escala.