Cancelamento de Envelope

O cancelamento de um envelope só é possível para envelopes que ainda não foram assinados e estejam no status Pendente.

POST https://signhom.acesso.io/api/v1/service/cancel

Headers

Name	Type	Description
Authorization*	string	Token de acesso adquirido pela plataforma Identity (bearer)

Request Body

Name	Type	Description
UserName*	string	Nome de quem executou o cancelamento
Reason*	string	Motivo do cancelamento do envelope
EnvelopeUUID*	string	UUID do envelope

200 Documento cancelado com sucesso

{
    "Success": true,
    "Message": "Envelope cancelado com sucesso",
    "Data": null
}

401 O Token está expirado ou sem permissão.

500 Quando algo estiver incorreto, o detalhe do problema será retornado no campo Message.

{
    "Success": false,
    "Message": "Falha ao cancelar o envelope.",
    "Data": "Envelope não existe."
}

400: Bad Request Quando alguma propriedade estiver incorreta, onde será retornado um json contendo o campo e o erro de validação.

{
	"errors":
	[
		{"key": "NomeCampo1", "message": "Problema da validação"},
		{"key": "NomeCampo2", "message": "Problema da validação"},
	]
}

Exemplo de Requisição

{
    "EnvelopeUUID" : "x11x111x-x11x-1111-11x1-11x111x1xx1x",
    "Reason" : "O motivo do cancelamento",
    "UserName": "Nome do Usuário"
}