Skip to Content
DocumentationIntegrationDocuSignCreate Envelope from Template

Create Envelope from Template

Creates an envelope from a DocuSign template with dynamic recipient and field data. This is the most efficient way to send documents for signature - reuse template structure while providing dynamic values for each envelope.

Overview

  • Purpose: Create envelopes from pre-configured templates with dynamic recipient information and field values.
  • Use Cases: Employee onboarding, NDAs, sales proposals, vendor agreements, service contracts - any document that uses the same structure but different data.
  • API Method: POST /envelopes/from-template

Required Input Fields

Template ID: The unique identifier of the template to use. Get this from the ‘List Templates’ or ‘Get Template’ actions.

Recipients: Array of recipient objects, each containing email, name, and role name that must match a role defined in the template.

Recipient Configuration

  • Email: Recipient’s email address where they’ll receive the signing request.
  • Name: Full name of the recipient as it will appear in the document.
  • Role Name: Must exactly match a role name defined in the template (e.g., ‘Signer’, ‘Company Representative’, ‘Client’).
  • Tabs (Optional): JSON string containing field values to pre-fill in the document. Format: '{"textTabs":[{"tabLabel":"FieldName","value":"FieldValue"}]}'

Optional Input Fields

Email Subject: Override the template’s default email subject line with a custom subject.

Email Message: Add a custom message that will appear in the email sent to recipients.

Status: Set to ‘created’ to save as draft or ‘sent’ (default) to send immediately to recipients.

Pre-filling Document Fields (Tabs)

  • Text Tabs: Pre-fill text fields - '{"textTabs":[{"tabLabel":"CompanyName","value":"Acme Corp"}]}'
  • Multiple Fields: Include multiple tabs in the same JSON - '{"textTabs":[{"tabLabel":"Field1","value":"Value1"},{"tabLabel":"Field2","value":"Value2"}]}'
  • Tab Label Matching: The tabLabel must exactly match the field label defined in the template.
  • JSON Format: The tabs field must be a valid JSON string, not a JSON object.

Output

  • Envelope ID: Unique identifier for the created envelope, used for tracking and follow-up actions.
  • Status: Current status of the envelope (e.g., ‘sent’, ‘created’, ‘delivered’, ‘completed’).
  • Email Subject: The email subject line used for this envelope.
  • Created DateTime: ISO 8601 timestamp when the envelope was created.
  • Sent DateTime: ISO 8601 timestamp when the envelope was sent (if status is ‘sent’).
  • Status Changed DateTime: ISO 8601 timestamp of the last status change.

Workflow Pattern

  1. Step 1: Get template structure using ‘Get Template’ action (first-time setup only).
  2. Step 2: Identify required role names and field labels from the template.
  3. Step 3: Create envelope with dynamic recipient data and field values.
  4. Step 4: Track envelope status using the returned envelope ID.

Tips

[!TIP] Use ‘List Templates’ to discover available templates and their IDs

[!TIP] Role names in recipients must exactly match template role names (case-sensitive)

[!TIP] Pre-fill fields using the tabs parameter to save recipients time

[!TIP] Set status to ‘created’ to review the envelope before sending

[!TIP] Use ‘Get Template’ to see available fields and their labels before creating envelopes

[!TIP] Store template IDs in your application configuration for reuse

Need help? Have feedback?