Advantages of Edit embedded template over Edit Template
In BoldSign, both Edit Template and Edit Embedded Template allow you to modify existing eSignature templates, but they serve different purposes and offer unique benefits:
1. Edit Template – Backend automation
This method is used to update the original template stored in BoldSign through backend API calls. Any changes made will apply to all future documents created from the template.
-
Purpose: Update the original template stored in BoldSign for organization-wide use
-
API Endpoint:
PUT /v1/template/edit -
Impact: Changes affect all workflows using this template
-
User Experience: No UI interaction
-
Use Case:
- Updating company-wide contract terms
- Adding new compliance fields to all agreements
-
Form Field Configuration:
- Fields are modified globally
- Requires careful governance to avoid unintended changes
Here is an example .NET script for the edit template API
2. Edit Embedded Template – Contextual Customization
This method allows users to edit templates interactively within your application using BoldSign’s embedded editor. Once saved, the changes are applied globally to the original template and affect all future documents created from it.
-
Purpose: Allow users to edit a template interactively within your application using BoldSign’s embedded UI
-
API Endpoint:
POST /v1/template/getEmbeddedTemplateEditUrl -
Impact: Changes are applied globally to the original template once saved
-
User Experience: UI embedded via iframe, popup, or new tab
-
Use Case:
-
HR managers visually editing offer letter templates within an internal portal.
-
Real estate agents customizing property agreement templates and saving updates for future use
-
-
Form Field Configuration:
- Drag-and-drop fields like signature boxes, text inputs, and checkboxes
- No coding required—visual customization by the user
| Feature | Edit Template API (Backend Automation) | Edit Embedded Template API (Contextual Customization) |
|---|---|---|
| Purpose | Update the original template for organization-wide use | Customize and edit template interactively via embedded UI |
| Impact | Changes apply to all future documents from the template | Changes apply globally once saved |
| User Experience | No UI interaction; backend API calls only | Interactive UI via iFrame, pop-up, or new tab |
| API Endpoint | PUT /v1/template/edit |
POST /v1/template/getEmbeddedTemplateEditUrl |
| Form Field Configuration | Modified globally via backend calls; updates must be managed carefully | Modified globally once saved; drag‑and‑drop customization; updates must be managed carefully |
| File Management | Not supported | Files can be replaced, removed, or added |
| Save & Proceed Option | Not available | Available during filling stage for staged completion |
| Recipient & Role Management | Via API calls | Visual management in embedded editor |
| Preview & Save | No preview; changes applied directly | Preview, save, and reopen before finalizing |
| Flexibility in Workflow | Best for backend automation and standardization | Best for real-time edits and client-specific adjustments |
| Error Handling | Requires parsing API responses programmatically | Immediate visual feedback and correction in UI |
| Branding Options | Single brand value via API | Supports listing and applying multiple brand values visually |
| Advantages | Streamlined backend updates Ideal for enterprise automation |
Interactive editing Live previews Client-facing customization |
| Best Suited For | Internal systems, large-scale automation workflows | SaaS platforms, dynamic changes, client-specific workflows |
Advantages of Edit Embedded Template
-
Interactive, user-friendly editing experience
-
Live preview before saving changes
-
Client-facing customization with less coding
-
Visual role and recipient management
-
Flexible branding selection
Which Should You Choose?
-
Choose Edit Template API if you need backend-driven updates with strict organization-wide consistency.
-
Choose Edit Embedded Template API if you need flexibility, visual editing, and client-facing customization—keeping in mind that saved changes update the global template.