POST Cancel lote request

Changed on

Através deste endpoint é possível cancelar uma solicitação de lote request. Após o cancelamento, o signatário não consegue mais responder pelo link recebido.

Solicitações com status Pending são canceladas. Uma solicitação já Cancelled responde 200 novamente (a operação é idempotente). Solicitações Signed ou Declined respondem 403.

O cancelamento registra o histórico nos documentos do lote e, quando a empresa tem webhook do tipo REQUESTS_UPDATED cadastrado, dispara a notificação com lote_id no payload.

post/api/lotes/requests/cancelled

Request

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

Request body

signing_keystring required

Signing key do lote request a ser cancelado.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Lote request cancelado."
}

Changes