OpenSign/assets/js/5a2de241.fbd45b06.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2223],{85651:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>b,contentTitle:()=>f,default:()=>v,frontMatter:()=>y,metadata:()=>a,toc:()=>g});const a=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":"eJzFWNtuI7kR/ZVavmQGaF3s8c4ieoqzM9k1soiFsQaDxCMYVLNazTWb5JJsyYLQb/mSfFq+JCiyW2pdxjtONsmLIbOrilWnilWH3LLAl55N7tkMK6t4QM/mGRPocydtkEazCZuVCB+t4AGhk4Lr6Q2g5guFHjamhmCgMkIWG+BaQJ2kQ4kgMHCpPJgCOHiLuSxkDqG1M2QZMxYdp61uBJuwpNrtwzJmueMVBnTk5pZpXiGbsM7AgxQsY5LctDyU7Nj3m3e0MznSaUAoeQCNKDx5vcDWW7Lj8JdaOhRsElyNGfNho2g3LyuryBl8ssoIZJOCK08CeYkVZ5MtCxsbJYOTeskyVhhX8bBfaZp5so8+/NGIDekcujp1ZiUFwgKVWcMubHKyw7PLEbziARRyH8Bo7Ml2AbxmGcuNDqgDbcStVTKPII9+9rTb9tR1s/gZ80CIO0pJkOjpawL81wMkcHiEacJ8/LHzlzUZ0ya82MyUQkRwuJK4joXl5VJDKKUHYfK6ovCao5S/bItdVfRtNKSjBDqqyFN7e22STKfgdjbtiS6MUcj1STVSVcEgBWDiIqylUu1JgtvZFFbo6ITEXA3ho0fnk4zDHOUKgR+IQG4EwkpywIpLlcG6lHlJBb+BqvYBULc11EKHO+SGEIsYBnDqkJD+rEcZcKXMWuol1NG1c4ZBSId5UBtYy1CaOgAXQpI6V+ADWj/soxi92AE5M7X7z5HksKylQAHB1A4K46KX6HwGNh4zikBqH1ydk7IHUVN2YxwkSr+tMzl6v8epQ4WEevYzQO2TOoeC+4Aug1pLQt7VNqDYmcQni06izvEsBBHch9hIW8D912MxRVfJ4LtIKTVcCECFlBQPvs5L4Ok7D7VDn4HUMkiufAY+8Mr6DIyDgE/UVyAYS80Tn6QP5PxaiiUGD/JLdfQB6YzkPR8KZ6qYfcJGb/qFsPMrmCNzM0qq9O34KHitAqy4qs9jVkh1trEcYvRXU0PFN232UwoX3OPbK0BNZ0jA9N2fgIyRQw6t4nkS28VvNPa7SVI/6gdNxoIMB63loTerHhbU+puG5Bx6a7RPXfZyPD6dCLtp204oSiFVZFErtfnmt2vxafnXmh334vJHP7360VLba126Ds8rXY4v3wwuxoPxd7OLt5Or30++fTscj8d/Yxl7qtR+vjDRzokOvfR/b0FqJTU+dKg9XI7HD29aKK/OoddOjy7jK66kgEKiEkB7+t8QQHTOuH9zuj3j33PhU8hd8FfPlI42AQpTa/H/DvecR88HePXw3S7Eb09DvNEJMqKiM/OI+n8R4T6e/vYhbU+uHla1TELxOzsItr+egvSY106GTaS5TwNu5SB9n9zPiTxWGEpDFNnW0WGiuxM26rrLaNvrMw0je27VsebaKTZhZQjWT0Yjz7VYmKehsaipUyu+8MPcVCNu5Wh1wZrsWINb+wJprAcvU/CBL6VePq8130N0R2lMmToAapcvbuWfccOyLg99qfa6UCIX6GLOqDo+7Kn5+y7HuzQe89mOzn4dQz2Z1+c4Z59yMnZAK9u7Rp8ftUtn+UL7Lc3FSFGlLkwEp62+W4v6jvyk2l1dnDj4CVVuKuwmcyf+z7//I2p0gcUNv4Hb2oE1a3RFrSIEhcInSTyJhKOLuzuiR14p9F5tgOjR0kUY5FIGooYtScq55QupJB1GEjOk7aB3nv0QPpUYSnT06XeOCJ/AFSo6w6CMeYxczgCvg6niHh03XRv3WJBLGXBY1F5q9B48YqeCuuQ6R+hqLVIirhORtk56BC4rEiZaiUUhc0mGqfM4ngeouObLyG0yIL8JhbbJe3BmQazcG1Un3kkXZ8SQQoy30iG8I54fA6fFdINGkSinzxLlbxsRhaEFLNAHsLS9zDGx8sAd3RFX6OLZipkk4gDWUIeUXBG56+eWDAXHtac2nhzqUrODr+XEcQ/BN0P4rD/rOyqW2iMVgJL60U8+6wHc78rsEy68DDh/1Z339Xp9cs5fH+r8IENZL4iImb3eMi7GrtBX3/1D196jhnBY2Q4LdBRNxGiJGmMFcitTD4f76+lNHCZQorL7nUnltDXR6ogER3cYiCP6Uaf/mg4e1QTP4zSK17PUmf5wbCdOBnSVvy3u0K1kjm1v/AJUoyg8YhlTMkft+63q+ofpT7CCN8Mxy3pd9ivAG/108/37v9y9J29ocCTELobj4ZiWrPGh4rq31dGb0HEb2e6H8X/7Cant+nRxGVnFZZy1MfhtOyfvWa95T/qvR/OMlcYHEtluidN/dKppaPmXGh1N43nGVtxJ8jQO0/YaKHat9othv/rQvcfAyx6izgbUzTZNgy1eiNKoeMTN0YtYM2+ybsCRx0ni++TXYEZ29hZOeBLN56Rxnedow7OyfWIy/ThjGVu0r1tVfChjjq/pZY2vk7Ppsh5Hd1zbMsX1suZLkk0maSTzmrLWn+ePcZ63Pyios3AcDvoUBf2lmM4qbLeJKzTNTj59+qJGi2snTbmZN03zL1yFea4=","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 n=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),h=(i(18766),i(79329),i(9303));const y={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:"eJzFWNtuI7kR/ZVavmQGaF3s8c4ieoqzM9k1soiFsQaDxCMYVLNazTWb5JJsyYLQb/mSfFq+JCiyW2pdxjtONsmLIbOrilWnilWH3LLAl55N7tkMK6t4QM/mGRPocydtkEazCZuVCB+t4AGhk4Lr6Q2g5guFHjamhmCgMkIWG+BaQJ2kQ4kgMHCpPJgCOHiLuSxkDqG1M2QZMxYdp61uBJuwpNrtwzJmueMVBnTk5pZpXiGbsM7AgxQsY5LctDyU7Nj3m3e0MznSaUAoeQCNKDx5vcDWW7Lj8JdaOhRsElyNGfNho2g3LyuryBl8ssoIZJOCK08CeYkVZ5MtCxsbJYOTeskyVhhX8bBfaZp5so8+/NGIDekcujp1ZiUFwgKVWcMubHKyw7PLEbziARRyH8Bo7Ml2AbxmGcuNDqgDbcStVTKPII9+9rTb9tR1s/gZ80CIO0pJkOjpawL81wMkcHiEacJ8/LHzlzUZ0ya82MyUQkRwuJK4joXl5VJDKKUHYfK6ovCao5S/bItdVfRtNKSjBDqqyFN7e22STKfgdjbtiS6MUcj1STVSVcEgBWDiIqylUu1JgtvZFFbo6ITEXA3ho0fnk4zDHOUKgR+IQG4EwkpywIpLlcG6lHlJBb+BqvYBULc11EKHO+SGEIsYBnDqkJD+rEcZcKXMWuol1NG1c4ZBSId5UBtYy1CaOgAXQpI6V+ADWj/soxi92AE5M7X7z5HksKylQAHB1A4K46KX6HwGNh4zikBqH1ydk7IHUVN2YxwkSr+tMzl6v8epQ4WEevYzQO2TOoeC+4Aug1pLQt7VNqDYmcQni06izvEsBBHch9hIW8D912MxRVfJ4LtIKTVcCECFlBQPvs5L4Ok7D7VDn4HUMkiufAY+8Mr6DIyDgE/UVyAYS80Tn6QP5PxaiiUGD/JLdfQB6YzkPR8KZ6qYfcJGb/qFsPMrmCNzM0qq9O34KHitAqy4qs9jVkh1trEcYvRXU0PFN232UwoX3OPbK0BNZ0jA9N2fgIyRQw6t4nkS28VvNPa7SVI/6gdNxoIMB63loTerHhbU+puG5Bx6a7RPXfZyPD6dCLtp204oSiFVZFErtfnmt2vxafnXmh334vJHP7360VLba126Ds8rXY4v3wwuxoPxd7OLt5Or30++fTscj8d/Yxl7qtR+vjDRzokOvfR/b0FqJTU+dKg9XI7HD29aKK/OoddOjy7jK66kgEKiEkB7+t8QQHTOuH9zuj3j33PhU8hd8FfPlI42AQpTa/H/DvecR88HePXw3S7Eb09DvNEJMqKiM/OI+n8R4T6e/vYhbU+uHla1TELxOzsItr+egvSY106GTaS5TwNu5SB9n9zPiTxWGEpDFNnW0WGiuxM26rrLaNvrMw0je27VsebaKTZhZQjWT0Yjz7VYmKehsaipUyu+8MPcVCNu5Wh1wZrsWINb+wJprAcvU/CBL6VePq8130N0R2lMmToAapcvbuWfccOyLg99qfa6UCIX6GLOqDo+7Kn5+y7HuzQe89mOzn4dQz2Z1+c4Z59yMnZAK9u7Rp8ftUtn+UL7Lc3FSFGlLkwEp62+W4v6jvyk2l1dnDj4CVVuKuwmcyf+z7//I2p0gcUNv4Hb2oE1a3RFrSIEhcInSTyJhKOLuzuiR14p9F5tgOjR0kUY5FIGooYtScq55QupJB1GEjOk7aB3nv0QPpUYSnT06XeOCJ/AFSo6w6CMeYxczgCvg6niHh03XRv3WJBLGXBY1F5q9B48YqeCuuQ6R+hqLVIirhORtk56BC4rEiZaiUUhc0mGqfM4ngeouObLyG0yIL8JhbbJe3BmQazcG1Un3kkXZ8SQQoy30iG8I54fA6fFdINGkSinzxLlbxsRhaEFLNAHsLS9zDGx8sAd3RFX6OLZipkk4gDWUIeUXBG56+eWDAXHtac2nhzqUrODr+XEcQ/BN0P4rD/rOyqW2iMVgJL60U8+6wHc78rsEy68DDh/1Z339Xp9cs5fH+r8IENZL4iImb3eMi7GrtBX3/1D196jhnBY2Q4LdBRNxGiJGmMFcitTD4f76+lNHCZQorL7nUnltDXR6ogER3cYiCP6Uaf/mg4e1QTP4zSK17PUmf5wbCdOBnSVvy3u0K1kjm1v/AJUoyg8YhlTMkft+63q+ofpT7CCN8Mxy3pd9ivAG/108/37v9y9J29ocCTELobj4ZiWrPGh4rq31dGb0HEb2e6H8X/7Cant+nRxGVnFZZy1MfhtOyfvWa95T/qvR/OMlcYHEtluidN/dKppaPmXGh1N43nGVtxJ8jQO0/YaKHat9othv/rQvcfAyx6izgbUzTZNgy1eiNKoeMTN0YtYM2+ybsCRx0ni++TXYEZ29hZOeBLN56Rxnedow7OyfWIy/ThjGVu0r1tVfChjjq/pZY2vk7Ppsh5Hd1zbMsX1suZLkk0maSTzmrLWn+ePcZ63Pyios3AcDvoUBf2lmM4qbLeJKzTNTj59+qJGi2snTbmZN03zL1yFea4=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,b={},g=[];function T(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,n.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.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,n.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,n.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 v(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(T,{...e})}):T(e)}}}]);