OpenSign/assets/js/bfe4b778.be7bdbbb.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>b,contentTitle:()=>k,default:()=>g,frontMatter:()=>f,metadata:()=>i,toc:()=>y});const i=JSON.parse('{"id":"API-docs/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/update-document.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/update-document","permalink":"/docs/API-docs/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":"eJzdWFFvGzcS/itTvlwKrCXZcVtUT5c2QWtcURuxggDnCMZoOatlzSVZkitZEPR2v+R+Wn9JMeSutLYcN7kWd8C9GDJ3OJz5OPzmI7ci4jKI6Y14bcu2IRODmBdCUii9clFZI6ZiVhO8cxIjQW8Fr64uALW26wBtIB8gWmisVNUG0Ehos3msCSRFVDqArQAhOCpVpUqQnaMR/GyTIUaItQrJsTV603uPtneGUNEaHHpsKJIPBWxsCyUaYyOUNZplXrBSmsCakkDFHEEftApQesJIciQKYR155BQvpJiKvEifnyjEYSExvdkKgw2Jqeh93SopCqEYHoexFo8xu3jNCT9YPeVoiGRKakFdXuzH06+t8iTFNPqWChHiRvNqQTVOkygE3TttJYlphTqwQVlTg2K6FXHjkmX0yixFISrrG4yHkd1unv1TiN9ZueE5D0O98nalJMGCtB3gO0A+UuM0RgrwAiNowhDBGhrY9gl8KQpRWhMZwulWoHNalQnk8S+BV9seh24Xv1CZEPe8JVFR4K8Z8D9OkMHBBNNUhPRjD7nYFcLY+NlurjhFAk8rRetUz0EtTa7Poe/Kakmey+fY/8EbW5LBhabL2dXAdGGtJjRHpcMlACd5NZsGYa20huwDLmdXsCLPpygBO4J36QAmG08lqRWflaEJlFYSrBQCNah0AetalTVX5waaNkQg0214lycNzmeqODiB44CkCk9GVOSzq8zywA1HjkEqT2XUG1irWNs2AkqpeDpqCJFcGA1RTFHsgZzZ1v95JBGWrZIkIdrWQ2V9ijIxi0tngjNQJkTfljw5gGx5d1MebMq/nbclhXDAqUeFjQb+CyAT8nSECkMkX0BrFCPvWxdJ7l3SvSOvyJT0JAQJ3NtEth3g4dOxuCLfqBj6THlrUEogTYn8IbRlDZi/Y2w9hQKUUVGhDgWEiI0LBVgPke6ZBCBax0xH9ypEDn6t5JJiAPWxOnpLfEbKQQyVt03afcbGbIaFsI8r2kfuZrypKnQtpsJWR1ihbp/CbFeIqKJ+wN8DIr9dMC/udmznKThrQqags8nkmC73LbCjb4aMK6Bqtd588dfxXx7+I3LBIM9+DFfnPzqmmS6kV/H5SWeTs5cnp5OTyTez06+n599Ov/p6NJlM/ikKcd/oA/kK9iaG6KX/BwPKaGXotkft9mwyuX3ZQXn+FHodtbqu56xQKwmVIi2B1wx/IYDkvfX/IfU/E99z6XPKffLnz5QOK5bKtkb+r9N9KqLnEzy/Pd+n+NVxihcmQ8YybmbvyPw3MjzkM1w+5uU51IdVrbJR+i4eJDscz0kGKluv4iZpwPsTdOokf5/ezFlZNRRry/rRtVk0xlpMxbhnl/F2wDM7wf78qpeUrddiKuoYXZiOxwGNXNj7kXVkmBk1LsKotM0YnRqvTsWueDwDnfsM6xBxqczy5NlZ80PG17wrGfgHee/hR6f+QRtR9LAOrTppXBNK8mkLeLPfHmTom37L9rvyWLv10u3T1NhQjAnxQHB1knmoHLqhJztp32aVqWzKtquOS0fmmhfm2lqdHjXY96RL21DfqXrz3/717zSjjzQt8wVcth6cXZOvWp1yqjTdK9YNg5sV329YOxE2mkLQG2C5sPSsyaVaqshSqRMNJTpcKK34sLCZ5dkeBuctjOB9TbEmz5/+5lkASVqR5jMG2tq7pG0sYBttk9bo2WFt/V3FIRWAsGiDMhQCBKJ+Cpka+cbVF0+SCGiysHReBQJUDRuzzKKqUqVix8wMHssIDRpcpl5fAMfNKHQkHMDbBavUYHWbdRhfNoliTjFdqUbwmnVvSpwH862TZJZgocgSuCMKTsNIWFCI4Hh5VVJWqRE9X3BW5NNhyffJVmtwlhlMoWaxM9xbdhQ9msA0mwPqt2YPX6cR0xoSNyP4YD6Yay6WNhAXgFbmLkw/mBO42ZfZe1oEFWn+oj/A6/X66OB++XDODyrW7QI8OXuYt0yD6ZgPp+//4TtbJN+Ey+qa/EqV1LHGR9YcJ+Nxx+tYJl5PF4tMCn9/PIE5VquSTBie91c/XP0EK3g5mohiQFWfEPD4p4vv3/x8/Yb9Mpnm83c6mowmPORsiA2awVKPHi8eH93toUH9v751dJTNon3sNKrU9xLo265n3YgBl06HzxzzQtQ2RDbZbhcY6J3Xux0P/9qS5844L8QKvWJ+TY2tuwLJPdF+FO4Xb/uHA/i8F5MnE+obk+GulC4DuRnc0ebR081uviv67sQRZ4vvc1wnM/Zz8HCkWbi55hmvypJcfNZ2KBKu3s1EIRbdM0yTXnSExzU/AeE6B5svqqnvprGt0GiWLS7ZNrvkfoot79qwGd+lZtz94KSehONhl85Z8F/O6ckJ221u9Lvd3j5/+uiMDtfemvdmvtvtfgdvoy5+","sidebar_class_name":"put api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/getdocument"},"next":{"title":"Delete Document","permalink":"/docs/API-docs/deletedocument"}}');var o=n(74848),s=n(28453),a=n(33617),d=n.n(a),c=n(17543),l=n.n(c),p=n(86013),r=n.n(p),u=n(63723),m=n.n(u),h=(n(18766),n(79329),n(9303));const f={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:"eJzdWFFvGzcS/itTvlwKrCXZcVtUT5c2QWtcURuxggDnCMZoOatlzSVZkitZEPR2v+R+Wn9JMeSutLYcN7kWd8C9GDJ3OJz5OPzmI7ci4jKI6Y14bcu2IRODmBdCUii9clFZI6ZiVhO8cxIjQW8Fr64uALW26wBtIB8gWmisVNUG0Ehos3msCSRFVDqArQAhOCpVpUqQnaMR/GyTIUaItQrJsTV603uPtneGUNEaHHpsKJIPBWxsCyUaYyOUNZplXrBSmsCakkDFHEEftApQesJIciQKYR155BQvpJiKvEifnyjEYSExvdkKgw2Jqeh93SopCqEYHoexFo8xu3jNCT9YPeVoiGRKakFdXuzH06+t8iTFNPqWChHiRvNqQTVOkygE3TttJYlphTqwQVlTg2K6FXHjkmX0yixFISrrG4yHkd1unv1TiN9ZueE5D0O98nalJMGCtB3gO0A+UuM0RgrwAiNowhDBGhrY9gl8KQpRWhMZwulWoHNalQnk8S+BV9seh24Xv1CZEPe8JVFR4K8Z8D9OkMHBBNNUhPRjD7nYFcLY+NlurjhFAk8rRetUz0EtTa7Poe/Kakmey+fY/8EbW5LBhabL2dXAdGGtJjRHpcMlACd5NZsGYa20huwDLmdXsCLPpygBO4J36QAmG08lqRWflaEJlFYSrBQCNah0AetalTVX5waaNkQg0214lycNzmeqODiB44CkCk9GVOSzq8zywA1HjkEqT2XUG1irWNs2AkqpeDpqCJFcGA1RTFHsgZzZ1v95JBGWrZIkIdrWQ2V9ijIxi0tngjNQJkTfljw5gGx5d1MebMq/nbclhXDAqUeFjQb+CyAT8nSECkMkX0BrFCPvWxdJ7l3SvSOvyJT0JAQJ3NtEth3g4dOxuCLfqBj6THlrUEogTYn8IbRlDZi/Y2w9hQKUUVGhDgWEiI0LBVgPke6ZBCBax0xH9ypEDn6t5JJiAPWxOnpLfEbKQQyVt03afcbGbIaFsI8r2kfuZrypKnQtpsJWR1ihbp/CbFeIqKJ+wN8DIr9dMC/udmznKThrQqags8nkmC73LbCjb4aMK6Bqtd588dfxXx7+I3LBIM9+DFfnPzqmmS6kV/H5SWeTs5cnp5OTyTez06+n599Ov/p6NJlM/ikKcd/oA/kK9iaG6KX/BwPKaGXotkft9mwyuX3ZQXn+FHodtbqu56xQKwmVIi2B1wx/IYDkvfX/IfU/E99z6XPKffLnz5QOK5bKtkb+r9N9KqLnEzy/Pd+n+NVxihcmQ8YybmbvyPw3MjzkM1w+5uU51IdVrbJR+i4eJDscz0kGKluv4iZpwPsTdOokf5/ezFlZNRRry/rRtVk0xlpMxbhnl/F2wDM7wf78qpeUrddiKuoYXZiOxwGNXNj7kXVkmBk1LsKotM0YnRqvTsWueDwDnfsM6xBxqczy5NlZ80PG17wrGfgHee/hR6f+QRtR9LAOrTppXBNK8mkLeLPfHmTom37L9rvyWLv10u3T1NhQjAnxQHB1knmoHLqhJztp32aVqWzKtquOS0fmmhfm2lqdHjXY96RL21DfqXrz3/717zSjjzQt8wVcth6cXZOvWp1yqjTdK9YNg5sV329YOxE2mkLQG2C5sPSsyaVaqshSqRMNJTpcKK34sLCZ5dkeBuctjOB9TbEmz5/+5lkASVqR5jMG2tq7pG0sYBttk9bo2WFt/V3FIRWAsGiDMhQCBKJ+Cpka+cbVF0+SCGiysHReBQJUDRuzzKKqUqVix8wMHssIDRpcpl5fAMfNKHQkHMDbBavUYHWbdRhfNoliTjFdqUbwmnVvSpwH862TZJZgocgSuCMKTsNIWFCI4Hh5VVJWqRE9X3BW5NNhyffJVmtwlhlMoWaxM9xbdhQ9msA0mwPqt2YPX6cR0xoSNyP4YD6Yay6WNhAXgFbmLkw/mBO42ZfZe1oEFWn+oj/A6/X66OB++XDODyrW7QI8OXuYt0yD6ZgPp+//4TtbJN+Ey+qa/EqV1LHGR9YcJ+Nxx+tYJl5PF4tMCn9/PIE5VquSTBie91c/XP0EK3g5mohiQFWfEPD4p4vv3/x8/Yb9Mpnm83c6mowmPORsiA2awVKPHi8eH93toUH9v751dJTNon3sNKrU9xLo265n3YgBl06HzxzzQtQ2RDbZbhcY6J3Xux0P/9qS5844L8QKvWJ+TY2tuwLJPdF+FO4Xb/uHA/i8F5MnE+obk+GulC4DuRnc0ebR081uviv67sQRZ4vvc1wnM/Zz8HCkWbi55hmvypJcfNZ2KBKu3s1EIRbdM0yTXnSExzU/AeE6B5svqqnvprGt0GiWLS7ZNrvkfoot79qwGd+lZtz94KSehONhl85Z8F/O6ckJ221u9Lvd3j5/+uiMDtfemvdmvtvtfgdvoy5+",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},k=void 0,b={},y=[];function v(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:"Request"}),"\n",(0,o.jsx)(l(),{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,o.jsx)(r(),{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"},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}},title:"document_document_id_body"}}}}}),"\n",(0,o.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 g(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(v,{...e})}):v(e)}}}]);