Send signing reminder
send_invite_reminderSend a signing reminder to pending signers on a document or document group. Optionally target a specific recipient and customize the email subject and message.
Instructions
Send a signing reminder to pending signers on a document or document group.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | Yes | Document ID or document group ID | |
| entity_type | No | Entity type: 'document' or 'document_group'. Auto-detected if omitted (document_group tried first). Pass explicitly to avoid an extra auto-detection GET. | |
| No | Remind only this specific recipient. If omitted, all pending signers are reminded. | ||
| subject | No | Custom email subject for the reminder. | |
| message | No | Custom message body for the reminder. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | Yes | Document or document group ID | |
| entity_type | Yes | 'document' or 'document_group' | |
| recipients_reminded | No | Recipients who successfully received the reminder email | |
| skipped | No | Recipients skipped because their invite is not pending (completed, cancelled, etc.) | |
| failed | No | Recipients for whom the API call failed (transient error — may be retried) |