Download template

get/v1/template/download

Returns the PDF document for the specified templateId. When the template is created on behalf of a particular sender email, then the download operation can be performed on the same account by specifying the email in the onBehalfOf. The form fields can be includeded in the document by enabling true in includeFormFieldValues.

Code snippet

curl -X GET 'https://api.boldsign.com/v1/template/download?templateId=949ebf20-45a8-4a3e-91a9-68e9540e0020' \
-H 'accept: application/json' \
-H 'X-API-KEY: {your-api-key}'

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

var templateClient = new TemplateClient(apiClient);
var documentStream = templateClient.DownloadTemplate("YOUR_TEMPLATE_ID");

import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    template_api = boldsign.TemplateApi(api_client)
    template_api.download(template_id = "YOUR_TEMPLATE_ID")

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

use BoldSign\Configuration;
use BoldSign\Api\TemplateApi;

$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');

$template_api = new TemplateApi($config); 
$template_api->download($template_id = 'YOUR_TEMPLATE_ID');

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
            
TemplateApi templateApi = new TemplateApi(client);
templateApi.download("YOUR_TEMPLATE_ID", null);

import { TemplateApi } from "boldsign";

const templateApi = new TemplateApi();
templateApi.setApiKey("YOUR_API_KEY");

templateApi.download("YOUR_TEMPLATE_ID");

Query Parameters

templateIdstringRequired	The ID of the template to download.
onBehalfOfstring	The email address of the user that was used to create the template on their behalf.
includeFormFieldValuesboolean	This property specifies whether form field values should be included when downloading the template. If set to true, the downloaded template will contain the form field data; if set to false, the form fields will be excluded.

Example response

200 Success

Contains the PDF document