OpenSign/assets/js/5ce6d213.11cdb5b7.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3460],{78912:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>h,default:()=>y,frontMatter:()=>g,metadata:()=>i,toc:()=>T});const i=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":"eJzFWc2OG7kRfpUKL7aFHkn2jr2ITpl4HXuwhi14xjCS8UBgN0tq7rBJLsmWRhgI2EPeIKdc82h+kqDI7lbrx2M76ySX3TG7qlj//Kp0xwJfeDa5YpdYWcUDenadMYG+cNIGaTSbsMsS4b0VPCC0VHA2PQfUPFfoYW1qCAYqI+R8DVwLqBN1KBEEBi6VBzMHDt5iIeeygNDIGbKMGYuO01Xngk1YYm3vYRmz3PEKAzpS845pXiGbsFbATAqWMUlqWh5Ktq/7+U90MynSckAoeQCNKDxpnWOjLclx+GstHQo2Ca7GjPmwVnSbl5VVpAzeWmUEssmcK08ERYkVZ5M7FtY2UgYn9YJlbG5cxcP2ZLO5TvLRhz8bsSaeXVWnziylQMhRmRV0ZpOSrT/bGMFDHkAh9wGMxh5ta8AjlrHC6IA60EXcWiWL6OTRL55uuztU3eS/YBHI445CEiR6+poc/mUDyTk8umnCfPyj05dtMqZN+GYxUzIRweFS4iomlpcLDaGUHoQp6orM2+yF/Nuu6LKiL2NDPEqgo4w8lLflJspUBW8vpz3S3BiFXB9kI2UVnCQDTDyElVSqqSR4ezmFJTqqkBirIbz36HyicVigXCLwHRIojEBYSg5YcakyWJWyKCnh11DVPgDqJoca12HnuSHEJIYTOFRISH9Uowy4UmYl9QLqqNoxwSCkwyKoNaxkKE0dgAshiZ0r8AGtH/a9GLXoHHlpavf7PclhUUuBAoKpHcyNi1qi8xnYWGZkgdQ+uLogZg+ipuhGO4iU/rbOFOj91k+tV4ioJz8D1D6xc5hzH9BlUGtJnne1DSg6kXhr0UnUBR51QXTuLDbSxuH+630xRVfJ4FtLKTRcCECFFBQPvi5K4Ok7D7VDn4HUMkiufAY+8Mr6DIyDgLfUVyAYS80Tb6UPpPxKigUGD/JzefQOqUaKng5zZ6oYffKNXvcTodMrmD1xlxRU6ZvnY85rFWDJVX3cZ3OpjjaWXR/91dRQ8XUT/RTCnHt8dgqoqYYETH/6C5AwUsihVbxIZJ39RmO/myT2g37gMKX/rHbqy3pdpBcRk7Xv372GVYkOuzxEl/I6pzaYBCO9r7Hy6dbQZm1Xffvpe6Ahr4OZOaykFvg1tXaBIQaJ0iyYrsTqYCoeZAGtKD+EhjQlRDD9iqngYRvMHEu+lMY9OhrQJG5mdIEzqWe4RLfuaanrKkd3oOSbeEz5KvjaQ45hhaj7urVpZbRaQ/Mikm6rEjXs+ISo/NboHS2fprdMztczo2fbWjrqx13b9lUeDEj6YAAncNkPYOGQB+P22r5OHR7i5W33J93JQYStUrbQ//xuQX3UH/VgEFX4wmXahO914RsTcALvcMGdUOh9gmHJsZSzGfAug017Fb0X29QXWy3p7e9RFwRPok4IPARelCgoaAItakG964FHLWZR6oMtPhp+jI+7RT0rjDKuHzXuHF8TlgxY+cPC3fSiecVyVWPEi4Qac8WLG3a92WQsyLADK2Y9nDrLCfZtNpuY494a7VPaPBmPD9Fgh7QbdErtm8p5Xiu1/sP3g3fp+EtAh3vx5JWfnr6y5IhGpbNwP9OT8ZMfTh6PT8Y/Xj5+Njn94+Tps+F4PP4by9htpbbYkokGI7beS//uHUitpMZZ67XZk/F49kPjytNj3muQY9vtl1xJAXOJSgDd6b+jA9E54/5DZHuPfveZTya3xp/ekzpUznNTa/H/NveYRvcbeDr7sTPx6aGJ5zq5jMbQS3OD+n9h4dae/vUhXU+q7ma1TETxO9sxtn+ejPRY1E6GdRxxb0+4lSfp++TqmgbHCkNpaDy2dVSYRt0JG7XdZXTX6zMbRvLcsp2YIw5hZQjWT0Yjz7XIze3QWNTUZRXP/bAw1YhbOVo+Hj5mm2yfh1v7TfRYn3wriw98IfXiS3zXW1ddUDhTxHYctm3oVv6M1NGbePSpmpVBiZwgEEWAsuTddjx/0ca6C+f+TNuOtF83pR5g9mNzZ3/sZGxntGwARH9Gao6OzgzNt4SNGdtHpXSyhwIbjuPg6+nnME/D1X9QP/M4ksfnJoanqYO3FvUFeYqqKIZ330kfUBWmwnZCGAxalk9//1fHNRh0Xk5DM6GPt7UDa1bo5rWKIZkrvJWE9uLiqorfus2VR14RRlFroKFt4WJg5EIGGlgbOF1wy3OpJLUJIjPE7aDXafwQPpQYSnT06YGjMVTgEhV1lw4v68UW1qyMu5krs/KEhvLaS01ICXXJdUGEba7HsYwAGY2U1kmP4IMjrWXSzejgeBGg4pov4lyVQd9ZApWkhgDO5LQV8EbVae6l7ZxxcZJNBsXNWHTiC1p2OQQ6JfDlsKTCXDbDr8/S8iEVBpmgBeToA1jSRRYYZ7taK1PcxAASdgFrqElLrggR9nUk9uC49vSSJF3aGHQOa2Ya9A2ofe+RIvxa6hs/GQw+6hO46vLqA+ZeBrx+2DaZ1Wp10Fwe7fK8lOFVncM7tMbLYNx6y72Qoazz2JD6Qrp/JEkvUWPMn1672coQpvCH/Y1ORyUqO7pI4NiPzqbn8V17BJ9++we8Ru40lGaVsrWoHao1LNqryHMp8slt3bMUNx+8DiV5vEjJ1+wgWw9+KHn49Ns/PbzBFU32qaTIlMFgWudKFt3S1w8GE3hO80J/FRnXqQXXNKL6klMq0TqKg03cSuqbIZzpddwYbSE+nUe+HTNi62zD7eOIHvF8f4M73GoUB0uPaomeZBG8yBFQSELMoXSmXqTb+so0xjmc08zzIW01yLYzIcA2x+2yg4bYrTo4N2k4XwN3CD7uK6Z7LPFLba1xpEWzLZmbdnGGWlgjdfATEI7Pw1Z+tjeWxYXbwVFyIe/ckTViupCkSmws7k5p9sn2n8rdfutwjo4ujGZv42Jlk05XbVoCZevvSWsCRNS1eBHxWhzU0pv9p305ETuhq/zb+QW6pSywwQ2fqehRJB6xjClZoPb9R/zs5fQ1LH8YjlnWAyBfUdyj1+fPX7y5eEHKUCNNDns8HA/HcaI0PlRc927a+8Fk/22726LV//bvKw0coq3eyCouIxhtllMJSF6xHqqZ9H9auc5YaXwgkrs7Ksb3Tm02dPxrHZHB1XXGltxJ0jSizWbjI47vPPpmP3zX/lgB3/YrzVGDWtCnCfHFbWGCOTe43vu5aENgpEF+pHGieJ70OrkkOVsJB4MEQdfEcVYUaMO9tH3kPn1/SXCo+emnir8iMcdXhJT4KimbNtkR08azO6a4XtR8QbRJ5CYt8MpdoHsTgW7zBxl11B27CDhZQf8lm44y3N0lEL3ZdPTp02c5Gr+21BSb681m82//IgiM","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=a(74848),o=a(28453),p=a(33617),s=a.n(p),l=a(17543),r=a.n(l),d=a(86013),c=a.n(d),m=a(63723),u=a.n(m),b=(a(18766),a(79329),a(9303));const g={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:"eJzFWc2OG7kRfpUKL7aFHkn2jr2ITpl4HXuwhi14xjCS8UBgN0tq7rBJLsmWRhgI2EPeIKdc82h+kqDI7lbrx2M76ySX3TG7qlj//Kp0xwJfeDa5YpdYWcUDenadMYG+cNIGaTSbsMsS4b0VPCC0VHA2PQfUPFfoYW1qCAYqI+R8DVwLqBN1KBEEBi6VBzMHDt5iIeeygNDIGbKMGYuO01Xngk1YYm3vYRmz3PEKAzpS845pXiGbsFbATAqWMUlqWh5Ktq/7+U90MynSckAoeQCNKDxpnWOjLclx+GstHQo2Ca7GjPmwVnSbl5VVpAzeWmUEssmcK08ERYkVZ5M7FtY2UgYn9YJlbG5cxcP2ZLO5TvLRhz8bsSaeXVWnziylQMhRmRV0ZpOSrT/bGMFDHkAh9wGMxh5ta8AjlrHC6IA60EXcWiWL6OTRL55uuztU3eS/YBHI445CEiR6+poc/mUDyTk8umnCfPyj05dtMqZN+GYxUzIRweFS4iomlpcLDaGUHoQp6orM2+yF/Nuu6LKiL2NDPEqgo4w8lLflJspUBW8vpz3S3BiFXB9kI2UVnCQDTDyElVSqqSR4ezmFJTqqkBirIbz36HyicVigXCLwHRIojEBYSg5YcakyWJWyKCnh11DVPgDqJoca12HnuSHEJIYTOFRISH9Uowy4UmYl9QLqqNoxwSCkwyKoNaxkKE0dgAshiZ0r8AGtH/a9GLXoHHlpavf7PclhUUuBAoKpHcyNi1qi8xnYWGZkgdQ+uLogZg+ipuhGO4iU/rbOFOj91k+tV4ioJz8D1D6xc5hzH9BlUGtJnne1DSg6kXhr0UnUBR51QXTuLDbSxuH+630xRVfJ4FtLKTRcCECFFBQPvi5K4Ok7D7VDn4HUMkiufAY+8Mr6DIyDgLfUVyAYS80Tb6UPpPxKigUGD/JzefQOqUaKng5zZ6oYffKNXvcTodMrmD1xlxRU6ZvnY85rFWDJVX3cZ3OpjjaWXR/91dRQ8XUT/RTCnHt8dgqoqYYETH/6C5AwUsihVbxIZJ39RmO/myT2g37gMKX/rHbqy3pdpBcRk7Xv372GVYkOuzxEl/I6pzaYBCO9r7Hy6dbQZm1Xffvpe6Ahr4OZOaykFvg1tXaBIQaJ0iyYrsTqYCoeZAGtKD+EhjQlRDD9iqngYRvMHEu+lMY9OhrQJG5mdIEzqWe4RLfuaanrKkd3oOSbeEz5KvjaQ45hhaj7urVpZbRaQ/Mikm6rEjXs+ISo/NboHS2fprdMztczo2fbWjrqx13b9lUeDEj6YAAncNkPYOGQB+P22r5OHR7i5W33J93JQYStUrbQ//xuQX3UH/VgEFX4wmXahO914RsTcALvcMGdUOh9gmHJsZSzGfAug017Fb0X29QXWy3p7e9RFwRPok4IPARelCgoaAItakG964FHLWZR6oMtPhp+jI+7RT0rjDKuHzXuHF8TlgxY+cPC3fSiecVyVWPEi4Qac8WLG3a92WQsyLADK2Y9nDrLCfZtNpuY494a7VPaPBmPD9Fgh7QbdErtm8p5Xiu1/sP3g3fp+EtAh3vx5JWfnr6y5IhGpbNwP9OT8ZMfTh6PT8Y/Xj5+Njn94+Tps+F4PP4by9htpbbYkokGI7beS//uHUitpMZZ67XZk/F49kPjytNj3muQY9vtl1xJAXOJSgDd6b+jA9E54/5DZHuPfveZTya3xp/ekzpUznNTa/H/NveYRvcbeDr7sTPx6aGJ5zq5jMbQS3OD+n9h4dae/vUhXU+q7ma1TETxO9sxtn+ejPRY1E6GdRxxb0+4lSfp++TqmgbHCkNpaDy2dVSYRt0JG7XdZXTX6zMbRvLcsp2YIw5hZQjWT0Yjz7XIze3QWNTUZRXP/bAw1YhbOVo+Hj5mm2yfh1v7TfRYn3wriw98IfXiS3zXW1ddUDhTxHYctm3oVv6M1NGbePSpmpVBiZwgEEWAsuTddjx/0ca6C+f+TNuOtF83pR5g9mNzZ3/sZGxntGwARH9Gao6OzgzNt4SNGdtHpXSyhwIbjuPg6+nnME/D1X9QP/M4ksfnJoanqYO3FvUFeYqqKIZ330kfUBWmwnZCGAxalk9//1fHNRh0Xk5DM6GPt7UDa1bo5rWKIZkrvJWE9uLiqorfus2VR14RRlFroKFt4WJg5EIGGlgbOF1wy3OpJLUJIjPE7aDXafwQPpQYSnT06YGjMVTgEhV1lw4v68UW1qyMu5krs/KEhvLaS01ICXXJdUGEba7HsYwAGY2U1kmP4IMjrWXSzejgeBGg4pov4lyVQd9ZApWkhgDO5LQV8EbVae6l7ZxxcZJNBsXNWHTiC1p2OQQ6JfDlsKTCXDbDr8/S8iEVBpmgBeToA1jSRRYYZ7taK1PcxAASdgFrqElLrggR9nUk9uC49vSSJF3aGHQOa2Ya9A2ofe+RIvxa6hs/GQw+6hO46vLqA+ZeBrx+2DaZ1Wp10Fwe7fK8lOFVncM7tMbLYNx6y72Qoazz2JD6Qrp/JEkvUWPMn1672coQpvCH/Y1ORyUqO7pI4NiPzqbn8V17BJ9++we8Ru40lGaVsrWoHao1LNqryHMp8slt3bMUNx+8DiV5vEjJ1+wgWw9+KHn49Ns/PbzBFU32qaTIlMFgWudKFt3S1w8GE3hO80J/FRnXqQXXNKL6klMq0TqKg03cSuqbIZzpddwYbSE+nUe+HTNi62zD7eOIHvF8f4M73GoUB0uPaomeZBG8yBFQSELMoXSmXqTb+so0xjmc08zzIW01yLYzIcA2x+2yg4bYrTo4N2k4XwN3CD7uK6Z7LPFLba1xpEWzLZmbdnGGWlgjdfATEI7Pw1Z+tjeWxYXbwVFyIe/ckTViupCkSmws7k5p9sn2n8rdfutwjo4ujGZv42Jlk05XbVoCZevvSWsCRNS1eBHxWhzU0pv9p305ETuhq/zb+QW6pSywwQ2fqehRJB6xjClZoPb9R/zs5fQ1LH8YjlnWAyBfUdyj1+fPX7y5eEHKUCNNDns8HA/HcaI0PlRc927a+8Fk/22726LV//bvKw0coq3eyCouIxhtllMJSF6xHqqZ9H9auc5YaXwgkrs7Ksb3Tm02dPxrHZHB1XXGltxJ0jSizWbjI47vPPpmP3zX/lgB3/YrzVGDWtCnCfHFbWGCOTe43vu5aENgpEF+pHGieJ70OrkkOVsJB4MEQdfEcVYUaMO9tH3kPn1/SXCo+emnir8iMcdXhJT4KimbNtkR08azO6a4XtR8QbRJ5CYt8MpdoHsTgW7zBxl11B27CDhZQf8lm44y3N0lEL3ZdPTp02c5Gr+21BSb681m82//IgiM",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,f={},T=[];function x(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.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)(b.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},notify_on_signatures:{type:"boolean",example:!1,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"]}},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 y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(x,{...e})}):x(e)}}}]);