Remind (POST /v2.0/envelopes/{envelopeId}/remind_signer)
Send a reminder email to the signer to sign the envelope document.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envleopeId | GUID | Yes | Envelope ID |
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| String | Yes | SIgner's email |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | Reminder email sent |
Sample Success Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/22f11cdc-99f0-472c-ade3-3fbd57f0ef68/remind_signer' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{ "email": "[email protected]"
}'
RESPONSE:
{
"message": "Reminder email sent.",
"data": {
}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelope/7e802548-bdd2-4e30-9d0e-d888d20ddb61/remind_signer' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{ "email": "[email protected]"
}'
RESPONSE:
{
"errors": [
{
"error_code": "EMAIL_DOES_NOT_BELONG_TO_ENVELOPE", "
developer_message": "Given signer email does not belong to this envelope."
}
]
}
Note: View the full list of applicable error code for this method here.