POST Create lote request reminder

Changed on

Este endpoint reenvia a solicitação do lote request para o contato usado no envio original. Quando o contato é um e-mail, o lembrete sai por e-mail; quando é um telefone, sai por WhatsApp (informe phone).

Só solicitações pendentes aceitam lembrete: chaves inexistentes ou de outra empresa, e solicitações já assinadas, canceladas ou recusadas respondem 422 com a mensagem correspondente.

post/api/lotes/requests/reminder

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/lotes/requests/reminder
  • Auth
    API key in header Authorization

Request body

signing_keystring required

Signing key do lote request.

messagestring required

Mensagem que deve ser enviada no e-mail para o usuário.

subjectstring

Assunto do e-mail enviado, caso não preencha vai enviar com o assunto padrão.

phonestring

Número com WhatsApp (DDD + 9 + número, só dígitos) usado quando o contato da solicitação é um telefone; o lembrete sai por WhatsApp em vez de e-mail.

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