Cancel signing invite
cancel_inviteDestructiveIdempotent
Cancel all active pending signing invites on a document or document group. Provide the entity ID and an optional reason for cancellation.
Instructions
Cancel all active (pending) signing invites on a document or document group. The entity's state may have changed in the SignNow editor since you last looked — re-read the current state first to confirm the current invite state, not what you saw earlier in the conversation.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | Optional reason for cancellation | |
| entity_id | Yes | ID of the document or document group | |
| entity_type | No | Type of entity: 'document' or 'document_group' (optional). Auto-detected if not provided (tries document_group first). Pass explicitly to save one API call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Result status: 'cancelled' (invites were cancelled), 'invite_not_sent' (no active invite found), 'completed' (all signers already completed) | |
| entity_id | Yes | Document or document group ID | |
| entity_type | Yes | Entity type: 'document' or 'document_group' | |
| cancelled_invite_ids | No | List of cancelled invite IDs (empty when status is not 'cancelled') | |
| cancelled_invite_type | No | Type of cancelled invites: 'field', 'freeform', or 'embedded' (populated only when status is 'cancelled') |