Actions12
- Document Actions
- Template Actions
- Webhook Actions
Document → Create From Template
AI-generatedOverview
This node operation creates a new document from a specified template in the SignWell platform. It is useful for automating the generation of documents that require signing, based on predefined templates. Users can specify recipients, template variables, pre-fill fields, and attachment requests to customize the document before sending it out for signing. For example, it can be used to create contracts, agreements, or forms that need to be signed by multiple parties.
Use Case Examples
- Creating a rental agreement document from a rental contract template, specifying tenants as recipients, and pre-filling rental dates.
- Generating an insurance claim form from a template, assigning roles to recipients, and requesting attachments like photos or receipts.
Properties
| Name | Meaning |
|---|---|
| Template ID | The ID of the template to create the document from, required to identify which template to use. |
| Draft | Boolean flag indicating whether to create the document as a draft, meaning it will not be sent for signing immediately. |
| Test Mode | Boolean flag indicating whether to create the document in test mode, useful for testing without actual sending. |
| Recipients | A collection of recipients who will receive the document for signing. Each recipient includes an ID, name, email, role (signer or viewer), and an optional placeholder name to assign them to specific placeholders in the template. |
| Template Variables | A JSON object of template variables to populate dynamic content in the document. |
| Template Fields | A collection of fields to pre-fill in the document, different from template variables. Each field includes a field ID and the value to pre-fill. |
| Attachment Requests | A collection of attachment requests that recipients must upload to complete or sign the document. Each request includes a name, recipient ID (must match a recipient), and a flag indicating if the attachment is required. |
Output
JSON
id- The unique identifier of the created document.status- The current status of the document (e.g., draft, sent, completed).recipients- Details of the recipients assigned to the document.template_id- The ID of the template used to create the document.created_at- Timestamp when the document was created.
Dependencies
- SignWell API
- An API key credential for authentication
Troubleshooting
- Ensure the Template ID is valid and accessible by the API key used.
- Verify that recipient IDs are unique and correctly assigned to placeholders if used.
- Check that required attachment requests have valid recipient IDs matching existing recipients.
- Common errors include authentication failures, invalid template or document IDs, and missing required fields. Verify API credentials and input parameters to resolve these.