POST Cancel request

Changed on

Através deste endpoint é possível cancelar uma solicitação de assinatura. Caso o cancelamento seja realizado, o signatário não poderá mais responder à solicitação utilizando o link recebido por e-mail.

Além disso, se o documento não for público, o signatário também perderá o acesso à visualização.

Só solicitações pendentes podem ser canceladas. Uma signing_key inexistente ou de outra empresa responde 422; uma solicitação já assinada, cancelada ou recusada responde 403.

Ao cancelar, os observadores (observer) são notificados e, se os demais signatários já assinaram e não há pendentes, o documento finalizado é enviado a quem pediu send_finished.

post/api/requests/cancelled

Request

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

Request body

signing_keystring required

A chave única da solicitação de assinatura que deverá ser cancelada.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Request Cancelled"
}

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status