Embedded cloned template

The embedded cloned template link allows users to prepare the cloned templates on your website or mobile app using an iFrame, popup window, or a new tab.

Clone Template

The Clone Template API allows users to clone the existing template into new template. The form fields can be includeded in the template by enabling true in WithFormFieldValues.This API also create embedded link for that newly cloned template.

Get embedded cloned template link

post/v1/template/cloneTemplate

The get embedded cloned template link has additional properties to customize the embedded process.

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/template/cloneTemplate?templateId=be5cbb00-xxxx-xxxx-xxxx-bafa580exxxx' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API Key}' \
  -H 'Content-Type: multipart/form-data' \ 
  -F 'ViewOption=PreparePage' \
  -F 'ShowSaveButton=true' \
  -F 'ShowCreateButton=true' \
  -F 'ShowPreviewButton=true' \
  -F 'ShowNavigationButtons=true' \
  -F 'EmbeddedSendLinkValidTill=DateTime.Now.AddDays(1)' \
  -F 'WithFormFieldValues=true' \
  -F 'Locale=EN' \
  -F 'ShowToolbar=false' \
  -F 'ShowTooltip=false' \

var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");

var templateClient = new TemplateClient(apiClient);

var embeddedCloneTemplateRequest = new EmbeddedCloneTemplateRequest()
{
    TemplateId = "YOUR_TEMPLATE_ID",
    ViewOption = PageViewOption.PreparePage,
    ShowSaveButton = true,
    ShowPreviewButton = true,
    ShowNavigationButtons = true,
    EmbeddedSendLinkValidTill = DateTime.Now.AddDays(1),
    WithFormFieldValues = true,
    Locale = Locales.EN,
    ShowCreateButton = true,
    ShowToolbar = false,
    ShowTooltip = false,
};

var embeddedClonedTemplate = templateClient.GetEmbeddedClonedTemplateUrl(embeddedCloneTemplateRequest);

var templateEmbedUrl = embeddedClonedTemplate.embedUrl;

import boldsign

