Decline (POST /v2.0/envelopes/{envelopeId}/decline)
The signer can decline to sign the envelope with a valid 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 |
|---|---|---|---|
| decline_reason | String | Yes | Reason for the decline |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | Envelope declined successfully |
Sample Success Response
REQUEST:
REQUEST: curl --location --request POST '/api/v2.0/envelopes/43d43ad9-45b6-4876-9da4-b589a86922a8/decline' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{ "decline_reason": "I do not agree with the terms"
}'
RESPONSE:
{
"message": Envelope declined successfully!",
"data": {
}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/43d43ad9-45b6-4876-9da4-b589a86922a8/decline' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \ --header 'Content-Type: application/json' \
--data-raw '{ "decline_reason": "I do not agree with the terms"
}'
RESPONSE:
{
"errors": [
{
"error_code": "ENVELOPE_CREATOR_CANNOT_DECLINE", "
developer_message": "Envelope creator can not decline the envelope."
}
]
}
Note: View the full list of applicable error code for this method here.