WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-25 11:04:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
6bf12db8c109ff2d3f6d0078996d5d7f3104f684
OpenSign/assets/js/5a2de241.4d9dbd85.js
T

1 line
15 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),o=s(5397),p=s(4667),c=s(9472),h=s(85162);const x={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vIzcO/iusvtwWGL8km7Y441DcXrtogxaNsfFigdsEgTzieNRoJFXU2DEMf+sv6U+7X3KgZsYev2y62+vdfQkcDUmRDynykTYiygWJyXsxw8obGZHEfSYUUh60j9pZMRGzEuGtVzIidFLwanoNaOXcIMHa1RAdVE7pYg3SKqgb6VgiKIxSGwJXgATymOtC5xBbO0ORCecxSN7qWomJaFS7fUQmvAyywoiB3dwIKysUE9EZeNBKZEKzm17GUhz7fv0t78yOdBoQSxnBIipir+fYest2Av5S64BKTGKoMRMU14Z3I115w87gkzdOoZgU0hAL5CVWUkw2Iq59koxB24XIROFCJeN+Zbu9b+wjxX84tWadQ1enwS21QpijcSvYhc1Odnh2OYIXMoJBSRGcxZ5sF8DnIhO5sxFt5I2k90bnCeTRz8S7bU5dd/OfMY+MeOCURI3EXxvAfz9ABkcmmCaC0o+dv2KbCeviJ5uZcogIAZcaV6mwSC8sxFITKJfXFYe3PUr5p22xq4q+jS3rGIWBK/LU3l6bJZtTcDOb9kTnzhmU9qQauapg0ATg0iKstDHtSYKb2RSWGPiEpFwN4S1hoEYmYI56iSAPRCB3CmGpJWAltclgVeq85IJfQ1VTBLRtDbXQ4Q65IaQihgGcOqQ0nfUoA2mMW2m7gDq5ds4wKB0wj2YNKx1LV0eQSmlWlwYooqdhH8XkxQ7ImavDf46khEWtFSqIrg5QuJC8xEAZ+HTMOAJtKYY6Z2UCVXN2Uxwsyr99cDkS7XHqUGGhnv0M0FKjLqGQFDFkUFvNyIfaR1Q7k/jkMWi0OZ6FIIH7kBppCzh9PBZTDJWO1EXKqZFKARrkpBBQnZcgm+8y1gEpA2111NJQBhRl5SkDFyDiE/cViM5z88QnTZGdX2m1wEigP1RHb5DPSN7zoQiuStlnbOy6Xwg7v6I7MjfjpGpqx0chaxNhKU19DrNtJqKOB0f5oTcbHubcardblgtI3llqutrleHzagXfTrZ0IDBlXQFEbs/7sz2upzfLvNRdJ6vJ7ml5977nNtC69is8rXY4vXw4uxoPxV7OLLydXf5188eVwPB7/U2TiqTL7fi5U25c79Jr/ewvaGm3xoUPt4XI8fnjZQnl1Dr22W/t2jC2l0QoKjUYB70l/IoAYggt/cJo8499z4XPIXfBXz5SOdREKV1v1/w73nEfPB3j18NUuxC9OQ7y2DWRM/WbuEe3/IsJ9PP3tY7M9u3pY1boRSt/FQbD99SZIwrwOOq4TrXwaSK8HzffJ+3smaxXG0jEl9XVymOnlRIy67jLa9PrMVrC9sOxYah2MmIgyRk+T0YikVXP3NHQeLXdGI+c0zF01kl6Plhdimx1rSO8/QZqiXGi7GDyrdb+P+Jaz0gB/EPcOfun1D7gWWQdrX6pl2yVKhSGlgJP9Zs9sX3cp22XlmA52bPDjCN7JuDtH2fqMTYgDVtZS9T69aJfOjttuFmtbuARJW0I3Hu0te8cFuLw4cesdmtxV2I2zTvxfv/6WNLpw0jafwU0dwLsVhqI2KfDC4JNmcsHCybHdxYpQVgaJzBqYUyxCCl4vdGQ+1TKLXHo510bziWIxx9oBeoeShvCuxFhi4E9/CcySFC7R8EEE49xjIkAOZB1dlfboCN3KhceCXcpAwrwmbZEICLFTQVtKmyN0FZZ4hLQN+/RBE4LUFQszF8Oi0Llmw9w+gswjVNLKRSIEGbDfjELbqQmCmzOVJWfqhqzxbRMxNiGmq9wQvmVynALnxebaiarhaZQ1PLntJhyGVTBHiuB5e51jQ2WjDHyxWmJIJyplkqc/eMdtTkvDjKifWzYUg7TEvbhxqEvNDr6WSKY9lFwP4c7e2VsulpqQC8Bo+0iTOzuA97sye4dz0hHvX3SnfLVanZzuzw91vtOxrOcQ0Lu93iItpl7QV9/9w3fFiKGim+IWw1Ln2LaWD+w5SsKjtvnLPDX/dPtoOsffjxW4ERudo6V+U3j13fRHWMLL4VhkvX72EQ6Pfrz+5vVPt6/ZLnfc5vxdDMfDMS95R7GStrfV0ePF8dHd7KfYf/uto+2vzLBH3kidhlQKftMOmPei1yYn/WeO+0yUjiKLbDZzSfg2mO2Wl3+pMfAYu8/EUgbNnqYp1N5X1K7hfTDsF2+6hwP4tBeTswF1U8TyCEnMvWnKj7g+errZ3m+zbpSwx43EN41fgxnb2Vs4IRg8CRuNV3mOPj4r25/o07czkYl5+wxTpRcdEeSKn4DkSkzEnbgT6WlqdwdL6xthpF3UcsHyjVkegLLmzPWn52Oanu0PDuwsJIdjtYmE/3JcZxX+xqX4A66/3ok3Xz6o0ELbSXN67rfb7b8BnPMChA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={id:"API-docs/update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWG1vIzcO/iusvtwWGL8km7Y441DcXrtogxaNsfFigdsEgTzieNRoJFXU2DEMf+sv6U+7X3KgZsYev2y62+vdfQkcDUmRDynykTYiygWJyXsxw8obGZHEfSYUUh60j9pZMRGzEuGtVzIidFLwanoNaOXcIMHa1RAdVE7pYg3SKqgb6VgiKIxSGwJXgATymOtC5xBbO0ORCecxSN7qWomJaFS7fUQmvAyywoiB3dwIKysUE9EZeNBKZEKzm17GUhz7fv0t78yOdBoQSxnBIipir+fYest2Av5S64BKTGKoMRMU14Z3I115w87gkzdOoZgU0hAL5CVWUkw2Iq59koxB24XIROFCJeN+Zbu9b+wjxX84tWadQ1enwS21QpijcSvYhc1Odnh2OYIXMoJBSRGcxZ5sF8DnIhO5sxFt5I2k90bnCeTRz8S7bU5dd/OfMY+MeOCURI3EXxvAfz9ABkcmmCaC0o+dv2KbCeviJ5uZcogIAZcaV6mwSC8sxFITKJfXFYe3PUr5p22xq4q+jS3rGIWBK/LU3l6bJZtTcDOb9kTnzhmU9qQauapg0ATg0iKstDHtSYKb2RSWGPiEpFwN4S1hoEYmYI56iSAPRCB3CmGpJWAltclgVeq85IJfQ1VTBLRtDbXQ4Q65IaQihgGcOqQ0nfUoA2mMW2m7gDq5ds4wKB0wj2YNKx1LV0eQSmlWlwYooqdhH8XkxQ7ImavDf46khEWtFSqIrg5QuJC8xEAZ+HTMOAJtKYY6Z2UCVXN2Uxwsyr99cDkS7XHqUGGhnv0M0FKjLqGQFDFkUFvNyIfaR1Q7k/jkMWi0OZ6FIIH7kBppCzh9PBZTDJWO1EXKqZFKARrkpBBQnZcgm+8y1gEpA2111NJQBhRl5SkDFyDiE/cViM5z88QnTZGdX2m1wEigP1RHb5DPSN7zoQiuStlnbOy6Xwg7v6I7MjfjpGpqx0chaxNhKU19DrNtJqKOB0f5oTcbHubcardblgtI3llqutrleHzagXfTrZ0IDBlXQFEbs/7sz2upzfLvNRdJ6vJ7ml5977nNtC69is8rXY4vXw4uxoPxV7OLLydXf5188eVwPB7/U2TiqTL7fi5U25c79Jr/ewvaGm3xoUPt4XI8fnjZQnl1Dr22W/t2jC2l0QoKjUYB70l/IoAYggt/cJo8499z4XPIXfBXz5SOdREKV1v1/w73nEfPB3j18NUuxC9OQ7y2DWRM/WbuEe3/IsJ9PP3tY7M9u3pY1boRSt/FQbD99SZIwrwOOq4TrXwaSK8HzffJ+3smaxXG0jEl9XVymOnlRIy67jLa9PrMVrC9sOxYah2MmIgyRk+T0YikVXP3NHQeLXdGI+c0zF01kl6Plhdimx1rSO8/QZqiXGi7GDyrdb+P+Jaz0gB/EPcOfun1D7gWWQdrX6pl2yVKhSGlgJP9Zs9sX3cp22XlmA52bPDjCN7JuDtH2fqMTYgDVtZS9T69aJfOjttuFmtbuARJW0I3Hu0te8cFuLw4cesdmtxV2I2zTvxfv/6WNLpw0jafwU0dwLsVhqI2KfDC4JNmcsHCybHdxYpQVgaJzBqYUyxCCl4vdGQ+1TKLXHo510bziWIxx9oBeoeShvCuxFhi4E9/CcySFC7R8EEE49xjIkAOZB1dlfboCN3KhceCXcpAwrwmbZEICLFTQVtKmyN0FZZ4hLQN+/RBE4LUFQszF8Oi0Llmw9w+gswjVNLKRSIEGbDfjELbqQmCmzOVJWfqhqzxbRMxNiGmq9wQvmVynALnxebaiarhaZQ1PLntJhyGVTBHiuB5e51jQ2WjDHyxWmJIJyplkqc/eMdtTkvDjKifWzYUg7TEvbhxqEvNDr6WSKY9lFwP4c7e2VsulpqQC8Bo+0iTOzuA97sye4dz0hHvX3SnfLVanZzuzw91vtOxrOcQ0Lu93iItpl7QV9/9w3fFiKGim+IWw1Ln2LaWD+w5SsKjtvnLPDX/dPtoOsffjxW4ERudo6V+U3j13fRHWMLL4VhkvX72EQ6Pfrz+5vVPt6/ZLnfc5vxdDMfDMS95R7GStrfV0ePF8dHd7KfYf/uto+2vzLBH3kidhlQKftMOmPei1yYn/WeO+0yUjiKLbDZzSfg2mO2Wl3+pMfAYu8/EUgbNnqYp1N5X1K7hfTDsF2+6hwP4tBeTswF1U8TyCEnMvWnKj7g+errZ3m+zbpSwx43EN41fgxnb2Vs4IRg8CRuNV3mOPj4r25/o07czkYl5+wxTpRcdEeSKn4DkSkzEnbgT6WlqdwdL6xthpF3UcsHyjVkegLLmzPWn52Oanu0PDuwsJIdjtYmE/3JcZxX+xqX4A66/3ok3Xz6o0ELbSXN67rfb7b8BnPMChA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink