Cancel (POST /v2.0/envelopes/{envelopeId}/cancel)
The document creator can cancel the envelope with a reason.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envelopeId | GUID | Yes | Envelope ID |
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| cancel_reason | String | Yes | Reason for cancel |
| envelope_latitude | Decimal | No | User's location latitude |
| envelope_longitude | Decimal | No | User's location longitude |
| user_agent | String | No | User Agent |
| user_ip_address | String | No | User's IP address |
| user_mac_address | String | No | User's MAC address |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | Envelope cancelled successfully |
Sample Success Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/fdc6c3b7-43d3-40f2-8c6c-ad15f5ad84c5/cancel' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \ --header 'Content-Type: application/json' \
--data-raw '{ "cancel_reason": "There is some mistake in this document."
}'
RESPONSE:
{
"message": "Envelope cancelled successfully.",
"data": {}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/6485443b-913f-4d6a-8876-ddf9a6d2156c/cancel' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9[...]\
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{ "cancel_reason": "" }'
RESPONSE:
{
"errors": [
{
"error_code": "ENVELOPE_CANCEL_REASON_REQUIRED", "
developer_message": "Cancellation reason is required."
}
]
}
Note: View the full list of applicable error code for this method here.