OpenSign/assets/js/5ce6d213.2dd0ae0e.js

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3460],{32779(e,t,i){i.r(t),i.d(t,{assets:()=>y,contentTitle:()=>g,default:()=>x,frontMatter:()=>b,metadata:()=>a,toc:()=>v});const a=JSON.parse('{"id":"API-docs/v1.1/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/v1.1/update-template.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-template","permalink":"/docs/API-docs/v1.1/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":"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfApaJe1M0PerEFHCvjrufKrDyhw7z2UhNyRF1yXRBhWxlxTCWASiO2ddIj+OBIaZlUMzo4XgSouOaLOGdm0PeVQCWpfYAzOW1JvFF12gPQttK4ONkne+KmMPrwBS3/HAKdEi5yWFIZL5tlgM/SMiaVEZmgBeToA1jSRRYYZ91aK1Ncx/gR0gFrqKVLrggh93Uk9uC49vTuJF3aEHQOa2Y89A3Iv/BIAX4j9bWfDAYf9Qlcdmn1AXMvA17db1vSarU6aEUPdnleyvCqzuE9WuNlMG695V7IUNZ5bF99Id0fSdJL1BjTp9ectjKEKfxhN6TTUYnKjs7SsOBHp9PX8RV8AJ9++ye8Qe40lGaVkrWoHao1LNqryHMp8slt3SMWN0G8DiV5vEjJ1+xkWw9+KHn49Nu/PLzFFW06UkWRKYPBtM6VLLoluB8MJvCc5qf+ajaulwuuaWT3JadUovUcB5u4ldTXQzjV67hB2448dB75dsyIjbYNt48rizjf9Dfaw61GcdD2qJboSRaBkRwBhSR8HUpn6kW6ra9MY5zDOc0IH9KWh2w7FQJsc9wuf2io36qDc5OWFWvgDsHH/c10jyV+qa01jrRotkdz0y4SUQtrpA5+AsLxedjKz/bG1LiAPDhKLuSdO7JGTBeSVImNxd0pDTTZ/sO6224dztHRhdHsbVysbNLpsk1LoGz9I2lN8Im6Fi8iuosTWXrhf9yXE5EWusq/m5+hW8oCG5TxmYoeReIRy5iSBWrff/JPX07fwPLxcEyPVAdXvqK4R29eP3/x9uwFKUONNDns4XA8HMcJ2/hQcd27ae8HpP2n7XaLbf/bvzc14Im2nCOruIzQtVnWJdh5yXoYaNL/qekqY6XxgUhub6kYL5zabOj41zriiMurjC25k6RpxKbNBkwc3wH1zb7/vv3xBr7tV6ujBrUQURM+jNvTBIqucb3389mGsEiDE0njRPE86XVyTnK2Eg7GDgK6ieO0KNCGO2n7OH96cU7gqfkprIq/qjHHV4Sr+Copmzb7EQHHs1umuF7UfEG0SeQmLTTLXVh8HWFx8w8y6qg7dvFysoL+SzYdZbi9TZB7s+no06fPcjR+bakpNlebzeY/iKFnfg==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1.1/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1.1/delete-template"}}');var n=i(74848),s=i(28453),o=i(57742),p=i.n(o),r=i(78178),d=i.n(r),l=i(19624),c=i.n(l),m=i(96226),u=i.n(m),h=(i(77675),i(19365),i(51107)),f=i(21312);const b={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:"eJzFWc2OG7kRfpUKL7aFHkn+XUSnnXgd21jDFjwzMJLxQGA3S2rusEkuyZZGGAjYQ94gp1zzaH6SoMjuVuvHY3vXSS67HnZVsf75VemWBb7wbHLJzrGyigf07CpjAn3hpA3SaDZh5yXChRU8ILRUcDp9Dah5rtDD2tQQDFRGyPkauBZQJ+pQIggMXCoPZg4cvMVCzmUBoZEzZBkzFh2nq14LNmGJtb2HZcxyxysM6EjNW6Z5hWzCWgEzKVjGJKlpeSjZvu6vf6KbSZGWA0LJA2hE4UnrHBttSY7DX2vpULBJcDVmzIe1otu8rKwiZfDGKiOQTeZceSIoSqw4m9yysLaRMjipFyxjc+MqHrYnm81Vko8+/MWINfHsqjp1ZikFQo7KrKAzm5Rs/dnGCO7zAAq5D2A09mhbAx6wjBVGB9SBLuLWKllEJ49+8XTb7aHqJv8Fi0AedxSSINHT1+TwLxtIzuHRTRPm4z86fdkmY9qEbxYzJRMRHC4lrmJiebnQEErpQZiirsi8zV7Iv+2KLiv6MjbEowQ6yshDeVtuokxV8O582iPNjVHI9UE2UlbBSTLAxENYSaWaSoJ351NYoqMKibEawoVH5xONwwLlEoHvkEBhBMJScsCKS5XBqpRFSQm/hqr2AVA3OdS4DjvPDSEmMZzAoUJC+qMaZcCVMiupF1BH1Y4JBiEdFkGtYSVDaeoAXAhJ7FyBD2j9sO/FqEXnyHNTuz/uSQ6LWgoUEEztYG5c1BKdz8DGMiMLpPbB1QUxexA1RTfaQaT0b+tMgd5v/dR6hYh68jNA7RM7hzn3AV0GtZbkeVfbgKITiTcWnURd4FEXROfOYiNtHO6/3hdTdJUMvrWUQsOFAFRIQfHg66IEnr7zUDv0GUgtg+TKZ+ADr6zPwDgIeEN9BYKx1DzxRvpAyq+kWGDwID+XR++RaqTo6TB3porRJ9/odT8ROr2C2RN3TkGVvnk+5rxWAZZc1cd9NpfqaGPZ9dHfTA0VXzfRTyHMucdnTwA11ZCA6U9/BRJGCjm0iheJrLPfaOx3k8R+0A8cpvSf1U59Wa+z9CJisvbi/RtYleiwy0N0Ka9zaoNJMNL7Giufbg1t1nbVt5++BxryOpiZw0pqgV9Ta2cYYpAozYLpSqwOpuJBFtCK8kNoSFNCBNOvmArut8HMseRLadyDowFN4mZGFziTeoZLdOuelrqucnQHSr6Nx5Svgq895BhWiLqvW5tWRqs1NC8i6bYqUcOOT4jKb43e0fJpesvkfD0zeratpaN+3LVtX+XBgKQPBnAC5/0AFg55MG6v7evU4SFe3nZ/0p0cRNgqZQv9z+8W1Ef9UQ8GUYUvXKZN+F4XvjUBJ/AeF9wJhd4nGJYcSzmbAe8y2LRX0XuxTX2x1ZLe/h51QfAk6oTAQ+BFiYKCJtCiFtS77nnUYhal3tvio+HH+Lhb1LPCKOP6UePO8TVhyYCVPyzcTS+alyxXNUa8SKgxV7y4ZlebjOVF8Xsl0nP6Y/P3sDAVy+LRo52zA2ieFwXcz5Uk93CXx65g1w8mDXDgghpbbCh7GGInqMn5VHC7nUT61ukoous2GQsy7ACnWQ+Jz3ICtpvNJlaxt0b7VBiPxuNDvNvNEg3+pgeKGta8Vmr9p+8HYNPxl6Ac9+LRKz998spSYBqVTsPdTI/Gjx6fPByfjH84f/hs8uTPk6fPhuPx+O8sYzeV2qJnJhoU3Hov/d07kFpJjbPWa7NH4/HscePKJ8e812Dj9j1bciUFzCUqAXSn/44OROeM+53Y/Q797jKfTG6Nf3JH6lDDmptai/+3ucc0utvAJ7MfOhOfHpr4WieX0aB9bq5R/y8s3NrTvz6k60nV3ayWiSh+ZzvG9s+TkR6L2smwjkP8zQm38iR9n1xe0WhcYSgNLQBsHRWmYX7CRm13Gd32+syGkTy3bHcCEWmxMgTrJ6OR51rk5mZoLGp6RxTPPXXPEbdytHw4fMg22T4Pt/ab6LE++VYWH/hC6sWX+K62rjqjcKaI7Ths+8BY+TPSC9PEo0/VLEVK5ATyKAKUJe+3C4gXbay7cO5P7e3Q/nVz+MFUcmyy7g/WjO0Mzw1E6k+BzdHRqaj5ltA/Y/u4m072cG7DcRxePv0cqmu4+pDh+PPfvP5f+5JvKEBzE6PZlM07i/qMHEtFF7Nh36cfUBWmwnZkGgxalk//+HfHNRh0QUlbBIJj72oH1qzQzWsVIzhXeCMJ/sZNXhW/das8j7wi0KbWQFPswsU4yoUMNME380XBLc+lktRViMwQt4NeY/JD+FBiKNHRp3uOgIfApaJe1M0PerEFHCvjrufKrDyhw7z2UhNyRF1yXRBhWxlxTCWASiO2ddIj+OBIaZlUMzo4XgSouOaLOGdm0PeVQCWpfYAzOW1JvFF12gPQttK4ONkne+KmMPrwBS3/HAKdEi5yWFIZL5tlgM/SMiaVEZmgBeToA1jSRRYYZ91aK1Ncx/gR0gFrqKVLrggh93Uk9uC49vTuJF3aEHQOa2Y89A3Iv/BIAX4j9bWfDAYf9Qlcdmn1AXMvA17db1vSarU6aEUPdnleyvCqzuE9WuNlMG695V7IUNZ5bF99Id0fSdJL1BjTp9ectjKEKfxhN6TTUYnKjs7SsOBHp9PX8RV8AJ9++ye8Qe40lGaVkrWoHao1LNqryHMp8slt3SMWN0G8DiV5vEjJ1+xkWw9+KHn49Nu/PLzFFW06UkWRKYPBtM6VLLoluB8MJvCc5qf+ajaulwuuaWT3JadUovUcB5u4ldTXQzjV67hB2448dB75dsyIjbYNt48rizjf9Dfaw61GcdD2qJboSRaBkRwBhSR8HUpn6kW6ra9MY5zDOc0IH9KWh2w7FQJsc9wuf2io36qDc5OWFWvgDsHH/c10jyV+qa01jrRotkdz0y4SUQtrpA5+AsLxedjKz/bG1LiAPDhKLuSdO7JGTBeSVImNxd0pDTTZ/sO6224dztHRhdHsbVysbNLpsk1LoGz9I2lN8Im6Fi8iuosTWXrhf9yXE5EWusq/m5+hW8oCG5TxmYoeReIRy5iSBWrff/JPX07fwPLxcEyPVAdXvqK4R29eP3/x9uwFKUONNDns4XA8HMcJ2/hQcd27ae8HpP2n7XaLbf/bvzc14Im2nCOruIzQtVnWJdh5yXoYaNL/qekqY6XxgUhub6kYL5zabOj41zriiMurjC25k6RpxKbNBkwc3wH1zb7/vv3xBr7tV6ujBrUQURM+jNvTBIqucb3389mGsEiDE0njRPE86XVyTnK2Eg7GDgK6ieO0KNCGO2n7OH96cU7gqfkprIq/qjHHV4Sr+Copmzb7EQHHs1umuF7UfEG0SeQmLTTLXVh8HWFx8w8y6qg7dvFysoL+SzYdZbi9TZB7s+no06fPcjR+bakpNlebzeY/iKFnfg==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},g=void 0,y={},v=[];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:(0,n.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(d(),{...i(49772)}),"\n",(0,n.jsx)(c(),{...i(7110)}),"\n",(0,n.jsx)(u(),{...i(78316)})]})}function x(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(T,{...e})}):T(e)}},49772(e){e.exports=JSON.parse('{"parameters":[{"name":"template_id","in":"path","description":"ID of the template that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},7110(e){e.exports=JSON.parse('{"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":false},"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":false},"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":false},"file":{"type":"string","description":"You may provide the base64 encoded PDF file to replace the existing one","format":"base64","example":""},"redirect_url":{"type":"string","description":"Specifies the URL where the signer will be redirected upon completing the document signing process.","example":""},"auto_reminder":{"type":"boolean","description":"Set to true to enable automatic reminders. Set to false to disable them (default behavior).","example":false},"remind_once_in_every":{"type":"number","description":"Number of days between reminders. This is only applicable when auto_reminder is set to true.","example":5},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"template_template_id_body"}}}}}')},78316(e){e.exports=JSON.parse('{"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"}}}}}}')}}]);