Files
OpenSign/assets/js/5a2de241.4bf52b42.js
T

1 line
9.7 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2223],{85651:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>x,contentTitle:()=>g,default:()=>b,frontMatter:()=>h,metadata:()=>n,toc:()=>O});const n=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJzFWG1vHLcR/isTfokD7L1IVhz0PtWN3URoUB2sM4zUFgTecvaWEZdkSO6dDof91l/Sn9ZfUgy5u7f3YsVq0/aLcOLODGeeGc485I4FvvJs9pEtsLKKB/TsLmMCfe6kDdJoNmOLEuG9FTwgdFLwen4NqPlSoYetqSEYqIyQxRa4FlAn6VAiCAxcKg+mAA7eYi4LmUNo7YxZxoxFx2mra8FmLKl2+7CMWe54hQEdubljmlfIZqwzcC8Fy5gkNy0PJTv2/foN7UyOdBoQSh5AIwpPXi+x9ZbsOPy1lg4FmwVXY8Z82CrazcvKKnIGH60yAtms4MqTQF5ixdlsx8LWRsngpF6xjBXGVTzsV5rmLtlHH/5kxJZ0Dl2dO7OWAmGJymygD5uc7PDscgQveACF3AcwGgeyXQDfsIzlRgfUgTbi1iqZR5Anv3jabXfquln+gnkgxB2lJEj09DUB/tsBEjg8wjRjPv7o/WVNxrQJzzYzpxARHK4lbmJhebnSEErpQZi8rii85ijlz9uir4qhjYZ0lEBHFXlqb69NkukU3CzmA9GlMQq5PqlGqioYpQBMXISNVKo9SXCzmMMaHZ2QmKsxvPfofJJxmKNcI/ADEciNQFhLDlhxqTLYlDIvqeC3UNU+AOq2hlrosEduDLGIYQSnDgnpz3qUAVfKbKReQR1dO2cYhHSYB7WFjQylqQNwISSpcwU+oPXjIYrRix7Ihandf44kh1UtBQoIpnZQGBe9ROczsPGYUQRS++DqnJQ9iJqyG+MgUfptncnR+z1OHSokNLCfAWqf1DkU3Ad0GdRaEvKutgFFbxIfLTqJOsezEERw72MjbQH3X47FHF0lg+8ipdRwIQAVUlI8+DovgafvPNQOfQZSyyC58hn4wCvrMzAOAj5SX4FgLDVPfJQ+kPMbKVYYPMjP1dE7pDOSD3wonKli9gkbvR0WQu9XMEfmFpRU6dvxUfBaBVhzVZ/HrJDqbGM5xOhnU0PFt232UwqX3OOrK0BNZ0jA/M2fgYyRQw6t4nkS6+M3GofdJKkf9YMmY0GGg9ZyP5hV90tq/U1Dcg69NdqnLns5nZ5OhH7athOKUkgVWdRKbb/6/Vp8Wv6tZse9uPzRz69+tNT2Wpdeh6eVLqeXL0cX09H0u8XFq9nVH2bfvhpPp9O/sYw9Vmo/X5ho50SHXvp/sCC1khrvO9TuL6fT+5ctlFfn0GunR5fxNVdSQCFRCaA9/e8IIDpn3L853Z7w76nwKeQu+KsnSkebAIWptfh/h3vOo6cDvLr/rg/x29MQr3WCjKjowjyg/l9EuI9nuH1I25Orh1Utk1D8zg6CHa6nID3mtZNhG2nu44hbOUrfZx/viDxWGEpDFNnW0WGiuzM26brLZDfoMw0je27dsebaKTZjZQjWzyYTz7VYmsexsaipUyu+9OPcVBNu5WR9wZrsWINb+wxprEfPU/CBr6RePa11t4foltKYMnUAVJ8vbuVfcMuyLg9Dqfa6UCIX6GLOqDre7an52y7HfRqP+WxHZ7+MoZ7M63Occ0g5GTugle1dY8iP2qWzfKH9luZipKhSFyaC01bfjUV9S35S7a4vThz8gCo3FXaTuRP/59//ETW6wOKGX8FN7cCaDbqiVhGCQuGjJJ5EwtHF/o7okVcKvVdbIHq0chEGuZKBqGFLknJu+VIqSYeRxAxpOxicZz+GDyWGEh19+toR4RO4RkVnGJQxD5HLGeB1MFXco+OmG+MeCnIpAw7L2kuN3oNH7FRQl1znCF2tRUrEdSLS1kmPwGVFwkQrsShkLskwdR7H8wAV13wVuU0G5Deh0DZ5D84siZV7o+rEO+nijBhSiPFWOoY3xPNj4LSYbtAoEuX0WaL8bSOiMLSAJfoAlraXOSZWHrijO+IaXTxbMZNEHMAa6pCSKyJ3w9ySoeC49tTGk0Ndanr4Wk4c9xB8O4ZP+pO+pWKpPVIBKKkf/OyTHsHHvsw+4NLLgHcvuvO+2WxOzvk3hzo/yFDWSyJiZq+3iouxKwzV+3/o2hvQVf6muEW3ljm2TeYze06i8KSdGzyPcyNepFIP+eOxAp0mJXPUftgeXv8w/wnW8HI8Zdmgs32Bw5Ofrr9/+9fbt2SXmnU6fxfj6XhKS9b4UHE92OroHeb46O72A/C//WzTdlq6LEys4jLOtxj8rp1NH9mgYc6GLzZ3GSuNDySy2xGPfu9U09DyrzU6moB3GVtzJ8nTOMDaq5fo29tnw37xrnsDgec9/pwNqJsnmoZJvISk9vyA26NXqOauybqhQh4nie+TX6MF2dlbOOEmNBOTxus8RxuelB2Sgfn7BcvYsn1RquLjFHN8Q69ZfJOcTRfkOC7j2o4prlc1X5FsMkljkNeUteEMfYgztP1BQZ2F43C4pijoL8V0VmG3S/O5aXr59OmzGi2unTTl5q5pmn8BLydHeA==","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"}}');var a=i(74848),s=i(28453),o=i(33617),p=i.n(o),l=i(17543),d=i.n(l),r=i(86013),c=i.n(r),m=i(63723),u=i.n(m),f=(i(18766),i(79329),i(9303));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:"eJzFWG1vHLcR/isTfokD7L1IVhz0PtWN3URoUB2sM4zUFgTecvaWEZdkSO6dDof91l/Sn9ZfUgy5u7f3YsVq0/aLcOLODGeeGc485I4FvvJs9pEtsLKKB/TsLmMCfe6kDdJoNmOLEuG9FTwgdFLwen4NqPlSoYetqSEYqIyQxRa4FlAn6VAiCAxcKg+mAA7eYi4LmUNo7YxZxoxFx2mra8FmLKl2+7CMWe54hQEdubljmlfIZqwzcC8Fy5gkNy0PJTv2/foN7UyOdBoQSh5AIwpPXi+x9ZbsOPy1lg4FmwVXY8Z82CrazcvKKnIGH60yAtms4MqTQF5ixdlsx8LWRsngpF6xjBXGVTzsV5rmLtlHH/5kxJZ0Dl2dO7OWAmGJymygD5uc7PDscgQveACF3AcwGgeyXQDfsIzlRgfUgTbi1iqZR5Anv3jabXfquln+gnkgxB2lJEj09DUB/tsBEjg8wjRjPv7o/WVNxrQJzzYzpxARHK4lbmJhebnSEErpQZi8rii85ijlz9uir4qhjYZ0lEBHFXlqb69NkukU3CzmA9GlMQq5PqlGqioYpQBMXISNVKo9SXCzmMMaHZ2QmKsxvPfofJJxmKNcI/ADEciNQFhLDlhxqTLYlDIvqeC3UNU+AOq2hlrosEduDLGIYQSnDgnpz3qUAVfKbKReQR1dO2cYhHSYB7WFjQylqQNwISSpcwU+oPXjIYrRix7Ihandf44kh1UtBQoIpnZQGBe9ROczsPGYUQRS++DqnJQ9iJqyG+MgUfptncnR+z1OHSokNLCfAWqf1DkU3Ad0GdRaEvKutgFFbxIfLTqJOsezEERw72MjbQH3X47FHF0lg+8ipdRwIQAVUlI8+DovgafvPNQOfQZSyyC58hn4wCvrMzAOAj5SX4FgLDVPfJQ+kPMbKVYYPMjP1dE7pDOSD3wonKli9gkbvR0WQu9XMEfmFpRU6dvxUfBaBVhzVZ/HrJDqbGM5xOhnU0PFt232UwqX3OOrK0BNZ0jA/M2fgYyRQw6t4nkS6+M3GofdJKkf9YMmY0GGg9ZyP5hV90tq/U1Dcg69NdqnLns5nZ5OhH7athOKUkgVWdRKbb/6/Vp8Wv6tZse9uPzRz69+tNT2Wpdeh6eVLqeXL0cX09H0u8XFq9nVH2bfvhpPp9O/sYw9Vmo/X5ho50SHXvp/sCC1khrvO9TuL6fT+5ctlFfn0GunR5fxNVdSQCFRCaA9/e8IIDpn3L853Z7w76nwKeQu+KsnSkebAIWptfh/h3vOo6cDvLr/rg/x29MQr3WCjKjowjyg/l9EuI9nuH1I25Orh1Utk1D8zg6CHa6nID3mtZNhG2nu44hbOUrfZx/viDxWGEpDFNnW0WGiuzM26brLZDfoMw0je27dsebaKTZjZQjWzyYTz7VYmsexsaipUyu+9OPcVBNu5WR9wZrsWINb+wxprEfPU/CBr6RePa11t4foltKYMnUAVJ8vbuVfcMuyLg9Dqfa6UCIX6GLOqDre7an52y7HfRqP+WxHZ7+MoZ7M63Occ0g5GTugle1dY8iP2qWzfKH9luZipKhSFyaC01bfjUV9S35S7a4vThz8gCo3FXaTuRP/59//ETW6wOKGX8FN7cCaDbqiVhGCQuGjJJ5EwtHF/o7okVcKvVdbIHq0chEGuZKBqGFLknJu+VIqSYeRxAxpOxicZz+GDyWGEh19+toR4RO4RkVnGJQxD5HLGeB1MFXco+OmG+MeCnIpAw7L2kuN3oNH7FRQl1znCF2tRUrEdSLS1kmPwGVFwkQrsShkLskwdR7H8wAV13wVuU0G5Deh0DZ5D84siZV7o+rEO+nijBhSiPFWOoY3xPNj4LSYbtAoEuX0WaL8bSOiMLSAJfoAlraXOSZWHrijO+IaXTxbMZNEHMAa6pCSKyJ3w9ySoeC49tTGk0Ndanr4Wk4c9xB8O4ZP+pO+pWKpPVIBKKkf/OyTHsHHvsw+4NLLgHcvuvO+2WxOzvk3hzo/yFDWSyJiZq+3iouxKwzV+3/o2hvQVf6muEW3ljm2TeYze06i8KSdGzyPcyNepFIP+eOxAp0mJXPUftgeXv8w/wnW8HI8Zdmgs32Bw5Ofrr9/+9fbt2SXmnU6fxfj6XhKS9b4UHE92OroHeb46O72A/C//WzTdlq6LEys4jLOtxj8rp1NH9mgYc6GLzZ3GSuNDySy2xGPfu9U09DyrzU6moB3GVtzJ8nTOMDaq5fo29tnw37xrnsDgec9/pwNqJsnmoZJvISk9vyA26NXqOauybqhQh4nie+TX6MF2dlbOOEmNBOTxus8RxuelB2Sgfn7BcvYsn1RquLjFHN8Q69ZfJOcTRfkOC7j2o4prlc1X5FsMkljkNeUteEMfYgztP1BQZ2F43C4pijoL8V0VmG3S/O5aXr59OmzGi2unTTl5q5pmn8BLydHeA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},g=void 0,x={},O=[];function y(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,a.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(d(),{parameters:[{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,a.jsx)(c(),{title:"Body",body:{description:"Provide below parameter to update templates (at least one parameter required)",content:{"application/json":{schema:{type:"object",properties:{name:{type:"string",format:"string",example:"sample template"},note:{type:"string",format:"string",example:"Please review and sign this document"},description:{type:"string",format:"string",example:"template description"},folderId:{type:"string",example:""},enableOTP:{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},enableTour:{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},allow_modifications:{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},file:{type:"string",description:"You may provide the base64 encoded PDF file to replace the existing one",format:"base64",example:""}},title:"template_template_id_body"}}}}}),"\n",(0,a.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Template updated successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"asd2HsP4Hp"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"inline_response_200_3"}}}},400:{description:"Please provide valid field names!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Please provide valid field names!"}},title:"inline_response_400"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"Template not found!"}},title:"inline_response_404_7"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function b(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(y,{...e})}):y(e)}}}]);