configuration = boldsign.Configuration(host="https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    template_api = boldsign.TemplateApi(api_client)
	
    embedded_clone_template_request = boldsign.EmbeddedCloneTemplateRequest(
        ViewOption = "PreparePage",
        ShowSaveButton = true,
        ShowPreviewButton = true,
        ShowNavigationButtons = true,
        WithFormFieldValues = true,
        Locale = "EN",
        ShowCreateButton = true,
        ShowToolbar = false,
        ShowTooltip = false)
           
    embedded_cloned_template = template_api.get_embedded_cloned_template_url(template_id= "YOUR_TEMPLATE_ID", embedded_cloned_template_request=embedded_cloned_template_request)

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\TemplateApi;
use BoldSign\Model\EmbeddedCloneTemplateRequest;

$config = new Configuration();
$config->setHost('https://api.boldsign.com');
$config->setApiKey('YOUR_API_KEY');

$template_api = new TemplateApi($config);

$embedded_clone_template_request = new EmbeddedCloneTemplateRequest();
$embedded_clone_template_request->setShowToolbar(true);
$embedded_clone_template_request->setShowTooltip(true);
$embedded_clone_template_request->setShowSaveButton(true);
$embedded_clone_template_request->setShowPreviewButton(false);
$embedded_clone_template_request->setViewOption('PreparePage');
$embedded_clone_template_request->setWithFormFieldValues(true);
$embedded_clone_template_request->setShowNavigationButtons(true);

$embedded_cloned_template = $template_api->getEmbeddedClonedTemplateUrl($template_id = 'YOUR_TEMPLATE_ID', $embedded_clone_template_request);

ApiClient client = Configuration.getDefaultApiClient();  
client.setBasePath("https://api.boldsign.com");
client.setApiKey("YOUR_API_KEY");
            
TemplateApi templateApi = new TemplateApi(client);

EmbeddedCloneTemplateRequest embeddedCloneTemplateRequest = new EmbeddedCloneTemplateRequest();
embeddedCloneTemplateRequest.setShowToolbar(true);
embeddedCloneTemplateRequest.setShowTooltip(true);
embeddedCloneTemplateRequest.setShowSaveButton(true);
embeddedCloneTemplateRequest.setShowPreviewButton(false);
embeddedCloneTemplateRequest.setViewOption(embeddedCloneTemplateRequest.ViewOptionEnum.PREPARE_PAGE);
embeddedCloneTemplateRequest.setWithFormFieldValues(true);
embeddedCloneTemplateRequest.setShowNavigationButtons(true);

EmbeddedClonedTemplate embeddedClonedTemplate = templateApi.getEmbeddedClonedTemplateUrl("YOUR_TEMPLATE_ID", embeddedCloneTemplateRequest);

import { TemplateApi, EmbeddedCloneTemplateRequest } from "boldsign";

const baseUrl:string = "https://api.boldsign.com";
const templateApi = new TemplateApi(baseUrl);
templateApi.setApiKey("YOUR_API_KEY");

const embeddedCloneTemplateRequest = new EmbeddedCloneTemplateRequest();
embeddedCloneTemplateRequest.showToolbar = true;
embeddedCloneTemplateRequest.showTooltip = true;
embeddedCloneTemplateRequest.showSaveButton = true;
embeddedCloneTemplateRequest.showPreviewButton = false;
embeddedCloneTemplateRequest.viewOption = embeddedCloneTemplateRequest.ViewOptionEnum.PreparePage;
embeddedCloneTemplateRequest.withFormFieldValues = true;
embeddedCloneTemplateRequest.showNavigationButtons = true;

const embeddedClonedTemplate = templateApi.getEmbeddedClonedTemplateUrl("YOUR_TEMPLATE_ID", embeddedCloneTemplateRequest);

Query parameters

templateIdstringRequired

The ID of the template to clone.

Request body

RedirectURLstring	The redirect URI is to be redirected after the clone template process is completed. The string should be in URI format.
ViewOptionstring	Configures the initial view page to be loaded from the generated URL. The FillingPage is used to customize roles, enforce authentication etc. The PreparePage is used to configure form fields for the roles. Either PreparePage or FillingPage. Defaults to PreparePage.
ShowSaveButtonboolean	Controls the visibility of the `Save and Close` button from the `More Action` drop down menu. Set to false if you don't want your users to save the template. Defaults to true.
ShowCreateButtonboolean	Controls the visibility of the `Save template` button at the top right corner of the page. Set to false if you don't want your users to save the template. Defaults to true.
ShowPreviewButtonboolean	Controls the visibility of the `Preview` button from the `More Action` drown down menu. Set to false if you don't want your users to preview the template before finalizing it. Defaults to true.
ShowNavigationButtonsboolean	Controls the visibility of the `Back` button. Set to false if you don't want your users to navigate away from the current page. Defaults to true.
EmbeddedSendLinkValidTillstring	Configures the expiration for the generated URL. A maximum of 180 days can be assigned. The string should be in date-time format.
WithFormFieldValuesboolean	This property specifies whether form field values should be included when cloning the template. If set to true, the cloned template will contain the form field data; if set to false, the form fields will be excluded.
Localestring	By default, while opening the embedded cloned template link, all the static contents available in the page will be loaded in the English language. This property is used to load the contents with different languages. The supported languages are EN(English), FR(French), NO(Norwegian), DE(German), ES(Spanish), BG(Bulgarian), CS(Czech), DA(Danish), IT(Italian), NL(Dutch), PL(Polish), PT(Portuguese), RO(Romanian), RU(Russian), and SV(Swedish)
ShowToolbarboolean	Controls the visibility of the toolbar at the top of the document editor. Defaults to false.
ShowTooltipboolean	To control the visibility of the `Tooltip` near the assignee field on the prepare page, set it to "true" if you want to show the tooltip to the user. Defaults to false.
OnBehalfOfstring	The email address of the user that was used to create the template on their behalf.

Example response

{
    "templateId": "7a18c3y10...",
    "embedUrl": "https://app.boldsign.com/document/embed/?templateId=7a18c3y10..."
}