OpenSign/assets/js/da66eb9c.78d6bb4e.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>g,contentTitle:()=>f,default:()=>w,frontMatter:()=>y,metadata:()=>o,toc:()=>b});const o=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":"eJzdWF9vG7kR/ypTvjQx1pKcOFdUT3VzQWI0SITYRoA6hkAtZ7U8c0keyZUsCALu4b5Bn/raj5ZPUgy5u1r9iZP0Di3QF0PmDoczvxlyfjNrFvjcs/Et+9HkdYU6eHaXMYE+d9IGaTQbs+sS4cYKHhBaKbiYXAJXyiw91B6dh2CgMkIWK+BaQJ3EQ4kgMHCpPJgCOHiLuSxkDqJRNIB3JgryAKGUPio2Wq1a7cG0yjgUuATLHa8woPMZrEwNOdfaBMhLrufpwEIqBKNzBBmSBa3R0kPukAcUA5YxY9FxcvFSsDFLh7T+sYxtD2Lj2zXTvEI2Zq2uqRQsY5LgsTyUbB+zyx/J4Z3To48aUUSnZtj4RXoc/lxLh4KNg6sxYz6sFJ3mZWUVsozhg1VGIBsXXHkSyEusOBuvWVjZKBmc1HOWscK4ioftymZzl/SjD381YkV7dk2dOLOQAmGGyvTw7SEfsLKKB/TwhAdQyH0Ao7En2zrwlGUsNzoQhOM149YqmUeQhz95Om19aLqZ/YR5RNxRSIJET18T4F93kMDhEaYx8/FHBznbZEyb8N1qJuQigsOFxGXMZy/nOuVnX/cOjt93RJcVfR0b2qMEOsrIQ33b3SSJms8Uvr+e9ERnxijk+iAbKavgNDlg4iIspVKQdMD76wks0NHFjLEawE2801HGYY5yQdevLwK5EQgLyQErLlUGy1LmJSX8CqraB0Dd5FADHfaufExiOIVDg4T0Ry3K0nMg9Xz73BwoBiEd5kGtYClDaeoAXAhJ27kCH9D6QR/FaEUH5LWp3W9HksO8lgIFBFM7KIyLVsbHysZrRh5I7YOrc9rsQdQU3egHidJv60yO3m9xalEhoZ7+DFD7tJ1DwX1Al0GtJSHvahtQdCrxwaKTqHM8CkEEdxrf7wZw/+1YTNBVMvjWUwoNFwJQYawn4Ou8BJ6+81A79BlILYPkymfgA6+sz8A4CPhA7woEY+nxxAfpAxm/lGKOwYP8Uh59QLojec+GwpkqRp+w0at+InR2BbOn7pqCKn1TtQpeqwALrurjmDlM6TatnTp2W3exukqFD5P2mw9vYVmiwy7u6FIezejZSYqRymi8aXRwaLOky/b9dDl4IXgdzNRhJbXAb8ntKwwRFAprMF1K18FUPMgcWlV+AI1oCkAw/Qyt4EkL3gxLvpDGPf0CgKRuSpV6KvUUF+hWPSt1Xc3QHRj5Li5Tfgi+8jDDsETUfdvaMCYWkSoQ2bYsUcMOJiTlt07vWPlis8lYkGHntZ72yv90RtV0s9lEV7w12qfC9Ww0OiyyHXFqij7dCopaUSu1+sPvVzXT8tfqB/fi2Rs/OX9jKU8aky7C45uejZ49Pz0bnY7+dH32w/j8z+MXPwxGo9HfWcYeKrUt2Yy0sT568f/egtRKapy2qE2fjUbT5w2U58fQawqybZjKgispoJCoBNCZ/ncEEJ0z7j8kDI/Y95j75HLr/PkjqUM8tzC1Fv9rd49Z9LiD59PzzsUXhy5e6gQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9JjXToZV7BweTrmVp+n7+PaO+HiFoTTUddg6tRqhZGM2bF+X4br3zmwY6XOLthGJ5YaVIVg/Hg4912JmHgbGoqaCoPjMD3JTDbmVw8XZ4Ixtsv093Nrvksf69Hu3+MDnUs+/tu9uC9UVhTNFbAewLm7cyr/himVtPPpSTSdWIqdKRxGgLPmw7XpetbHuwrnfKrSdwreR//2qdJTO99k8YzuMvWnj+tSzWTpKxZpvu5SDVO6V+E7uWGV9sSGYChMxbZL3vUV9Re5R6seY7Hv2EVVuKmzZ0slJu+Xzr//qdp2cdNCkBuKT/qTf1w6sWaIrahVxLBQ+SKrEtA2r+M3HJp7YPPJKofdqBURg544aTyHnMhB5b6hOzi2fSSXpbpOYod0Oes+DH8DHEkOJjj790RElF7hARU9Cx2X0fEujlsbdFzRqyIDDrPZSo/eAuuQ6J8E2QSNF5To1NtZJj+CDI6tlss3o4HgeoOKazyPHzKAPlkAl6RaDMzPqkLxRdeoBaEBiXGT1yaE4JYggvqLG3yHQKhFBhyXdpkXTCPgsNWIpm8kFLWCGPoAlW2SOaYKilcnv03SkVgqsoZdVckU8qm8jbQ+Oa0/Pf7KljUEHWMM3MRl4cnLjkSL8Vup7Pz45+aRP4bbLq4848zLg3ZP2ZVgulwcvwtPdPa9leFPP4ANa42UwbrXdPZehrGfxFekr6f5Jml6jxpg/vTdiq0OY3B8+SrQ6LFHZ4RUGyhA/vJhcxmL0FD7/8g94i9xpKM0yZWteO1QrmLdHEXIp8gm2rpbELpDXoSTE85R8zTymRfBjycPnX/7p4R0uqctJV4pcOTmZ1DMlc7huRzAnJ2N4GYdYvbFMHC3lXFP74EtOqUStOQebdiup7wdwoVexe47tcUwGWo/7dtyI710bbg8z7lHEvqzcnjnYWhRJv0e1QN9O42YIKCTR3FA6U8/TaX1jGuccFtT1fEwdHvl2IQTYZrlt/KjB2JqDhUmN0wq4Q/Cxd5vsbYlfamuNIyuazrEw7RABtbBG6uDHIBwvwlZ/tk30OCuMw4eDpQQh7+DIGjVdSNJNbDzuVgefqCrs1bfd99ZhgY4OjG5v42Jlk063bVoCZetvSWtiMfRq8TySrDjISYX2L/t6IuFBV/n3xRW6hcyxKfZfuNHDKDxkGVMyR+37lffi9eQtLJ4PRizrsYZvuNzDt5cvX727ekXG0EOaADsbnA1GtGSNDxXXvZP2htb7tW29pZj/rzPuhjvRZGVoFZeRuTYDi8Q6b1mP1Iz74+27jJXGBxJZr+kRuHFqs6Hln+tIKG7vMrbgThKHidS0mQKIjoh8Ee4nH9qBMXzfpPyoQy1D1EQP48QmsaN7XO2N7Dd3m6yliWRxkniZ7Dq9Jj1bDQddB/HctOMiz9GGR2X7NH9yc80yNmvG71Wc5DPHlzT658tkbJomRgIc19ZMcT2v+Zxkk8pNGuqUu6z4PrLi5gc5dRSOXbqcvKC/5NPRDet1YtybTSefPn1xR4NrK02xudtsNv8GPK5Ukw==","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 s=i(74848),n=i(28453),a=i(33617),d=i.n(a),r=i(17543),c=i.n(r),p=i(86013),l=i.n(p),u=i(63723),m=i.n(u),h=(i(18766),i(79329),i(9303));const y={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:"eJzdWF9vG7kR/ypTvjQx1pKcOFdUT3VzQWI0SITYRoA6hkAtZ7U8c0keyZUsCALu4b5Bn/raj5ZPUgy5u1r9iZP0Di3QF0PmDoczvxlyfjNrFvjcs/Et+9HkdYU6eHaXMYE+d9IGaTQbs+sS4cYKHhBaKbiYXAJXyiw91B6dh2CgMkIWK+BaQJ3EQ4kgMHCpPJgCOHiLuSxkDqJRNIB3JgryAKGUPio2Wq1a7cG0yjgUuATLHa8woPMZrEwNOdfaBMhLrufpwEIqBKNzBBmSBa3R0kPukAcUA5YxY9FxcvFSsDFLh7T+sYxtD2Lj2zXTvEI2Zq2uqRQsY5LgsTyUbB+zyx/J4Z3To48aUUSnZtj4RXoc/lxLh4KNg6sxYz6sFJ3mZWUVsozhg1VGIBsXXHkSyEusOBuvWVjZKBmc1HOWscK4ioftymZzl/SjD381YkV7dk2dOLOQAmGGyvTw7SEfsLKKB/TwhAdQyH0Ao7En2zrwlGUsNzoQhOM149YqmUeQhz95Om19aLqZ/YR5RNxRSIJET18T4F93kMDhEaYx8/FHBznbZEyb8N1qJuQigsOFxGXMZy/nOuVnX/cOjt93RJcVfR0b2qMEOsrIQ33b3SSJms8Uvr+e9ERnxijk+iAbKavgNDlg4iIspVKQdMD76wks0NHFjLEawE2801HGYY5yQdevLwK5EQgLyQErLlUGy1LmJSX8CqraB0Dd5FADHfaufExiOIVDg4T0Ry3K0nMg9Xz73BwoBiEd5kGtYClDaeoAXAhJ27kCH9D6QR/FaEUH5LWp3W9HksO8lgIFBFM7KIyLVsbHysZrRh5I7YOrc9rsQdQU3egHidJv60yO3m9xalEhoZ7+DFD7tJ1DwX1Al0GtJSHvahtQdCrxwaKTqHM8CkEEdxrf7wZw/+1YTNBVMvjWUwoNFwJQYawn4Ou8BJ6+81A79BlILYPkymfgA6+sz8A4CPhA7woEY+nxxAfpAxm/lGKOwYP8Uh59QLojec+GwpkqRp+w0at+InR2BbOn7pqCKn1TtQpeqwALrurjmDlM6TatnTp2W3exukqFD5P2mw9vYVmiwy7u6FIezejZSYqRymi8aXRwaLOky/b9dDl4IXgdzNRhJbXAb8ntKwwRFAprMF1K18FUPMgcWlV+AI1oCkAw/Qyt4EkL3gxLvpDGPf0CgKRuSpV6KvUUF+hWPSt1Xc3QHRj5Li5Tfgi+8jDDsETUfdvaMCYWkSoQ2bYsUcMOJiTlt07vWPlis8lYkGHntZ72yv90RtV0s9lEV7w12qfC9Ww0OiyyHXFqij7dCopaUSu1+sPvVzXT8tfqB/fi2Rs/OX9jKU8aky7C45uejZ49Pz0bnY7+dH32w/j8z+MXPwxGo9HfWcYeKrUt2Yy0sT568f/egtRKapy2qE2fjUbT5w2U58fQawqybZjKgispoJCoBNCZ/ncEEJ0z7j8kDI/Y95j75HLr/PkjqUM8tzC1Fv9rd49Z9LiD59PzzsUXhy5e6gQZkf9rc4/6v+Hh1p/+8SEdT6buZrVMQvE723G2v56c9JjXToZV7BweTrmVp+n7+PaO+HiFoTTUddg6tRqhZGM2bF+X4br3zmwY6XOLthGJ5YaVIVg/Hg4912JmHgbGoqaCoPjMD3JTDbmVw8XZ4Ixtsv093Nrvksf69Hu3+MDnUs+/tu9uC9UVhTNFbAewLm7cyr/himVtPPpSTSdWIqdKRxGgLPmw7XpetbHuwrnfKrSdwreR//2qdJTO99k8YzuMvWnj+tSzWTpKxZpvu5SDVO6V+E7uWGV9sSGYChMxbZL3vUV9Re5R6seY7Hv2EVVuKmzZ0slJu+Xzr//qdp2cdNCkBuKT/qTf1w6sWaIrahVxLBQ+SKrEtA2r+M3HJp7YPPJKofdqBURg544aTyHnMhB5b6hOzi2fSSXpbpOYod0Oes+DH8DHEkOJjj790RElF7hARU9Cx2X0fEujlsbdFzRqyIDDrPZSo/eAuuQ6J8E2QSNF5To1NtZJj+CDI6tlss3o4HgeoOKazyPHzKAPlkAl6RaDMzPqkLxRdeoBaEBiXGT1yaE4JYggvqLG3yHQKhFBhyXdpkXTCPgsNWIpm8kFLWCGPoAlW2SOaYKilcnv03SkVgqsoZdVckU8qm8jbQ+Oa0/Pf7KljUEHWMM3MRl4cnLjkSL8Vup7Pz45+aRP4bbLq4848zLg3ZP2ZVgulwcvwtPdPa9leFPP4ANa42UwbrXdPZehrGfxFekr6f5Jml6jxpg/vTdiq0OY3B8+SrQ6LFHZ4RUGyhA/vJhcxmL0FD7/8g94i9xpKM0yZWteO1QrmLdHEXIp8gm2rpbELpDXoSTE85R8zTymRfBjycPnX/7p4R0uqctJV4pcOTmZ1DMlc7huRzAnJ2N4GYdYvbFMHC3lXFP74EtOqUStOQebdiup7wdwoVexe47tcUwGWo/7dtyI710bbg8z7lHEvqzcnjnYWhRJv0e1QN9O42YIKCTR3FA6U8/TaX1jGuccFtT1fEwdHvl2IQTYZrlt/KjB2JqDhUmN0wq4Q/Cxd5vsbYlfamuNIyuazrEw7RABtbBG6uDHIBwvwlZ/tk30OCuMw4eDpQQh7+DIGjVdSNJNbDzuVgefqCrs1bfd99ZhgY4OjG5v42Jlk063bVoCZetvSWtiMfRq8TySrDjISYX2L/t6IuFBV/n3xRW6hcyxKfZfuNHDKDxkGVMyR+37lffi9eQtLJ4PRizrsYZvuNzDt5cvX727ekXG0EOaADsbnA1GtGSNDxXXvZP2htb7tW29pZj/rzPuhjvRZGVoFZeRuTYDi8Q6b1mP1Iz74+27jJXGBxJZr+kRuHFqs6Hln+tIKG7vMrbgThKHidS0mQKIjoh8Ee4nH9qBMXzfpPyoQy1D1EQP48QmsaN7XO2N7Dd3m6yliWRxkniZ7Dq9Jj1bDQddB/HctOMiz9GGR2X7NH9yc80yNmvG71Wc5DPHlzT658tkbJomRgIc19ZMcT2v+Zxkk8pNGuqUu6z4PrLi5gc5dRSOXbqcvKC/5NPRDet1YtybTSefPn1xR4NrK02xudtsNv8GPK5Ukw==",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,g={},b=[];function v(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,s.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.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,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(c(),{parameters:[{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}]}),"\n",(0,s.jsx)(l(),{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:!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},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:"document_document_id_body"}}}}}),"\n",(0,s.jsx)(m(),{id:void 0,label:void 0,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"}}}}}})]})}function w(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]);