PUT Change Lote request signer

Changed on

Este endpoint permite alterar o signatário de uma solicitação de lote. Além de alterar o signatário, é enviado um e-mail/whatsapp e gerada uma nova signing_key.

put/api/lotes/requests/change-signer

Request

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

Request body

signing_keystring required

Signing key do lote request.

contactstring required

E-mail válido ou número de WhatsApp apenas com dígitos (DDD + 9 + número). Outros formatos respondem 422.

messagestring required

Mensagem enviada ao novo signatário (1 a 255 caracteres).

Response

200

messagestring

Mensagem de confirmação retornada pela API.

new_signing_keystring

Nova chave única utilizada para identificar a solicitação.

notification_sentboolean

Indica se foi possível confirmar o envio da notificação ao novo signatário.

Example response

{
  "message": "Signatário alterado com sucesso!",
  "new_signing_key": "P66Oes1cUQ4pqwaFDBJQyW0PUiZKor6V"
}

Changes

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • warning

      deleted the query request parameter contact

    • warning

      deleted the query request parameter message

    • warning

      deleted the query request parameter signing_key

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status