mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-17 21:25:54 +02:00
228 lines
88 KiB
HTML
228 lines
88 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-API-docs/v1.2/drafttemplate" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Draft 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.2/drafttemplate"><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="Draft Template | OpenSign™"><meta data-rh="true" name="description" content="The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution."><meta data-rh="true" property="og:description" content="The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution."><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.2/drafttemplate"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.2/drafttemplate" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/API-docs/v1.2/drafttemplate" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"v1.2","item":"https://docs.opensignlabs.com/docs/API-docs/v1.2"},{"@type":"ListItem","position":2,"name":"Draft Template","item":"https://docs.opensignlabs.com/docs/API-docs/v1.2/drafttemplate"}]}</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.4770fe68.js" defer="defer"></script>
|
||
<script src="/assets/js/main.bbcaf299.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const a=new URLSearchParams(window.location.search).entries();for(var[t,e]of a)if(t.startsWith("docusaurus-data-")){var n=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(n,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="theme-announcement-bar announcementBar_mb4j" style="background-color:#cae4fa;color:#091E42" role="banner"><div class="content_knG7 announcementBarContent_xLdY">Help use spread the word - ⭐ OpenSign on <a target="_blank" rel="noopener" href="https://github.com/opensignlabs/opensign">GitHub</a></div></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo.png" alt="OpenSign™ Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">OpenSign™</b></a><a class="navbar__item navbar__link" href="/docs/help/intro">Help</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/API-docs/v1.2">APIs</a><a class="navbar__item navbar__link" href="/docs/contribute/CODE_OF_CONDUCT">Contribute</a><a href="https://www.opensignlabs.com/plans-pricing" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Cloud Pricing<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><a class="navbar__item navbar__link" href="/docs/self-host/intro">Self-host</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--active" href="/docs/API-docs/v1.2"><span title="v1.2" class="categoryLinkLabel_W154">v1.2</span></a><button aria-label="Collapse sidebar category 'v1.2'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/opensign-api-v-1-2"><span title="Introduction" class="linkLabel_WmDU">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/get-user"><span title="User" class="categoryLinkLabel_W154">User</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/createcontact"><span title="Contacts" class="categoryLinkLabel_W154">Contacts</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/selfsign"><span title="Documents" class="categoryLinkLabel_W154">Documents</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/docs/API-docs/v1.2/drafttemplate"><span title="Templates" class="categoryLinkLabel_W154">Templates</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item post api-method"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/API-docs/v1.2/drafttemplate"><span title="Draft Template" class="linkLabel_WmDU">Draft Template</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item post api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/createtemplate"><span title="Create Template" class="linkLabel_WmDU">Create Template</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item post api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/publictemplate"><span title="Public Template" class="linkLabel_WmDU">Public Template</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item get api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/get-template"><span title="Get Template" class="linkLabel_WmDU">Get Template</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item put api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/update-template"><span title="Update Template" class="linkLabel_WmDU">Update Template</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item delete api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/delete-template"><span title="Delete Template" class="linkLabel_WmDU">Delete Template</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item get api-method"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.2/gettemplatelist"><span title="Get Template list" class="linkLabel_WmDU">Get Template list</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/get-webhook"><span title="Webhook" class="categoryLinkLabel_W154">Webhook</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.2/createfolder"><span title="Folder" class="categoryLinkLabel_W154">Folder</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/API-docs/v1.1"><span title="v1.1" class="categoryLinkLabel_W154">v1.1</span></a><button aria-label="Collapse sidebar category 'v1.1'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/API-docs/v1.1/opensign-api-v-1-1"><span title="Introduction" class="linkLabel_WmDU">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/get-user"><span title="User" class="categoryLinkLabel_W154">User</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/createcontact"><span title="Contacts" class="categoryLinkLabel_W154">Contacts</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/selfsign"><span title="Documents" class="categoryLinkLabel_W154">Documents</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/drafttemplate"><span title="Templates" class="categoryLinkLabel_W154">Templates</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/get-webhook"><span title="Webhook" class="categoryLinkLabel_W154">Webhook</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/API-docs/v1.1/createfolder"><span title="Folder" class="categoryLinkLabel_W154">Folder</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/docs/API-docs/v1"><span title="v1" class="categoryLinkLabel_W154">v1</span></a><button aria-label="Expand sidebar category 'v1'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col"><div class="docItemContainer_jfFK"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/docs/API-docs/v1.2"><span>v1.2</span></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Templates</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Draft Template</span></li></ul></nav><div class="theme-doc-markdown markdown"><div class="row theme-api-markdown"><div class="col col--7 openapi-left-panel__container"><h1 class="openapi__heading">Draft Template</h1>
|
||
<pre class="openapi__method-endpoint"><span class="badge badge--success">POST</span> <h2 class="openapi__method-endpoint-path">/drafttemplate</h2></pre><div class="openapi__divider"></div>
|
||
<p>The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique <strong>objectId</strong> (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a <strong>url</strong> is provided, which offers a user interface for editing the template and facilitating document distribution.</p>
|
||
<p>Tip: Upload your PDF document to our <a href="https://app.opensignlabs.com/debugpdf" target="_blank" rel="noopener noreferrer" class=""><strong>Debug UI</strong></a>, where you can easily add widgets, then copy coordinates, page numbers, and more in a ready-to-use JSON format. Plus, you can directly copy the document's base64 string, making it quick to send to the API.</p>
|
||
<p><strong>When document is created this webhook event will trigger</strong></p>
|
||
<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"> "event": "created",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": "DOCUMENT_TYPE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "objectId": "DOCUMENT_ID",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "file": "DOCUMENT_URL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "DOCUMENT_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "note": "Please review and sign this document",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "description": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signers": [</span><br></span><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"> "name": "SIGNER_NAME",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "email": "SIGNER_EMAIL",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "phone": "SIGNER_PHONE",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "url": "SIGNING_URL"</span><br></span><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"> ],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "createdAt": "TIMESTAMP"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||
<p><strong>Supported Widgets:</strong></p>
|
||
<p>Below are the common parameters that are required with all widgets:</p>
|
||
<ul>
|
||
<li class=""><strong>name:</strong> Unique identifier for this widget.</li>
|
||
<li class=""><strong>type:</strong> Indicates the type of widget.</li>
|
||
<li class=""><strong>page:</strong> Specifies the page number on which you want to place the respective widget.</li>
|
||
<li class=""><strong>x, y:</strong> Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.</li>
|
||
<li class=""><strong>w, h:</strong> Represents the width and height of the widget. You can adjust these values using the debug UI.</li>
|
||
<li class=""><strong>required:</strong> Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.</li>
|
||
<li class=""><strong>name:</strong> Provides a different name for widgets if you are providing more than one widget.</li>
|
||
<li class=""><strong>color:</strong> Specifies the color of the widget content. Available options include black, blue, red, and yellow, with black as the default selection if no color is specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.</li>
|
||
<li class=""><strong>fontsize:</strong> Specifies the fontsize of the widget content. Available options include 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, and 28, with a default fontsize of 12 if not specified. This parameter is optional and is applicable to the following widgets: email, name, job title, company, date, textbox, checkbox, radio button, and dropdown.</li>
|
||
<li class=""><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.</li>
|
||
<li class=""><strong>hint:</strong> Specify the hint for widgets. This parameter is optional and is not applicable to the following widgets: checkbox, radio button, dropdown.</li>
|
||
</ul>
|
||
<p><strong>List of all supported widgets:</strong></p>
|
||
<ol>
|
||
<li class=""><strong>signature</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"> "type": "signature",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide signature"</span><br></span><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" style="display:inline-block"></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>stamp</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"> "type": "stamp",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "stamp",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide stamp"</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ol start="3">
|
||
<li class=""><strong>initials</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"> "type": "initials",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "initials",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide initials"</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ol start="4">
|
||
<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"> "type": "email",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "email",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide email",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hide_text_with_asterisks": false</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ol start="5">
|
||
<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"> "type": "name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hide_text_with_asterisks": false</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ol start="6">
|
||
<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"> "type": "job title",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "job title",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide job title",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hide_text_with_asterisks": false</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ol start="7">
|
||
<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"> "type": "company",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "company",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide company",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hide_text_with_asterisks": false</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ol start="8">
|
||
<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"> "type": "date",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "date",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": "04-15-2024",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "format": "mm-dd-yyyy",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "min_date": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "max_date": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "signing_date": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide date"</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>default:</strong> Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.</li>
|
||
<li class=""><strong>format:</strong> Specify the date format of your choice from the options below.<!-- -->
|
||
<ul>
|
||
<li class="">"mm/dd/yyyy",</li>
|
||
<li class="">"dd-mm-yyyy",</li>
|
||
<li class="">"yyyy-mm-dd",</li>
|
||
<li class="">"mm.dd.yyyy",</li>
|
||
<li class="">"mm-dd-yyyy",</li>
|
||
<li class="">"mmm dd, yyyy",</li>
|
||
<li class="">"mmmm dd, yyyy",</li>
|
||
<li class="">"dd mmm, yyyy",</li>
|
||
<li class="">"dd mmmm, yyy",</li>
|
||
<li class="">"dd/mm/yyyy",</li>
|
||
<li class="">"dd.mm.yyyy".</li>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
<li class=""><strong>signing_date</strong>: If signing_date is set to true, the signing date is shown to the signer during signing. You may set either signing_date or default, but not both. Using both is not supported.</li>
|
||
</ul>
|
||
<ol start="9">
|
||
<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"> "type": "textbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "textbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": "name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "provide name",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "regularexpression": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hide_text_with_asterisks": false</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>default:</strong> Provide a default value for the textbox (Optional).</li>
|
||
<li class=""><strong>regularexpression:</strong> A custom regex pattern for validation - for example, /^\d+$/ to permit only digits, /^[A-Z]+$/ to permit only uppercase letters, etc. <a href="https://www.w3schools.com/jsref/jsref_obj_regexp.asp" target="_blank" rel="noopener noreferrer" class="">help</a> (Optional).</li>
|
||
<li class=""><strong>readonly:</strong> Set to true if you want to set the textbox as readonly. By default, it's false.</li>
|
||
</ul>
|
||
<ol start="10">
|
||
<li class=""><strong>checkbox</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"> "type": "checkbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "checkbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "values": ["male", "female", "other"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "selectedvalues": ["male", "female"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hidelabel": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "layout": "vertical",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "validation": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "minselections": 0,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "maxselections": 0</span><br></span><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"> }</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>values:</strong> Provide options for the checkbox list.</li>
|
||
<li class=""><strong>selectedvalues:</strong> Provide values that need to be selected by default (Optional).</li>
|
||
<li class=""><strong>readonly:</strong> Set to true if you want to set the checkbox as readonly. By default, it's false.</li>
|
||
<li class=""><strong>hidelabel:</strong> Set to true if you want to hide labels of the checkbox. By default, it's false.</li>
|
||
<li class=""><strong>minselections:</strong> Provide the minimum number of checkboxes that must be selected by the user.</li>
|
||
<li class=""><strong>maxselections:</strong> Provide the maximum number of checkboxes that can be selected by the user.</li>
|
||
</ul>
|
||
<ol start="11">
|
||
<li class=""><strong>dropdown</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"> "type": "dropdown",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "dropdown",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "values": ["male", "female", "other"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>values:</strong> Provide options for the dropdown list.</li>
|
||
<li class=""><strong>default:</strong> Provide the value that needs to be selected by default. Only one value is accepted. (Optional).</li>
|
||
<li class=""><strong>readonly:</strong> Set to true if you want to set the dropdown as readonly. By default, it's false.</li>
|
||
</ul>
|
||
<ol start="12">
|
||
<li class=""><strong>radio button</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"> "type": "radio button",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "radio button",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "values": ["male", "female", "other"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": "male",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "layout": "vertical"</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>values:</strong> Provide options for the radio button list.</li>
|
||
<li class=""><strong>default:</strong> Provide the value that needs to be selected by default. Only one value is accepted. (Optional).</li>
|
||
<li class=""><strong>readonly:</strong> Set to true if you want to set the radio button as readonly. By default, it's false.</li>
|
||
</ul>
|
||
<ol start="13">
|
||
<li class=""><strong>image</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"> "type": "image",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "image",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide image"</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ol start="14">
|
||
<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"> "type": "number",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 107,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 528,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 60,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "number",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": 0,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide number",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "formula": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "decimalplaces": 2,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hide_text_with_asterisks": false</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>formula:</strong> Compute the value from other number widgets using +, -, *, /, (, ). Reference widgets by their name in double curly braces, e.g. {{quantity}} * {{rate}}. to know more <a href="https://docs.opensignlabs.com/docs/help/New-Document/widgets" target="_blank" rel="noopener noreferrer" class="">visit here</a> (optional).</li>
|
||
<li class=""><strong>default:</strong> Provide a default number (Optional).</li>
|
||
<li class=""><strong>readonly:</strong> Set to true if you want to set the textbox as readonly. By default, it's false.</li>
|
||
<li class=""><strong>decimalplaces:</strong> Number of digits to display after the decimal point. e.g: 2 => 12.00, 0 => 12 (default 2)</li>
|
||
</ul>
|
||
<ol start="15">
|
||
<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"> "type": "cells",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 100,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 100,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 50,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "cells",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "readonly": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "cell_count": 5,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "default": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "regularexpression": "",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hide_text_with_asterisks": false</span><br></span><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">}</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>
|
||
<ol start="16">
|
||
<li class=""><strong>attachments</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"> "type": "attachments",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 628,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "attachment widget",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hint": "Provide files"</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<p><strong>Prefill Widgets:</strong> Prefill widgets are elements that are inserted into a document <strong>before</strong> it is shared with a user. Only the document creator has permission to add them.</p>
|
||
<p><strong>List of widgets supported in Prefill</strong></p>
|
||
<ol>
|
||
<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"> "type": "textbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 290,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 165,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 150,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 20,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "textbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "response": "joe",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "red",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>response:</strong> Enter the text you would like to display inside the textbox.</li>
|
||
<li class=""><strong>color:</strong> Choose the text color (options: black, blue, or red).</li>
|
||
</ul>
|
||
<ol start="2">
|
||
<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"> "type": "date",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 173,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 588,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "date",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "response": "04/15/2024",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "format": "mm/dd/yyyy",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>response:</strong> Enter the date you would like to display inside the date box.</li>
|
||
<li class=""><strong>format:</strong> Specify the date format of your choice from the options below.<!-- -->
|
||
<ul>
|
||
<li class="">"mm/dd/yyyy",</li>
|
||
<li class="">"dd-mm-yyyy",</li>
|
||
<li class="">"yyyy-mm-dd",</li>
|
||
<li class="">"mm.dd.yyyy",</li>
|
||
<li class="">"mm-dd-yyyy",</li>
|
||
<li class="">"mmm dd, yyyy",</li>
|
||
<li class="">"mmmm dd, yyyy",</li>
|
||
<li class="">"dd mmm, yyyy",</li>
|
||
<li class="">"dd mmmm, yyy",</li>
|
||
<li class="">"dd/mm/yyyy",</li>
|
||
<li class="">"dd.mm.yyyy".</li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><strong>color:</strong> Choose the text color (options: black, blue, or red).</li>
|
||
</ul>
|
||
<ol start="3">
|
||
<li class=""><strong>checkbox</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"> "type": "checkbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 172,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 630,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "checkbox",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "values": ["male", "female", "other"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "response": ["male", "female"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hidelabel": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>values:</strong> Provide options for the checkbox list.</li>
|
||
<li class=""><strong>response:</strong> Provide values that need to be selected.</li>
|
||
<li class=""><strong>hidelabel:</strong> Set to true if you want to hide labels of the checkbox. By default, it's false.</li>
|
||
<li class=""><strong>color:</strong> Choose the text color (options: black, blue, or red).</li>
|
||
</ul>
|
||
<ol start="4">
|
||
<li class=""><strong>radio button</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"> "type": "radio button",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 173,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 718,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "radio button",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "values": ["male", "female", "other"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "response": "male",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "hidelabel": false,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>values:</strong> Provide options for the radio button list.</li>
|
||
<li class=""><strong>response:</strong> Provide the value that needs to be selected. Only one value is accepted.</li>
|
||
<li class=""><strong>hidelabel:</strong> Set to true if you want to hide labels of the radio button. By default, it's false.</li>
|
||
<li class=""><strong>color:</strong> Choose the text color (options: black, blue, or red).</li>
|
||
</ul>
|
||
<ol start="5">
|
||
<li class=""><strong>image</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"> "type": "image",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 100,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 95,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 92,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 55,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "image",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "response":"iVBORw0KGgoAAAANSUhEUgAAAmoAAA..."</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>response:</strong> Provide image in base64 format like iVBORw0KGgoAAAANSUhEUgA... or data<!-- -->:image<!-- -->/png;base64,iVBORw0KGgoAAAANSUhEUgA....</li>
|
||
</ul>
|
||
<ol start="6">
|
||
<li class=""><strong>dropdown</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"> "type": "dropdown",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "page": 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "x": 327,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "y": 528,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "w": 114,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "h": 21,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "options": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "required": true,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "name": "dropdown",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "values": ["male", "female", "other"],</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "response": "female",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "color": "black",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "fontsize": 12</span><br></span><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">}</span><br></span></code></pre></div></div>
|
||
<ul>
|
||
<li class=""><strong>values:</strong> Provide options for the dropdown list.</li>
|
||
<li class=""><strong>response:</strong> Provide the value that needs to be selected. Only one value is accepted.</li>
|
||
<li class=""><strong>color:</strong> Choose the text color (options: black, blue, or red).</li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq openapi-tabs__heading" id="request">Request<a href="#request" class="hash-link" aria-label="Direct link to request" title="Direct link to request" translate="no"></a></h2>
|
||
<div class="openapi-skeleton sm"></div>
|
||
<div class="openapi-skeleton sm"></div>
|
||
<div class="openapi-tabs__container"><div class="openapi-tabs__response-header-section"><h2 class="anchor anchorTargetStickyNavbar_Vzrq openapi-tabs__heading openapi-tabs__response-header" id="responses">Responses<a href="#responses" class="hash-link" aria-label="Direct link to Responses" title="Direct link to Responses" translate="no"></a></h2><div class="openapi-tabs__response-container"><ul role="tablist" aria-orientation="horizontal" class="openapi-tabs__response-list-container tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item openapi-tabs__response-code-item success active">200</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">400</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item openapi-tabs__response-code-item danger">405</li></ul></div></div><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>Template created successfully!</p></div></div><div class="openapi-skeleton md"></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>Something went wrong, please try again later!</p></div></div><div class="openapi-skeleton md"></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><div><div style="margin-top:.5rem;margin-bottom:.5rem"><p>Invalid API Token!</p></div></div><div class="openapi-skeleton md"></div></div></div></div></div><div class="col col--5 openapi-right-panel__container"><div class="openapi-skeleton lg"></div></div></div></div><div class="row"><div class="col col--7"></div></div></article><div class="row"><div class="col col--7"><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/API-docs/v1.2/getsigninglinks"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Get Signing Links</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/API-docs/v1.2/createtemplate"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Create Template</div></a></nav></div></div></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/help/intro">Help</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/API-docs/v1.1">APIs</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contribute/intro">Contribute</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/self-host/intro">Self-host</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.com/invite/xe9TDuyAyj" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.linkedin.com/company/opensign%E2%84%A2/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.twitter.com/opensignhq" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.facebook.com/profile.php?id=61551030403669" target="_blank" rel="noopener noreferrer" class="footer__link-item">Facebook<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.opensignlabs.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Official Website<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/opensignlabs/opensign" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 OpenSign™. <br>The best Open Source DocuSign alternative.</div></div></div></footer></div>
|
||
</body>
|
||
</html> |