Create embedded signing invite
create_embedded_inviteDestructive
Create embedded signing invites for documents or templates. Automatically generates a document from a template before creating the invite with customized recipient orders.
Instructions
Create embedded invite for signing a document, document group, template, or template group. For templates and template groups, automatically creates a document/group first, then creates the embedded invite. 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
TableJSON 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 | Yes | List of orders with recipients (or a JSON string of the same). | |
| entity_id | Yes | ID of the document, document group, template, or template group | |
| entity_type | No | Type of entity: 'document', 'document_group', 'template', or 'template_group' (optional). Auto-detected if not provided. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invite_entity | Yes | Type of invite entity: 'document' or 'document_group' | |
| recipient_links | Yes | Array of objects with role, invite id (for document invite) and link for recipients with delivery_type='link' | |
| 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) | |
| document_group_invite_id | No | ID of the created document group embedded invite; populated only when invite_entity is 'document_group', otherwise None |