Create embedded request link from template


Unlike the document embedded request, the template embedded request process is synchronous, and your generated URL will be immediately accessible with documents and form fields already processed.

Generating the embedded request link is same as the regular template send, but with additional properties to customize the embedded process. For detailed information on the template API specific properties, please refer to the Template send section article.

Example request

curl --location --request POST '<template-id>' \
    --header 'X-API-KEY: <api-key>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "redirectUrl": "https://yourapp.example/redirect",
        "showToolbar": true,
        "sendViewOption": "FillingPage",
        "showSaveButton": true,
        "showSendButton": true,
        "locale": "EN",
        "showPreviewButton": true,
        "showNavigationButtons": true,
        "showTooltip": false,
        "roleRemovalIndices": [1, 2]

var apiClient = new ApiClient("", "Your-API-KEY");

var templateClient = new TemplateClient(apiClient);

// This is an example document id, add your own template id created from the web app upon usage.
var templateId = "0992eb79-ea24-4e95-887a-10aa82b30957";

var templateRequest = new EmbeddedTemplateRequest(
    templateId: templateId,
    title: "Document from Template",
    message: "This document description")
    // customize page options
    SendViewOption = PageViewOption.PreparePage,
    Locale = Locales.EN,
    ShowToolbar = true,
    ShowNavigationButtons = true,
    ShowSaveButton = true,
    ShowPreviewButton = true,
    ShowSendButton = true,
    ShowTooltip = false,
    RoleRemovalIndices = new [] {1, 2}

var documentCreated = await templateClient.CreateEmbeddedRequestUrlAsync(templateRequest);

// url to send the document from your web application
var sendUrl = documentCreated.SendUrl;
import requests
url = ""

payload={'Title': ' API template',
'Description': ' API template description',
'DocumentTitle': ' API document title',
'DocumentMessage': ' API document message description',
'AllowMessageEditing': ' true',
'Roles[0][name]': 'Manager',
'Roles[0][index]': '1',
'ShowToolbar': 'true',
'ShowSaveButton': 'true',
'ShowSendButton': 'true',
'ShowPreviewButton': 'true',
'Locale': 'EN',
'ShowNavigationButtons': 'true',
'ShowTooltip': 'false',
'SendViewOption': 'PreparePage',
'RoleRemovalIndices': [1, 2]}
  ('Files',('file',open('{file path}','rb'),'application/octet-stream'))
headers = {
  'X-API-KEY': '****YOUR-API-KEY****'

response = requests.request("POST", url, headers=headers, data=payload, files=files)
const axios = require('axios'); 
const response = await 

        'redirectUrl': ' https://yourapp.example/redirect', 
        'showToolbar': true, 
        'sendViewOption': 'FillingPage',
        'locale': 'EN',
        'showSaveButton': true, 
        'showSendButton': true, 
        'showPreviewButton': true, 
        'showNavigationButtons': true, 
        'showTooltip': false,
        'roles': [ 

                'roleIndex': 1, 
                'signerName': 'Signer Name 1', 
                'signerEmail': '', 
                'role': 'Manager' 
        'roleRemovalIndices': [1, 2]

        params: { 
            'templateId': '<template-id>' 

        headers: { 
            'X-API-KEY': '<api-key>', 
            'Content-Type': 'application/json' 

Example response

    "documentId": "625cff3d...",
    "sendUrl": ""