Cancel (POST /v2.0/envelopes/{envelopeId}/delete)
This method deletes all physical documents within an envelope, including signed and unsigned copies of documents and all supporting documents. Only signed envelopes may be deleted.
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 |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | Envelope deleted successfully |
Sample Success Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/{{envelopeID}}/delete' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9[...]' \
--header 'app_auth_type: jsign-oauth2' \ --header 'Content-Type: application/json' \
}'
RESPONSE:
{
"message": "Envelope deleted successfully.",
"data": {}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/{{envelopeId}}/delete' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9[...]'\
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
RESPONSE:
{
"errors": [
{
"error_code": "SYSTEM_ERROR",
developer_message": "The server encountered unhandled error."
}
]
}
Note: View the full list of applicable error code for this method here.