Files
OpenSign/assets/js/444a2573.fe0cb846.js
T

1 line
11 KiB
JavaScript

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5855],{34574(e,t,a){a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>g,default:()=>X,frontMatter:()=>h,metadata:()=>i,toc:()=>T});const i=JSON.parse('{"id":"API-docs/v1/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/update-template.api.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/update-template","permalink":"/docs/API-docs/v1/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":"eJzFWNtuGzkS/ZUavmwStCXZcTJYPa13JpsYY4wFXxDsOobA7i6pOWaTHJItWRAa2If9g/mD+bT5kkWR3a3WJU68M7v7YsjsYvHUqWJduGaezx0b37EbLI3kHh27T1iOLrPCeKEVG7ObAuHW5NwjtFJwNjkHVDyV6GClK/AaSp2L2Qq4yqGK0r5AyNFzIR3oGXBwBjMxExn4Rs+AJUwbtJyOOs/ZmMWt7TksYYZbXqJHSzDXTPES2Zi1CqYiZwkTBNNwX7Bd7Off08kEpN0BvuAeFGLuCHWKDVrSY/HnSljM2djbChPm/ErSaU6URhIYfDRS58jGMy4dCWQFlpyN18yvTJD0Vqg5S9hM25L7zUpd30f96Pxfdb6iPdtQJ1YvRI6QotRL6MwmkC2frY/gBfcgkTsPWmFPtjXgJUtYppVH5ekgbowUWSB5+JOj09b70HX6E2aeGLfkEi/Q0ddI+JcNJHJ4oGnMXPjR4WV1wpT2z1YzIRMRLC4ELkNgOTFX4AvhINdZVZJ59Y7Ln3dEFxV9HTXtkTlaish9fZvdJBlvweXNpCeaai2Rq71opKiCo2iADouwFFI2NwkubyawQEs3JPhqALcOrYsyFjMUCwS+JQKZzhEWggOWXMgEloXICgr4FZSV84CqiaGGOuyYG0AIYjiCfUC5cAcRJcCl1Euh5lAFaIcUQy4sZl6uYCl8oSsPPM8FbecSnEfjBn0WA4qOyBtd2d/PJId5JXLMwevKwkzbgBKtS8CEa0YWCOW8rTLa7CCvyLvBDhKl38bqDJ3b8NSyQkI9/QmgcnE7hxl3Hm0ClRLEvK2Mx7xTiY8GrUCV4UEKArnTkEgbwt3XczFBWwrvWkvJNTzPASWSUxy4KiuAx+/cVxZdAkIJL7h0CTjPS+MS0BY8PlJeAa8NJU98FM4T+KXI5+gdiM/F0RXSHcl6GGZWl8H7xI1a9QOhw+X1jrobcqpwTfmY8Up6WHBZHeZsJuTBxLLN0d91BSVfNd6PLky5w7engIruUA6T7/8GpIwAWTSSZ1Gss18r7GeTuH0vH1iM4T+trPwyrutYETFae3t1AcsCLXZxiDbGdUppMCpGqq/h5tOpvo3a7vbthu8eQl55PbVYCpXj19y1a/TBSRRmXndXrPK65F5k0KpyA2hEY0B43b8xJbxonZliwRdC25cHHRrVTbXKcCrUFBdoVz2UqipTtHsgfwzLFK85XzlI0S8RVR9bG1ZayRU0FZGwLQtUsMUJSbmN0Vso39R1wrzwW9Vj2mtHpilV97qugynOaOViIT0ZjfaLftdQNU0I3VLy2qyScvXNH1fF4/KX6hl3+ckHNzn9YChOGkhn/ulNJ6OT10fHo6PRtzfHb8enfx6/eTsYjUb/YAl7LOWmhWB50wq07MX/ewtCSaFw2rI2PRmNpq8bKk8Psdc0CO2lXnApcpgJlDnQme4PJBCt1fY/bGCewPeU+WRya/zpE6GjtIeZrlT+/zb3EKKnDTydftuZ+GbfxHMVKaNp40Y/oPpfWLixp3+8j8cT1O2oFlEofGdbxvbXo5EOs8oKvwqTzOMRN+Iofh/f3dN8UKIvNE1BpgqAaaIZs2GbXYbrXp6pGemzi3YwCuWGFd4bNx4OHVd5qh8H2qCigiB56gaZLofciOHimNXJ7g5uzDOksTp63gbn+Vyo+dO77jcUXZMbo6e2iOr8xY34AVcsaf3Ql2omwgI5VThinqLjajN9vWt93Llxd2RpJ5avG0L2WrJDY0V/qmBsa3Joxsl+C9wsHWwJm2+x9WFst+mglZ0i3+w4XFvf1ETYTAd2m/C9NKiuyVAK/sXxnoUfUWa6xLZ7a8V/+9evYUfLTED8zSf1SV1WFoxeop1VMtA4k/goqACHt4QyfOseExzyUqJzcgXUR89tIFPMhacZoulwMm54KqSgK01imnZb6GUFN4CPBfoCLX36k6XJIMcFSsoEXQuj5pvuaantw0zqpUuAQ1o5odA5QFVwlZFgG5+hU+YqzlfGCofgvCXUImLTylueeSi54vPQ6iZbLOUoBV1esDqlQc1pWcVRhB5MtA3DRTQoPFYMiMR39P5gEWiV+j+LBV2lRTOPuCTOgzGYyQSVQ4rOgyEsIsPQbldK6uwh+I36DDCaEqrgktqnPkba7i1XjrJ+xNL6oCOsaTMxAnz16tYhefhCqAc3fvXqkzqCuy6YPmLqhMf7F21aWC6Xe+ng5fae98J/qFK4QqOd8NquNrvnwhdVGlJIX0n3T9T0HhWG+OmliI2OXGduPyPR6rBAaYbX6ClC3PBsch5q0Ev47Z+/wAVyq6DQyxitWWVRrmDeHkXMRc9H2roSEoZRXvmCGM9i8DXPQsQgNU3b6W772lmcoSXygyM3xxnRqL9rYQKh/z1mUjGjKOZZqLXhfSHm3b/s6gl1D23pLmfXaBciwybzf8bDwyA8ZAmTIkPl+on47P3kAhbwejBiSa+GfIW3hxfn37378fodoaGbFRk7HowGI1oy2vmSq95RO4+auzluvWk1/ttvoE1No8l7aCQXoZNoBsjYBdyxXmka958/7xNWaOdJZL2mofTWyrqm5Z+rkN7v7hO24FYQ0tAqNFNZ3pWFz5r94qp9UITnvaQeNKit3IrKdpjoY616wNXOk259Xydt+SbEUeK7iOvohvRsNOx1gdR9xB1nWYbGPynbb7smtzcsYWnzPFuGl15m+ZIqLF9GsPG1KTQmYW3NJFfzis9JNqqs45BdbHcrD6FbaX6QUQfp2G5johX0l2w6uGG9jp1QXXfy8dNndzS8ttLkm/u6rv8NBIl6Uw==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Template","permalink":"/docs/API-docs/v1/get-template"},"next":{"title":"Delete Template","permalink":"/docs/API-docs/v1/delete-template"}}');var s=a(74848),o=a(28453),n=a(57742),p=a.n(n),l=a(78178),d=a.n(l),r=a(19624),m=a.n(r),c=a(96226),u=a.n(c),f=(a(77675),a(19365),a(51107)),b=a(21312);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:"eJzFWNtuGzkS/ZUavmwStCXZcTJYPa13JpsYY4wFXxDsOobA7i6pOWaTHJItWRAa2If9g/mD+bT5kkWR3a3WJU68M7v7YsjsYvHUqWJduGaezx0b37EbLI3kHh27T1iOLrPCeKEVG7ObAuHW5NwjtFJwNjkHVDyV6GClK/AaSp2L2Qq4yqGK0r5AyNFzIR3oGXBwBjMxExn4Rs+AJUwbtJyOOs/ZmMWt7TksYYZbXqJHSzDXTPES2Zi1CqYiZwkTBNNwX7Bd7Off08kEpN0BvuAeFGLuCHWKDVrSY/HnSljM2djbChPm/ErSaU6URhIYfDRS58jGMy4dCWQFlpyN18yvTJD0Vqg5S9hM25L7zUpd30f96Pxfdb6iPdtQJ1YvRI6QotRL6MwmkC2frY/gBfcgkTsPWmFPtjXgJUtYppVH5ekgbowUWSB5+JOj09b70HX6E2aeGLfkEi/Q0ddI+JcNJHJ4oGnMXPjR4WV1wpT2z1YzIRMRLC4ELkNgOTFX4AvhINdZVZJ59Y7Ln3dEFxV9HTXtkTlaish9fZvdJBlvweXNpCeaai2Rq71opKiCo2iADouwFFI2NwkubyawQEs3JPhqALcOrYsyFjMUCwS+JQKZzhEWggOWXMgEloXICgr4FZSV84CqiaGGOuyYG0AIYjiCfUC5cAcRJcCl1Euh5lAFaIcUQy4sZl6uYCl8oSsPPM8FbecSnEfjBn0WA4qOyBtd2d/PJId5JXLMwevKwkzbgBKtS8CEa0YWCOW8rTLa7CCvyLvBDhKl38bqDJ3b8NSyQkI9/QmgcnE7hxl3Hm0ClRLEvK2Mx7xTiY8GrUCV4UEKArnTkEgbwt3XczFBWwrvWkvJNTzPASWSUxy4KiuAx+/cVxZdAkIJL7h0CTjPS+MS0BY8PlJeAa8NJU98FM4T+KXI5+gdiM/F0RXSHcl6GGZWl8H7xI1a9QOhw+X1jrobcqpwTfmY8Up6WHBZHeZsJuTBxLLN0d91BSVfNd6PLky5w7engIruUA6T7/8GpIwAWTSSZ1Gss18r7GeTuH0vH1iM4T+trPwyrutYETFae3t1AcsCLXZxiDbGdUppMCpGqq/h5tOpvo3a7vbthu8eQl55PbVYCpXj19y1a/TBSRRmXndXrPK65F5k0KpyA2hEY0B43b8xJbxonZliwRdC25cHHRrVTbXKcCrUFBdoVz2UqipTtHsgfwzLFK85XzlI0S8RVR9bG1ZayRU0FZGwLQtUsMUJSbmN0Vso39R1wrzwW9Vj2mtHpilV97qugynOaOViIT0ZjfaLftdQNU0I3VLy2qyScvXNH1fF4/KX6hl3+ckHNzn9YChOGkhn/ulNJ6OT10fHo6PRtzfHb8enfx6/eTsYjUb/YAl7LOWmhWB50wq07MX/ewtCSaFw2rI2PRmNpq8bKk8Psdc0CO2lXnApcpgJlDnQme4PJBCt1fY/bGCewPeU+WRya/zpE6GjtIeZrlT+/zb3EKKnDTydftuZ+GbfxHMVKaNp40Y/oPpfWLixp3+8j8cT1O2oFlEofGdbxvbXo5EOs8oKvwqTzOMRN+Iofh/f3dN8UKIvNE1BpgqAaaIZs2GbXYbrXp6pGemzi3YwCuWGFd4bNx4OHVd5qh8H2qCigiB56gaZLofciOHimNXJ7g5uzDOksTp63gbn+Vyo+dO77jcUXZMbo6e2iOr8xY34AVcsaf3Ql2omwgI5VThinqLjajN9vWt93Llxd2RpJ5avG0L2WrJDY0V/qmBsa3Joxsl+C9wsHWwJm2+x9WFst+mglZ0i3+w4XFvf1ETYTAd2m/C9NKiuyVAK/sXxnoUfUWa6xLZ7a8V/+9evYUfLTED8zSf1SV1WFoxeop1VMtA4k/goqACHt4QyfOseExzyUqJzcgXUR89tIFPMhacZoulwMm54KqSgK01imnZb6GUFN4CPBfoCLX36k6XJIMcFSsoEXQuj5pvuaantw0zqpUuAQ1o5odA5QFVwlZFgG5+hU+YqzlfGCofgvCXUImLTylueeSi54vPQ6iZbLOUoBV1esDqlQc1pWcVRhB5MtA3DRTQoPFYMiMR39P5gEWiV+j+LBV2lRTOPuCTOgzGYyQSVQ4rOgyEsIsPQbldK6uwh+I36DDCaEqrgktqnPkba7i1XjrJ+xNL6oCOsaTMxAnz16tYhefhCqAc3fvXqkzqCuy6YPmLqhMf7F21aWC6Xe+ng5fae98J/qFK4QqOd8NquNrvnwhdVGlJIX0n3T9T0HhWG+OmliI2OXGduPyPR6rBAaYbX6ClC3PBsch5q0Ev47Z+/wAVyq6DQyxitWWVRrmDeHkXMRc9H2roSEoZRXvmCGM9i8DXPQsQgNU3b6W772lmcoSXygyM3xxnRqL9rYQKh/z1mUjGjKOZZqLXhfSHm3b/s6gl1D23pLmfXaBciwybzf8bDwyA8ZAmTIkPl+on47P3kAhbwejBiSa+GfIW3hxfn37378fodoaGbFRk7HowGI1oy2vmSq95RO4+auzluvWk1/ttvoE1No8l7aCQXoZNoBsjYBdyxXmka958/7xNWaOdJZL2mofTWyrqm5Z+rkN7v7hO24FYQ0tAqNFNZ3pWFz5r94qp9UITnvaQeNKit3IrKdpjoY616wNXOk259Xydt+SbEUeK7iOvohvRsNOx1gdR9xB1nWYbGPynbb7smtzcsYWnzPFuGl15m+ZIqLF9GsPG1KTQmYW3NJFfzis9JNqqs45BdbHcrD6FbaX6QUQfp2G5johX0l2w6uGG9jp1QXXfy8dNndzS8ttLkm/u6rv8NBIl6Uw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1/opensign-api-v-1",custom_edit_url:null},g=void 0,y={},T=[];function w(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Template"}),"\n",(0,s.jsx)(p(),{method:"put",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,s.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,s.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,s.jsx)(d(),{...a(16973)}),"\n",(0,s.jsx)(m(),{...a(13631)}),"\n",(0,s.jsx)(u(),{...a(23505)})]})}function X(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(w,{...e})}):w(e)}},16973(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"}}]}')},13631(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}},"title":"template_template_id_body"}}}}}')},23505(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"}}}}}}')}}]);