OpenSign/assets/js/5ce6d213.c87a9aec.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>v,contentTitle:()=>f,default:()=>x,frontMatter:()=>b,metadata:()=>a,toc:()=>y});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":"eJzFWV9v3LgR/ypTvjQx5N1Nzsmh+1Q3lybGpckithG0jrGgpNGKZ4rkkdSuFwsB99Bv0Ke+9qPlkxRDSlrtnzhJ79q+GDY1M5x/nPnNeMM8Xzg2vWFXWBnJPTp2m7AcXWaF8UIrNmVXJcK1yblH6KjgfHYBqHgq0cFa1+A1VDoXxRq4yqGO1L5EyNFzIR3oAjg4g5koRAa+lTNiCdMGLaerLnI2ZZG1u4clzHDLK/RoSc0NU7xCNmWdgLnIWcIEqWm4L9m+7hc/0M2kSMcBvuQeFGLuSOsUW21JjsWfa2ExZ1Nva0yY82tJtzlRGUnK4L2ROkc2Lbh0RJCVWHE23TC/NoHSW6EWLGGFthX325OmuY3y0fk/6XxNPLuqzqxeihwhRalX0JtNSnb+7GIEj7gHidx50AoHtJ0Bj1nCMq08Kk8XcWOkyIKTxz85um1zqLpOf8LMk8cthcQLdPQ1OvzLBpJzeHDTlLnwS68vaxKmtP9mMTMyEcHiUuAqJJYTCwW+FA5yndUVmdfshfzbruizYiijIR6Zo6WMPJS35SbK+AreXc0GpKnWErk6yEbKKjiNBuhwCCshZfuS4N3VDJZo6YWEWI3g2qF1kcZihmKJwHdIINM5wlJwwIoLmcCqFFlJCb+GqnYeULU51LoOe8+NICQxnMKhQrlwRzVKgEupV0ItoA6qHRMMubCYebmGlfClrj3wPBfEziU4j8aNhl4MWvSOvNK1/fWe5LCoRY45eF1bKLQNWqJ1CZjwzMgCoZy3dUbMDvKaohvsIFL63VidoXNbP3VeIaKB/ARQucjOoeDOo02gVoI8b2vjMe9F4r1BK1BleNQFwbnzUEhbh7uv98UMbSW86yyl0PA8B5RIQXHg6qwEHr9zX1t0CQglvODSJeA8r4xLQFvweE91Bbw2VDzxXjhPyq9EvkDvQHwuj94jvZFsoENhdRWiT75R62Ei9Hp5vSfuioIqXNs+Cl5LD0su6+M+K4Q8Wlh2ffRXXUPF1230YwhT7vD5GaCiN5TD7Ic/AwkjhSwaybNI1tuvFQ6rSWQ/qAcWY/rPayu/rNdl7IgYrb1+/wZWJVrs8xBtzOuUymAUjNRfw8unW32Xtf3r20/fAw157fXcYiVUjl/z1i7RhyBRmnndP7Ha64p7kUEnyo2gJY0J4fXwxVTwqAtmiiVfCm0fHw1oFDfXKsO5UHNcol0PtFR1laI9UPJtOKZ8zfnaQYp+haiGunVppZVcQ9sRSbdViQp2fEJUbmv0jpbPmiZhXvid7jEfwJF5St29aZpgijNaudhIn04mh02/B1QtCKFXSlErainXv/vtung8/lI/4y5/+trNzl4bypNWpXP/MNPTydPvTp9MTiffXz15Pj37w/TZ89FkMvkbS9h9JbcQguUtFOi8F/8eHAglhcJ557X508lk/l3ryrNj3msBQveol1yKHAqBMge60/2GDkRrtf0PAcwD+j1kPpncGX/2QOoo7aHQtcr/3+Ye0+hhA8/m3/cmPjs08UJFl9G0caXvUP0vLNzaM7zex+tJ1d2sFpEofGc7xg7Po5EOs9oKvw6TzP0pN+I0fp/e3NJ8UKEvNU1Bpg4K00QzZeOuuow3gzrTMJJnl91gtFezV3yxQPu6ToP257XX8Bed3UUTQ2tipffGTcfjpbA+Shq5yFbW6SjT1XhmORWit3x5x+1YG1TjJ6PJaMKaZLMnxHGVp/p+RETUgSRPXZDBjRgvn4yeHOHhxnwTPdan38riPF8ItfgS3+02NpeUPzFFdiLUJwo34kdcs6RLgCFVO4qWyKm1UsgpLd9vx76XXXL1+bM/K3Wj0tdNPwdY8Ng8MxxnGNsZWdo5doi926OjWLT9FjEXY/toh0720EXLcbypP2vIYYUO3m3fzTuD6pIMpbwN0dm38QPKTFfYAceTk47l09//1XOdnPROirPUR/VRvastGL1CW9QyeLSQeC8IBIR9RhW+9QsNh7yS6JxcA2H5hQ1+FQvhaY5pUVbGDU+FFFRWiEwTt4VBZXIj+FCiL9HSp99bmk5yXKKkatTDKLXYIriVtneF1CuXAIe0dkKhc4Cq5Cojwi5VA1rnKs54xgqH4LwlrUXUTStveeah4oovAtxOYOisHKWgAgJWpzQsOi3rOA7R0kbbMOBEg8LCJDjxJe1ALAKdEga1WNK7WrYzkUviTBrzmkxQOaToPBjSRWQYIH+tpM7uQgCpxIDRVNQFlwThhjoSu7dcOeo8UZcuBr3DWqiLUcGTk2uHFOE3Qt256cnJR3UKN31efcDUCY+3j7oasVqtDmrD412eV8JTKX2PRjvhtV1vuRfCd+VyKKT/I0p6hQpD/gyqxVZGrjN3WJ7odFyiNONL9JQhbnw+uwh98DF8+uUf8Aa5VVDqVczWrLYo17DoriLPxchHt/VtLAzEvPYleTyLydeupjoPfii5//TLPx28xRUNfPFJkSknJ7M6lSLrd4Hu5GQKLyzubqjCli3jiiYXV3JKJdpScDCRWwp1N4JztQ6LhLApCMlA54Fvx4xQ+bpwuzC55WFEHSz2RluNwrzhUC7RkSyCIykC5oIQti+trhfxtqEyrXEWCxq4PsRhl2w7z3Mw7XE3A9Nss1UHCx1ntjVwi+DCGDvbYwlfamO0JS3aIbrQ3T4FVW60UN5NIbe88Fv5yTbRM3Jz2MMcHEUX8t4dSSumD0l8ia3F/enoI/WHvU63W28tFmjpwmD2Ni5GtOl006UlULb+mrQmAEVVi2cB34WdVmy5f9yXE7AW2sq9Ky7RLkWGbdv/zIseB+IxS5gUGSo37MHnr2ZvYPndaLKDjb7icY/fXLx4+fbyJSlDhTQ6rMNIzGjnK64GN+3t0fd722aLbv/ba/cWzdCyZ2wkFwG8tjuLCDxv2ACUTIcb99uEldp5Itls6DFeW9k0dPxzHRr7zW3CltwK0jSi07gIyHtA8FmzH73vdtjwbcv7owZ1mE0RYAtLpIhS7nC991+E5rZJOuBGGkeKF1Gv0yuSs5VwMHgQ8owc51mGxj9IO0T6s+srlrC0/Y9AFf65wCxfEbbiq6hsXHAGSBrONkxytaj5gmijyCbudcpdnHoXcGr7Cxl11B27ADZaQT/JpqMMm03EwE3T08dPn+Vo/dpRU2xum6b5N8K5WOs=","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),o=i(28453),p=i(33617),s=i.n(p),l=i(17543),r=i.n(l),d=i(86013),c=i.n(d),m=i(63723),u=i.n(m),h=(i(18766),i(79329),i(9303));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:"eJzFWV9v3LgR/ypTvjQx5N1Nzsmh+1Q3lybGpckithG0jrGgpNGKZ4rkkdSuFwsB99Bv0Ke+9qPlkxRDSlrtnzhJ79q+GDY1M5x/nPnNeMM8Xzg2vWFXWBnJPTp2m7AcXWaF8UIrNmVXJcK1yblH6KjgfHYBqHgq0cFa1+A1VDoXxRq4yqGO1L5EyNFzIR3oAjg4g5koRAa+lTNiCdMGLaerLnI2ZZG1u4clzHDLK/RoSc0NU7xCNmWdgLnIWcIEqWm4L9m+7hc/0M2kSMcBvuQeFGLuSOsUW21JjsWfa2ExZ1Nva0yY82tJtzlRGUnK4L2ROkc2Lbh0RJCVWHE23TC/NoHSW6EWLGGFthX325OmuY3y0fk/6XxNPLuqzqxeihwhRalX0JtNSnb+7GIEj7gHidx50AoHtJ0Bj1nCMq08Kk8XcWOkyIKTxz85um1zqLpOf8LMk8cthcQLdPQ1OvzLBpJzeHDTlLnwS68vaxKmtP9mMTMyEcHiUuAqJJYTCwW+FA5yndUVmdfshfzbruizYiijIR6Zo6WMPJS35SbK+AreXc0GpKnWErk6yEbKKjiNBuhwCCshZfuS4N3VDJZo6YWEWI3g2qF1kcZihmKJwHdIINM5wlJwwIoLmcCqFFlJCb+GqnYeULU51LoOe8+NICQxnMKhQrlwRzVKgEupV0ItoA6qHRMMubCYebmGlfClrj3wPBfEziU4j8aNhl4MWvSOvNK1/fWe5LCoRY45eF1bKLQNWqJ1CZjwzMgCoZy3dUbMDvKaohvsIFL63VidoXNbP3VeIaKB/ARQucjOoeDOo02gVoI8b2vjMe9F4r1BK1BleNQFwbnzUEhbh7uv98UMbSW86yyl0PA8B5RIQXHg6qwEHr9zX1t0CQglvODSJeA8r4xLQFvweE91Bbw2VDzxXjhPyq9EvkDvQHwuj94jvZFsoENhdRWiT75R62Ei9Hp5vSfuioIqXNs+Cl5LD0su6+M+K4Q8Wlh2ffRXXUPF1230YwhT7vD5GaCiN5TD7Ic/AwkjhSwaybNI1tuvFQ6rSWQ/qAcWY/rPayu/rNdl7IgYrb1+/wZWJVrs8xBtzOuUymAUjNRfw8unW32Xtf3r20/fAw157fXcYiVUjl/z1i7RhyBRmnndP7Ha64p7kUEnyo2gJY0J4fXwxVTwqAtmiiVfCm0fHw1oFDfXKsO5UHNcol0PtFR1laI9UPJtOKZ8zfnaQYp+haiGunVppZVcQ9sRSbdViQp2fEJUbmv0jpbPmiZhXvid7jEfwJF5St29aZpgijNaudhIn04mh02/B1QtCKFXSlErainXv/vtung8/lI/4y5/+trNzl4bypNWpXP/MNPTydPvTp9MTiffXz15Pj37w/TZ89FkMvkbS9h9JbcQguUtFOi8F/8eHAglhcJ557X508lk/l3ryrNj3msBQveol1yKHAqBMge60/2GDkRrtf0PAcwD+j1kPpncGX/2QOoo7aHQtcr/3+Ye0+hhA8/m3/cmPjs08UJFl9G0caXvUP0vLNzaM7zex+tJ1d2sFpEofGc7xg7Po5EOs9oKvw6TzP0pN+I0fp/e3NJ8UKEvNU1Bpg4K00QzZeOuuow3gzrTMJJnl91gtFezV3yxQPu6ToP257XX8Bed3UUTQ2tipffGTcfjpbA+Shq5yFbW6SjT1XhmORWit3x5x+1YG1TjJ6PJaMKaZLMnxHGVp/p+RETUgSRPXZDBjRgvn4yeHOHhxnwTPdan38riPF8ItfgS3+02NpeUPzFFdiLUJwo34kdcs6RLgCFVO4qWyKm1UsgpLd9vx76XXXL1+bM/K3Wj0tdNPwdY8Ng8MxxnGNsZWdo5doi926OjWLT9FjEXY/toh0720EXLcbypP2vIYYUO3m3fzTuD6pIMpbwN0dm38QPKTFfYAceTk47l09//1XOdnPROirPUR/VRvastGL1CW9QyeLSQeC8IBIR9RhW+9QsNh7yS6JxcA2H5hQ1+FQvhaY5pUVbGDU+FFFRWiEwTt4VBZXIj+FCiL9HSp99bmk5yXKKkatTDKLXYIriVtneF1CuXAIe0dkKhc4Cq5Cojwi5VA1rnKs54xgqH4LwlrUXUTStveeah4oovAtxOYOisHKWgAgJWpzQsOi3rOA7R0kbbMOBEg8LCJDjxJe1ALAKdEga1WNK7WrYzkUviTBrzmkxQOaToPBjSRWQYIH+tpM7uQgCpxIDRVNQFlwThhjoSu7dcOeo8UZcuBr3DWqiLUcGTk2uHFOE3Qt256cnJR3UKN31efcDUCY+3j7oasVqtDmrD412eV8JTKX2PRjvhtV1vuRfCd+VyKKT/I0p6hQpD/gyqxVZGrjN3WJ7odFyiNONL9JQhbnw+uwh98DF8+uUf8Aa5VVDqVczWrLYo17DoriLPxchHt/VtLAzEvPYleTyLydeupjoPfii5//TLPx28xRUNfPFJkSknJ7M6lSLrd4Hu5GQKLyzubqjCli3jiiYXV3JKJdpScDCRWwp1N4JztQ6LhLApCMlA54Fvx4xQ+bpwuzC55WFEHSz2RluNwrzhUC7RkSyCIykC5oIQti+trhfxtqEyrXEWCxq4PsRhl2w7z3Mw7XE3A9Nss1UHCx1ntjVwi+DCGDvbYwlfamO0JS3aIbrQ3T4FVW60UN5NIbe88Fv5yTbRM3Jz2MMcHEUX8t4dSSumD0l8ia3F/enoI/WHvU63W28tFmjpwmD2Ni5GtOl006UlULb+mrQmAEVVi2cB34WdVmy5f9yXE7AW2sq9Ky7RLkWGbdv/zIseB+IxS5gUGSo37MHnr2ZvYPndaLKDjb7icY/fXLx4+fbyJSlDhTQ6rMNIzGjnK64GN+3t0fd722aLbv/ba/cWzdCyZ2wkFwG8tjuLCDxv2ACUTIcb99uEldp5Itls6DFeW9k0dPxzHRr7zW3CltwK0jSi07gIyHtA8FmzH73vdtjwbcv7owZ1mE0RYAtLpIhS7nC991+E5rZJOuBGGkeKF1Gv0yuSs5VwMHgQ8owc51mGxj9IO0T6s+srlrC0/Y9AFf65wCxfEbbiq6hsXHAGSBrONkxytaj5gmijyCbudcpdnHoXcGr7Cxl11B27ADZaQT/JpqMMm03EwE3T08dPn+Vo/dpRU2xum6b5N8K5WOs=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},f=void 0,v={},y=[];function g(e){const t={p:"p",...(0,o.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)(s(),{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)(r(),{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:""},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:!1},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}},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 x(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(g,{...e})}):g(e)}}}]);