WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 14:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
fd807b3d49eb7709d3ff4c41c5d65406da0921d5
OpenSign/assets/js/5a2de241.cdeb663e.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:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>y});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),o=s(41429),m=s(5397),p=s(4667),c=s(9472),u=s(85162);const h={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:"eJzFWG1vI7cR/isTfukFWEuyz0lQoSjqJofcIS8Wzjoc0LNhjJYjLWMuyZBcyYKgb/0l/Wn9JcWQu9LK0jl3bdp+MWTuzPCZF8485EZEXAQx/iCmVDuNkYK4K4SkUHrlorJGjMW0InjnJEaCTgquJm+ADM40BVjbBqKF2ko1XwMaCU2WjhWBpIhKB7BzQAiOSjVXJcTWzkAUwjryyFu9kWIssmq3jyiEQ481RfIMcyMM1iTGojNwr6QohGKYDmMlnmJ/8x3vzEA6DYgVRjBEMjDqGbVo2Y6nXxvlSYpx9A0VIsS15t2Cqp1mMPTotJUkxnPUgQXKimoU442Ia5cko1dmIQoxt77GuF/Zbu+yfQrxr1auWecQ6sTbpZIEM9J2BTu3GWQXzy5H8AIjaMIQwRrqyXYOfCkKUVoTyUTeCJ3TqkxBHv4SeLfNMXQ7+4XKyBH3nJKoKPDXHPDfdpCDgylMYxHSjx1esS2EsfGzzUzYRQJPS0WrVFhBLQzESgWQtmxqdm/7JOWft8WuKvo2tqyjJXmuyGN7e22WzKfgejrpic6s1YTmqBq5quAsO2DTIqyU1u1JguvpBJbk+YSkXA3gXSAfsoynktSSAA9EoLSSYKkQqEalC1hVqqy44NdQNyECmbaG2tDRLnIDSEUMZ3AMSKpwElEBqLVdKbOAJkE7ZRik8lRGvYaVipVtIqCUitVRQ4jkwqAfxYRiF8ipbfx/HkmERaMkSYi28TC3PqEkHwpw6ZixB8qE6JuSlQPIhrOb/GBR/u28LSmEfZy6qLBQz34BZEJWR5hjiOQLaIziyPvGRZI7k/ToyCsyJZ0MQQrufWqkbcDDp8diQr5WMXSecmpQSiBNnJQAoSkrwPwdY+MpFKCMigp1KCBErF0owHqI9Mh9BaJ13DzpUYXI4FdKLigGUB+ro7fEZ6TsYZh7W6fsc2zMul8IO1zRPjE35aSq0I6POTY6whJ1cypm20JEFQ+O8n1vNtzPuNVutyznKThrQu5qF6PRcQfeTbd2InDIuALmjdbrL36/lpqXf6u5YJAXr8Pk8rXjNtNCuorPK12MLl6enY/ORt9Mz78eX/5x/NXXg9Fo9DdRiMda7/u5kG1f7qKX/+8tKKOVofsuavcXo9H9yzaUl6ei13Zr146xJWolYa5IS+A9w+8YQPLe+n9zmjyD7zn32eXO+ctnSsfYCHPbGPn/dvcUoucdvLz/ZufiV8cuvjE5ZEz9pvaBzP/Cw70//e1j3p6hHla1ykLpuzhwtr+enQxUNl7FdaKVj2fo1Fn+Pv5wx2StplhZpqSuSYCZXo7FsOsuw02vz2wF2/PLjqUeRu5mhYsF+dfNLKG/aqKFn2z5kF1svBZjUcXowng4XCofs6VByGpVMxuUth5OPHIj+hmXD+iH1pEZng9Gg5HYFpsnRgIaObOPAxbiVqxxFpINdGq4PD+hgc59hnSIuFBmcfas1t0+xDdcBjnTB4He5Rud+oHWoujy2Jdq6X1FKMmnnHN1vd1T6VddjezK4Cn/7OjnpzHKo/l6iiP2KaIQBzSwvRv0+Uy7dHK+d8NfmblNIWlr9tqRuWF0XDPL8yNY70mXtqZufnbi//z7P5JG507a5gu4bjw4uyI/b3RyfK7pUTGbYeEEbHeTC4S1phD0GpjELHxyXi1UZALXUpkSHc6UVnyEWcyytodeFwgDeF9RrMjzpz94pmWSlqT55IO29iExLgvYRFunPToGubL+Yc6QCkCYNUEZCgECUadCpkJTEnQVlogLmkx3nVeBAFXNwkz+aD5XpWLD3K88lhFqNLhIDKQAxs1RaEdDAG9nzJ2D1U1mh3y9JYrZxXR3HMB3zMaT47yY77kkMzEMRSbmbftiN4yEGYUIjrdXJWXuHNHzTW5JPp2olEk+5eAs91WFmilYP7dsKHo0gZt/BtSlZhe+lrmmPSSuB3Brbs0NF0sTiAtAK/MQxrfmDD7syuw9zYKKdPeiO+Wr1erodH95qPO9ilUzA0/O7vUWaTH1gr767h++nEbydbie35BfqpLa1vKRPYdJeNhOGyzTtEnXndw5/vJUgTu/ViWZ0G8KV99PfoQlvByMDpruJwAe/vjm21c/37xiu9zi8/nrmq9wNsQaTW+rJ68lT4/uZj82/9uPK21/ZUo/dBpVmorJ+U070T6IXpsc999V7gpR2RBZZLOZYaB3Xm+3vPxrQ57n5l0hlugVI81jL1+Q5K7hfdTtF2+7lwr4vCeakw51U8TwCElXhdyUH2j95K1oe7ctulHCiLPEtxnX2ZTt7C0cMRqehFnjqizJxWdl+xRi8m4qCjFr333q9IQkPK74zQlXYixuxa1Ib2G7S19a3wiNZtHgguWzWR6A2HDm+tPzIU3P9gc7djIkh2M1e8J/2a+TCn/iUvyB1n/eiecvH1VoQ9tJc3ruttvtvwDZLSov",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={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:"eJzFWG1vI7cR/isTfukFWEuyz0lQoSjqJofcIS8Wzjoc0LNhjJYjLWMuyZBcyYKgb/0l/Wn9JcWQu9LK0jl3bdp+MWTuzPCZF8485EZEXAQx/iCmVDuNkYK4K4SkUHrlorJGjMW0InjnJEaCTgquJm+ADM40BVjbBqKF2ko1XwMaCU2WjhWBpIhKB7BzQAiOSjVXJcTWzkAUwjryyFu9kWIssmq3jyiEQ481RfIMcyMM1iTGojNwr6QohGKYDmMlnmJ/8x3vzEA6DYgVRjBEMjDqGbVo2Y6nXxvlSYpx9A0VIsS15t2Cqp1mMPTotJUkxnPUgQXKimoU442Ia5cko1dmIQoxt77GuF/Zbu+yfQrxr1auWecQ6sTbpZIEM9J2BTu3GWQXzy5H8AIjaMIQwRrqyXYOfCkKUVoTyUTeCJ3TqkxBHv4SeLfNMXQ7+4XKyBH3nJKoKPDXHPDfdpCDgylMYxHSjx1esS2EsfGzzUzYRQJPS0WrVFhBLQzESgWQtmxqdm/7JOWft8WuKvo2tqyjJXmuyGN7e22WzKfgejrpic6s1YTmqBq5quAsO2DTIqyU1u1JguvpBJbk+YSkXA3gXSAfsoynktSSAA9EoLSSYKkQqEalC1hVqqy44NdQNyECmbaG2tDRLnIDSEUMZ3AMSKpwElEBqLVdKbOAJkE7ZRik8lRGvYaVipVtIqCUitVRQ4jkwqAfxYRiF8ipbfx/HkmERaMkSYi28TC3PqEkHwpw6ZixB8qE6JuSlQPIhrOb/GBR/u28LSmEfZy6qLBQz34BZEJWR5hjiOQLaIziyPvGRZI7k/ToyCsyJZ0MQQrufWqkbcDDp8diQr5WMXSecmpQSiBNnJQAoSkrwPwdY+MpFKCMigp1KCBErF0owHqI9Mh9BaJ13DzpUYXI4FdKLigGUB+ro7fEZ6TsYZh7W6fsc2zMul8IO1zRPjE35aSq0I6POTY6whJ1cypm20JEFQ+O8n1vNtzPuNVutyznKThrQu5qF6PRcQfeTbd2InDIuALmjdbrL36/lpqXf6u5YJAXr8Pk8rXjNtNCuorPK12MLl6enY/ORt9Mz78eX/5x/NXXg9Fo9DdRiMda7/u5kG1f7qKX/+8tKKOVofsuavcXo9H9yzaUl6ei13Zr146xJWolYa5IS+A9w+8YQPLe+n9zmjyD7zn32eXO+ctnSsfYCHPbGPn/dvcUoucdvLz/ZufiV8cuvjE5ZEz9pvaBzP/Cw70//e1j3p6hHla1ykLpuzhwtr+enQxUNl7FdaKVj2fo1Fn+Pv5wx2StplhZpqSuSYCZXo7FsOsuw02vz2wF2/PLjqUeRu5mhYsF+dfNLKG/aqKFn2z5kF1svBZjUcXowng4XCofs6VByGpVMxuUth5OPHIj+hmXD+iH1pEZng9Gg5HYFpsnRgIaObOPAxbiVqxxFpINdGq4PD+hgc59hnSIuFBmcfas1t0+xDdcBjnTB4He5Rud+oHWoujy2Jdq6X1FKMmnnHN1vd1T6VddjezK4Cn/7OjnpzHKo/l6iiP2KaIQBzSwvRv0+Uy7dHK+d8NfmblNIWlr9tqRuWF0XDPL8yNY70mXtqZufnbi//z7P5JG507a5gu4bjw4uyI/b3RyfK7pUTGbYeEEbHeTC4S1phD0GpjELHxyXi1UZALXUpkSHc6UVnyEWcyytodeFwgDeF9RrMjzpz94pmWSlqT55IO29iExLgvYRFunPToGubL+Yc6QCkCYNUEZCgECUadCpkJTEnQVlogLmkx3nVeBAFXNwkz+aD5XpWLD3K88lhFqNLhIDKQAxs1RaEdDAG9nzJ2D1U1mh3y9JYrZxXR3HMB3zMaT47yY77kkMzEMRSbmbftiN4yEGYUIjrdXJWXuHNHzTW5JPp2olEk+5eAs91WFmilYP7dsKHo0gZt/BtSlZhe+lrmmPSSuB3Brbs0NF0sTiAtAK/MQxrfmDD7syuw9zYKKdPeiO+Wr1erodH95qPO9ilUzA0/O7vUWaTH1gr767h++nEbydbie35BfqpLa1vKRPYdJeNhOGyzTtEnXndw5/vJUgTu/ViWZ0G8KV99PfoQlvByMDpruJwAe/vjm21c/37xiu9zi8/nrmq9wNsQaTW+rJ68lT4/uZj82/9uPK21/ZUo/dBpVmorJ+U070T6IXpsc999V7gpR2RBZZLOZYaB3Xm+3vPxrQ57n5l0hlugVI81jL1+Q5K7hfdTtF2+7lwr4vCeakw51U8TwCElXhdyUH2j95K1oe7ctulHCiLPEtxnX2ZTt7C0cMRqehFnjqizJxWdl+xRi8m4qCjFr333q9IQkPK74zQlXYixuxa1Ib2G7S19a3wiNZtHgguWzWR6A2HDm+tPzIU3P9gc7djIkh2M1e8J/2a+TCn/iUvyB1n/eiecvH1VoQ9tJc3ruttvtvwDZLSov",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"}},f={},y=[{value:"Request",id:"request",level:2}];function g(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)(r(),{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)(o.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)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.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)(u.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.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)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink