send_reminder_for_document_sign
Send reminder emails to signers for pending document signatures. Specify document ID and recipient emails to prompt completion of outstanding signature requests with optional custom messages.
Instructions
Send reminder emails to signers for pending document signatures. This API allows users to remind signers about outstanding signature requests by specifying the document ID and recipient email addresses. Multiple signers can receive reminders at once, and custom messages can be included. If sending reminders on behalf of another sender, specify the relevant sender email addresses.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | Required. The unique identifier (ID) of the document to send a reminder email to signers for pending signatures. | |
| message | No | Optional. Message to be sent in the reminder email. If not provided, the system will use a default reminder message. | |
| onBehalfOf | No | Optional. Email address of the sender when creating a document on their behalf. This email can be retrieved from the `behalfOf` property in the get document or list documents tool. | |
| receiverEmails | No | Optional. One or more signer email addresses to send reminders for pending signatures. If multiple signers are required to sign the document, specify their email addresses. If there is not emails provided, it will send reminder to all pending signers. The signers of a document can be obtained from the document-properties tool, using the documentId. |
Input Schema (JSON Schema)
{
"properties": {
"documentId": {
"description": "Required. The unique identifier (ID) of the document to send a reminder email to signers for pending signatures.",
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. Message to be sent in the reminder email. If not provided, the system will use a default reminder message."
},
"onBehalfOf": {
"anyOf": [
{
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. Email address of the sender when creating a document on their behalf. This email can be retrieved from the `behalfOf` property in the get document or list documents tool."
},
"receiverEmails": {
"anyOf": [
{
"items": {
"description": "Email address of the signer.",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Optional. One or more signer email addresses to send reminders for pending signatures. If multiple signers are required to sign the document, specify their email addresses. If there is not emails provided, it will send reminder to all pending signers. The signers of a document can be obtained from the document-properties tool, using the documentId."
}
},
"required": [
"documentId"
],
"type": "object"
}