Cancel Envelope

POST /esignglobal/v1/envelope/cancel

Interface Description

Cancel an envelope that has not been fully signed (at least one signer has not completed signing). After cancellation, the envelope will be suspended, and all signatures within it will be rendered invalid.

Request Parameters

Parameter	Type	Required	Description
envelopeId	string	true	Envelope ID
reason	string	true	Reason for cancelation

Request Example

{
	"envelopeId":"flow1234567890",
	"reason":"Signer's information was wrong."
}

Responses

Parameter

Type

Description

canceledEnvelopeId

string

Revoked envelope ID

canceledEnvelopeStatus

int

Envelope Status

0-Draft

1-In Progress

2-Completed

3-Expired

5-Canceled

Response Example

{
  "code": 0,
    "message": "success",
    "data": {
    " canceledEnvelopeId ":"flow1234567890",
      " canceledEnvelopeStatus ":5
  }
}