Send signing invite
send_inviteSend signing invites to any document, template, or group, handling both field and freeform recipients. Supports self-sign with direct signing link.
Instructions
Send invite to sign a document, document group, template, or template group. Supports both field invites (documents with roles/fields) and freeform invites (documents without fields). Document type is auto-detected — omit 'role' for freeform documents. For templates and template groups, automatically creates a document/group first, then sends the invite. Set self_sign=True (and omit orders) to sign the document yourself — the tool resolves the current user's email and populates SendInviteResponse.link with a direct signing link. The 'link' field is also populated when a freeform recipient's email matches the authenticated user's primary email. The entity's state may have changed in the SignNow editor since you last looked — re-read the current state first and build this request from the current roles/fields, not from earlier in the conversation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Optional name for the new document or document group (used only when entity_type is template or template_group) | |
| orders | No | List of orders with recipients (or a JSON string of the same). Required unless self_sign=True. When self_sign=True, omit orders — the tool fills in the current user as the sole recipient. | |
| entity_id | Yes | ID of the document, document group, template, or template group | |
| self_sign | No | If True, the tool resolves the current user's primary email server-side and sends a freeform invite to the user themselves. The response's 'link' field is populated with a direct signing link. Must be combined with an empty/omitted orders. Requires a field-less document or document group — for entities with fields/roles, use create_embedded_sending instead. | |
| entity_type | No | Type of entity: 'document', 'document_group', 'template', or 'template_group' (optional). Auto-detected if not provided. | |
| preview_was_shown | No | This flag signals that the user has viewed the document preview. Prompt the user to view the document before submitting. If the user says yes, call view_document first, show the result, then call send_invite again with preview_was_shown=True. If the user says no, call send_invite with preview_was_shown=False. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| link | No | Direct signing link. Populated only when the sender and recipient resolve to the same email (self_sign=True, or the recipient email equals the authenticated user's primary email). None for normal outbound invites. | |
| invite_id | Yes | ID of the created invite | |
| invite_entity | Yes | Type of invite entity: 'document' or 'document_group' | |
| created_entity_id | No | ID of the entity created from template (None when entity was document/document_group) | |
| created_entity_name | No | Name of the entity created from template (None when entity was document/document_group) | |
| created_entity_type | No | Type of created entity: 'document' or 'document_group' (None when entity was document/document_group) |