This commit is contained in:
github-actions[bot]
2026-03-02 08:26:20 +00:00
parent 1d470dd8b7
commit fd65067ea4
172 changed files with 239 additions and 243 deletions
@@ -5,7 +5,7 @@
<meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Create Document from Template | OpenSign™</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" name="twitter:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" property="og:url" content="https://docs.opensignlabs.com/docs/API-docs/v1.1/createdocumentwithtemplateid"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Create Document from Template | OpenSign™"><meta data-rh="true" name="description" content="The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API."><meta data-rh="true" property="og:description" content="The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/createdocumentwithtemplateid"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/createdocumentwithtemplateid" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.1/createdocumentwithtemplateid" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"v1.1","item":"https://docs.opensignlabs.com/docs/API-docs/v1.1"},{"@type":"ListItem","position":2,"name":"Create Document from Template","item":"https://docs.opensignlabs.com/docs/API-docs/v1.1/createdocumentwithtemplateid"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenSign™ RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenSign™ Atom Feed"><link rel="stylesheet" href="/assets/css/styles.03fa8acf.css">
<script src="/assets/js/runtime~main.8bbf5201.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9e610c3a.js" defer="defer"></script>
<script src="/assets/js/main.62d29b20.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@@ -17,26 +17,27 @@
<p>The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at <a href="https://app.opensignlabs.com/debugpdf" target="_blank" rel="noopener noreferrer" class=""><strong>Debug UI</strong></a> or using the Create Template API.</p>
<p>You can provide default value for all widgets based on their name all widgets support except signature, stamp, initials, image.</p>
<p><strong>hide_text_with_asterisks:</strong> When enabled, the text on the signed document is hidden from recipients using asterisks, but remains fully visible to the document owner in their OpenSign account. This option is available only on Teams and Enterprise plans.</p>
<p><strong>hint:</strong> Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown.</p>
<ol>
<li class=""><strong>email</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;email&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;email@example.com&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;email&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;email@example.com&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;Provide email&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ol start="2">
<li class=""><strong>name</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;name&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;joe&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;name&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;joe&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;Provide name&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ol start="3">
<li class=""><strong>job Title</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;job title&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;ceo&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;job title&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;ceo&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;Provide job title&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ol start="4">
<li class=""><strong>company</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;company&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;example pvt ltd&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;company&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;example pvt ltd&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;Provide company&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ol start="5">
<li class=""><strong>date</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;date&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;11-05-2025&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;min_date&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;max_date&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signing_date&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;date&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;11-05-2025&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;min_date&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;max_date&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;signing_date&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;Provide date&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ul>
<li class=""><strong>min_date:</strong> Provide the minimum restriction date. The date must be in <strong>YYYY-MM-DD</strong> format.</li>
<li class=""><strong>max_date:</strong> Provide the maximum restriction date. The date must be in <strong>YYYY-MM-DD</strong> format.</li>
@@ -45,7 +46,7 @@
<ol start="6">
<li class=""><strong>textbox</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;textbox&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;my text&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;textbox&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;my text&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;Provide text&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ol start="7">
<li class=""><strong>checkbox</strong></li>
</ol>
@@ -64,11 +65,11 @@
<ol start="10">
<li class=""><strong>number</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;number&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: 0,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;formula&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;decimalplaces&quot;: 2,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;number&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: 0,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;formula&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;decimalplaces&quot;: 2,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;Provide number&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ol start="11">
<li class=""><strong>cells</strong></li>
</ol>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;cells&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;cell_count&quot;: 5,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;name&quot;: &quot;cells&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;readonly&quot;: false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;cell_count&quot;: 5,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;default&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hint&quot;: &quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;hide_text_with_asterisks&quot;: false </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
<ul>
<li class=""><strong>cell_count:</strong> Specify the number of cells that should be returned to the user.</li>
</ul>