Replace invite recipient
update_invite_recipientDestructive
Replace the current signer on a pending field invite with a new signer by providing the entity ID, current email, and new email. Supports both documents and document groups.
Instructions
Replace the signing recipient on a pending field invite for a document or document group. Finds the pending invite for the current signer and replaces it with a new signer. For documents: deletes the old invite, creates a replacement, and triggers sending. For document groups: updates the pending step(s) with the new signer information. Only field invites are supported — freeform and embedded invites cannot be updated.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | Yes | ID of the document or document group | |
| current_email | Yes | Email address of the current signer to replace | |
| new_email | Yes | Email address of the new signer | |
| 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. | |
| role | No | Role name to match (for multi-role documents). If omitted, matches any role. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | Yes | Document or document group ID | |
| entity_type | Yes | Entity type: 'document' or 'document_group' | |
| status | Yes | Result status: 'replaced' (invite recipient was replaced and resent), 'no_pending_invite' (no pending/created invite found for current_email), 'unsupported_invite_type' (freeform or embedded invites cannot be updated) | |
| new_invite_id | No | ID of the newly created invite (populated only when status is 'replaced') | |
| previous_email | Yes | Email address of the replaced signer | |
| new_email | Yes | Email address of the new signer | |
| updated_steps | No | List of step IDs that were updated (populated only for document_group with status 'replaced') |