POST Create reminder with e-mail

Changed on

Este endpoint reenvia por e-mail a solicitação de assinatura para o contato original; não é necessário informar o endereço novamente. Informe a mensagem que será inserida no e-mail.

Só solicitações pendentes aceitam lembrete: chaves inexistentes ou de outra empresa, e solicitações assinadas, canceladas ou recusadas respondem 422. Solicitações enviadas originalmente por WhatsApp respondem 403.

Se o e-mail não puder ser entregue, a resposta continua 200, mas a mensagem avisa que o envio falhou.

post/api/reminders/email

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/reminders/email
  • Auth
    API key in header Authorization

Request body

signing_keystring required

Chave da solicitação que deve ser lembrada.

messagestring required

Mensagem para o signatário sobre a solicitação (obrigatória).

subjectstring

Assunto do e-mail. Padrão: "Lembrete de solicitação de {nome} {sobrenome}" do usuário do token.

emailstring

E-mail o qual o lembrete será enviado.

template_emailboolean

true envia o e-mail no template padrão da plataforma (com botão de assinatura e a mensagem embutida); false ou omitido envia a mensagem como corpo HTML (sanitizado).

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Lembrete enviado com sucesso."
}

Changes

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status