OpenSign/assets/js/da66eb9c.ddb58336.js

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2703],{37055(e,t,n){n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>v,default:()=>P,frontMatter:()=>g,metadata:()=>i,toc:()=>w});const i=JSON.parse('{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","source":"@site/docs/API-docs/v1.1/update-document.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/update-document","permalink":"/docs/API-docs/v1.1/update-document","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar_label":"Update Document","hide_title":true,"hide_table_of_contents":true,"api":"eJzdWc2OG7kRfpUKL7aFHkm2xxtEp0y8hj2IYQvzAwMZDwSqWa3mDpvsJdnSCIKAPeQNcso1j+YnCYrsP/3M2M4aCZCLrekuFqu+Kha/qt4wzxeOTW7YzyatCtTesduECXSplaWXRrMJu8oRrkvBPUIjBWfTc+BKmZWDyqF14A0URshsDVwLqKK4zxEEei6VA5MBB1diKjOZgqgVDeGDCYLcg8+lC4qNVutGuzeNMg4ZrqDklhfo0boE1qaClGttPKQ514u4YSYVgtEpgvTRgsZo6SC1yD2KIUuYKdFycvFcsAmLmzT+sYR1G7HJzYZpXiCbsEbXTAqWMEnwlNznbB+z85/J4Z3dg48aUQSn5lj7RXos/lpJi4JNvK0wYc6vFe3mZFEqZAnD+1IZgWySceVIIM2x4GyyYX5dBklvpV6whGXGFtx3T7bb26gfnf+LEWtas2vq1JqlFAhzVKaHbw95j0WpuEcHT7kHhdx5MBp7so0Dz1jCUqM9QTjZMF6WSqYB5NEvjnbbHJpu5r9gGhC3FBIv0dHbCPjXHSRweIBpwlz40ULOtgnTxn+3mim5iGBxKXEV8tnJhY752de9g+P3bdFmRV/HltYogZYy8lBft5okUfO5wo9X057o3BiFXB9kI2UVnEQHTHgIK6kURB3w8WoKS7R0MEOshnAdznSQsZiiXNLx64tAagTCUnLAgkuVwCqXaU4Jv4aich5Q1zlUQ4e9Ix+SGE7g0CAh3VGLklgOpF505eZAMQhpMfVqDSvpc1N54EJIWs4VOI+lG/ZRDFa0QF6Zyv5+JDksKilQgDeVhczYYGUoVmU4ZuSB1M7bKqXFDkRF0Q1+kCj9Lq1J0bkOpwYVEurpTwC1i8s5ZNx5tAlUWhLytio9ilYl3pdoJeoUj0IQwJ2F+l0D7r4diynaQnrXeEqh4UIAKgz3CbgqzYHH99xXFl0CUksvuXIJOM+L0iVgLHi8p7oC3pRUPPFeOk/Gr6RYoHcgH8qjC6QzkvZsyKwpQvQJG73uJ0Jrlzd76q4oqNLVt1bGK+VhyVV1HDOLMd1mlVXHTusuVpfx4sOo/friPaxytNjGHW3MozmVnagY6RoNJ4029k2WtNm+ny4HFYJX3swsFlIL/JbcvkQfQKGwetOmdOVNwb1MoVHlhlCLxgB408/QAp424M0x50tp7LMHACR1M7qpZ1LPcIl23bNSV8Uc7YGRH8Jjyg/B1w7m6FeIum9bE8bIIuINRLatctSwgwlJuc7pHStfxbtDZuuZ0bMud4/iuOvbvsmDAWkfDOAErvoBDFzE2L0yq2NFhbB5U23JdgKIKFTMFvrP7SbwZ/1ZDwbBhK9sRozpB21I9G0CF7jgVih0LtKeCCzlbAK8zWDTbEX1uUt90VlJd21POiU6EGxC4N7zNEdBQRNYohZUK5441GIWtD7p+Mjwc7hMS9Sz1Chj+1Hj1vI1cTePhTs8uNteNG/YXFUY+BmxtLni6R273W4T5qXfucZnPV44mxPN2m63IcddabSLafNiPD5kXy2jrtkglUs6zlml1PoPP45OxcdfIxbciRfv3PT0XUlA1Cad+ccXvRi/eHnyfHwy/uPV858mp3+avPppOB6P/8YSdl+ojssx0sb66IW/ew+kVlLjrEFt9mI8nr2soTw9hl7N1Mqawi65kgIyiUoA7el+IIBorbH/IZN8xL7H3CeXG+dPH0kdOs6ZqbT4X7t7zKLHHTydnbYuvjp08VxHyKgrvDJ3qP8bHnb+9Lf3cXsydTerZRQK79mOs/3n0UmHaWWlX4eW8v6El/Ikvp/c3FKjVqDPDbWjZRV7UJ+zCRs11WW06dWZLSN9dtl0qIGHsNz70k1GI8e1mJv7oSlRU5VVfO6GqSlGvJSj5fPhc7ZN9tfwsvwueaxOvneJ83wh9eJr6247qC4pnDFiO4B1Bb2Uf0Wq6HU8+lJ1i54jJwpEEaAsueja4TdNrNtw7veQTQv5bV3h/t1/tM/rt3mM7bRyNYHo9yT1o6McvX63y0VJ5R73a+WOUa5XDzGdelX/Gn3gSiScMxOCUmf/xxL1JeFDZycEdR+aT6hSU2DDwweDZsmXv/+rXTUYtNjG1pQ4x8fKQmlWaLNKhUBkCu8lcTxahkV458J4iPpE5AUxE7UGao0WltiEkAvpqS2sSXTKSz6XSlJxIDFDqy306osbwqccfY6WXj2x1OwJXKKimtKyZL3oyMzK2LuMhljEgeaVk5r4Eeqc65QEmwwPzQ/RMGrcSisdgvOWrJbRNqO95amHgmu+CN1LAn2wBCpJZQCsmVPv7YyqYndJozdjQ78YHQrzpwDiGxopWQR6SpTLYk7HcVm3mC6JLX48DuSCFjBH56EkW2SKcTanlUnv4tytUgpKQ6VZckU8sG8jLfeWa0f3R7SliUELWN3JoKup7LVDivB7qe/cZDD4rE/gps2rTzh30uPt06a0rFarg5LybHfNW+nfVXO4wNI46Y1dd6sX0ufVPJShvpL2j6jpLWoM+dMrMp0OYVJ3WNXo6ShHVY4uIyV2o7PpebjNnsGX3/4B75FbDblZxWxNK4tqDYtmK0IuRj7C1l5GYb7AK58T4mlMvnrS1yD4Kef+y2//dPABV9Q/xyNFrgwG02quZApXzXBvMJjA6zAe7Q38wtAy5ZoaU5dzSiUa+nAo42ol9d0QzvQ6zGU6Yk/Pw7odN0LBbMLtYM4dBhZPK5o9h51FoZ10qJbomjnvHAGFJJ7sc2uqRdytb0ztnMWMOp1PcXZAvp0JAWX9uBkpUOvamYOZiS35GrhFcGEqMN1bEt5UZWksWVHPJDLTjKdQi9JI7d0EhOWZ7/Qne81YGGsdPIoQ8haOpFbThiSexNrj9il1PMn+Bblbby1maGnD4HYXl1LW6XTTpCVQtv6etCYaRFWLp4GlhfYs3tR/3tcTGBPawn3MLtEuZYo1W3jgRI+C8IglTMkUtetf3Wdvp+9h+XI4ZkmPdnzD4R69P3/95sPlGzKGCmkE7PlwPByHPtI4X3Dd22nvc8j+3bbpOOr/69eTmnzRzG5UKi4D9a1HYZG23rAeK5r0P5zcJiw3zpPIZkNF4Nqq7ZYe/1oFRnJzm7Alt5JIUOC29XxJHJ+w9OF+etF8ioDv+wZz1KGGYmril2EWGOnVHa73PgZtiQTVPJMsjhKvo10nV6Sn03DQthBRjivO0hRL/6hsv0+YXl8RDas/7BThGxGzfEUMja+isXFOHRh0eLZhiutFxRckG1Vu47gw36XVd4FW1z/IqaNw7PLt6AX9Sz4dXbDZRMq+3bby8dWDK2pcG2mKze12u/037lUr3g==","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 Document","permalink":"/docs/API-docs/v1.1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.1/revokedocument"}}');var o=n(74848),s=n(28453),a=n(57742),d=n.n(a),l=n(78178),p=n.n(l),r=n(19624),c=n.n(r),u=n(96226),m=n.n(u),h=(n(77675),n(19365),n(51107)),b=n(21312);const g={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdWc2OG7kRfpUKL7aFHkm2xxtEp0y8hj2IYQvzAwMZDwSqWa3mDpvsJdnSCIKAPeQNcso1j+YnCYrsP/3M2M4aCZCLrekuFqu+Kha/qt4wzxeOTW7YzyatCtTesduECXSplaWXRrMJu8oRrkvBPUIjBWfTc+BKmZWDyqF14A0URshsDVwLqKK4zxEEei6VA5MBB1diKjOZgqgVDeGDCYLcg8+lC4qNVutGuzeNMg4ZrqDklhfo0boE1qaClGttPKQ514u4YSYVgtEpgvTRgsZo6SC1yD2KIUuYKdFycvFcsAmLmzT+sYR1G7HJzYZpXiCbsEbXTAqWMEnwlNznbB+z85/J4Z3dg48aUQSn5lj7RXos/lpJi4JNvK0wYc6vFe3mZFEqZAnD+1IZgWySceVIIM2x4GyyYX5dBklvpV6whGXGFtx3T7bb26gfnf+LEWtas2vq1JqlFAhzVKaHbw95j0WpuEcHT7kHhdx5MBp7so0Dz1jCUqM9QTjZMF6WSqYB5NEvjnbbHJpu5r9gGhC3FBIv0dHbCPjXHSRweIBpwlz40ULOtgnTxn+3mim5iGBxKXEV8tnJhY752de9g+P3bdFmRV/HltYogZYy8lBft5okUfO5wo9X057o3BiFXB9kI2UVnEQHTHgIK6kURB3w8WoKS7R0MEOshnAdznSQsZiiXNLx64tAagTCUnLAgkuVwCqXaU4Jv4aich5Q1zlUQ4e9Ix+SGE7g0CAh3VGLklgOpF505eZAMQhpMfVqDSvpc1N54EJIWs4VOI+lG/ZRDFa0QF6Zyv5+JDksKilQgDeVhczYYGUoVmU4ZuSB1M7bKqXFDkRF0Q1+kCj9Lq1J0bkOpwYVEurpTwC1i8s5ZNx5tAlUWhLytio9ilYl3pdoJeoUj0IQwJ2F+l0D7r4diynaQnrXeEqh4UIAKgz3CbgqzYHH99xXFl0CUksvuXIJOM+L0iVgLHi8p7oC3pRUPPFeOk/Gr6RYoHcgH8qjC6QzkvZsyKwpQvQJG73uJ0Jrlzd76q4oqNLVt1bGK+VhyVV1HDOLMd1mlVXHTusuVpfx4sOo/friPaxytNjGHW3MozmVnagY6RoNJ4029k2WtNm+ny4HFYJX3swsFlIL/JbcvkQfQKGwetOmdOVNwb1MoVHlhlCLxgB408/QAp424M0x50tp7LMHACR1M7qpZ1LPcIl23bNSV8Uc7YGRH8Jjyg/B1w7m6FeIum9bE8bIIuINRLatctSwgwlJuc7pHStfxbtDZuuZ0bMud4/iuOvbvsmDAWkfDOAErvoBDFzE2L0yq2NFhbB5U23JdgKIKFTMFvrP7SbwZ/1ZDwbBhK9sRozpB21I9G0CF7jgVih0LtKeCCzlbAK8zWDTbEX1uUt90VlJd21POiU6EGxC4N7zNEdBQRNYohZUK5441GIWtD7p+Mjwc7hMS9Sz1Chj+1Hj1vI1cTePhTs8uNteNG/YXFUY+BmxtLni6R273W4T5qXfucZnPV44mxPN2m63IcddabSLafNiPD5kXy2jrtkglUs6zlml1PoPP45OxcdfIxbciRfv3PT0XUlA1Cad+ccXvRi/eHnyfHwy/uPV858mp3+avPppOB6P/8YSdl+ojssx0sb66IW/ew+kVlLjrEFt9mI8nr2soTw9hl7N1Mqawi65kgIyiUoA7el+IIBorbH/IZN8xL7H3CeXG+dPH0kdOs6ZqbT4X7t7zKLHHTydnbYuvjp08VxHyKgrvDJ3qP8bHnb+9Lf3cXsydTerZRQK79mOs/3n0UmHaWWlX4eW8v6El/Ikvp/c3FKjVqDPDbWjZRV7UJ+zCRs11WW06dWZLSN9dtl0qIGHsNz70k1GI8e1mJv7oSlRU5VVfO6GqSlGvJSj5fPhc7ZN9tfwsvwueaxOvneJ83wh9eJr6247qC4pnDFiO4B1Bb2Uf0Wq6HU8+lJ1i54jJwpEEaAsueja4TdNrNtw7veQTQv5bV3h/t1/tM/rt3mM7bRyNYHo9yT1o6McvX63y0VJ5R73a+WOUa5XDzGdelX/Gn3gSiScMxOCUmf/xxL1JeFDZycEdR+aT6hSU2DDwweDZsmXv/+rXTUYtNjG1pQ4x8fKQmlWaLNKhUBkCu8lcTxahkV458J4iPpE5AUxE7UGao0WltiEkAvpqS2sSXTKSz6XSlJxIDFDqy306osbwqccfY6WXj2x1OwJXKKimtKyZL3oyMzK2LuMhljEgeaVk5r4Eeqc65QEmwwPzQ/RMGrcSisdgvOWrJbRNqO95amHgmu+CN1LAn2wBCpJZQCsmVPv7YyqYndJozdjQ78YHQrzpwDiGxopWQR6SpTLYk7HcVm3mC6JLX48DuSCFjBH56EkW2SKcTanlUnv4tytUgpKQ6VZckU8sG8jLfeWa0f3R7SliUELWN3JoKup7LVDivB7qe/cZDD4rE/gps2rTzh30uPt06a0rFarg5LybHfNW+nfVXO4wNI46Y1dd6sX0ufVPJShvpL2j6jpLWoM+dMrMp0OYVJ3WNXo6ShHVY4uIyV2o7PpebjNnsGX3/4B75FbDblZxWxNK4tqDYtmK0IuRj7C1l5GYb7AK58T4mlMvnrS1yD4Kef+y2//dPABV9Q/xyNFrgwG02quZApXzXBvMJjA6zAe7Q38wtAy5ZoaU5dzSiUa+nAo42ol9d0QzvQ6zGU6Yk/Pw7odN0LBbMLtYM4dBhZPK5o9h51FoZ10qJbomjnvHAGFJJ7sc2uqRdytb0ztnMWMOp1PcXZAvp0JAWX9uBkpUOvamYOZiS35GrhFcGEqMN1bEt5UZWksWVHPJDLTjKdQi9JI7d0EhOWZ7/Qne81YGGsdPIoQ8haOpFbThiSexNrj9il1PMn+Bblbby1maGnD4HYXl1LW6XTTpCVQtv6etCYaRFWLp4GlhfYs3tR/3tcTGBPawn3MLtEuZYo1W3jgRI+C8IglTMkUtetf3Wdvp+9h+XI4ZkmPdnzD4R69P3/95sPlGzKGCmkE7PlwPByHPtI4X3Dd22nvc8j+3bbpOOr/69eTmnzRzG5UKi4D9a1HYZG23rAeK5r0P5zcJiw3zpPIZkNF4Nqq7ZYe/1oFRnJzm7Alt5JIUOC29XxJHJ+w9OF+etF8ioDv+wZz1KGGYmril2EWGOnVHa73PgZtiQTVPJMsjhKvo10nV6Sn03DQthBRjivO0hRL/6hsv0+YXl8RDas/7BThGxGzfEUMja+isXFOHRh0eLZhiutFxRckG1Vu47gw36XVd4FW1z/IqaNw7PLt6AX9Sz4dXbDZRMq+3bby8dWDK2pcG2mKze12u/037lUr3g==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,f={},w=[];function y(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,o.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,o.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,o.jsx)(b.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(p(),{...n(38679)}),"\n",(0,o.jsx)(c(),{...n(96925)}),"\n",(0,o.jsx)(m(),{...n(24083)})]})}function P(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(y,{...e})}):y(e)}},38679(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},96925(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 document"},"note":{"type":"string","format":"string","example":"Please review and sign this document"},"description":{"type":"string","format":"string","example":"document 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},"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"]}},"title":"document_document_id_body"}}}}}')},24083(e){e.exports=JSON.parse('{"responses":{"200":{"description":"Document 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":"Document not found!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","format":"string","example":"Document not found!"}},"title":"inline_response_404_4"}}}},"405":{"description":"Invalid API Token!","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid API token!"}},"xml":{"name":"invalidtoken"},"title":"invalidtoken"}}}}}}')}}]);