mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-25 11:04:57 +02:00
1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4948],{55151:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>P,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>o,toc:()=>g});const o=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":"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf","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 i=n(74848),s=n(28453),a=n(33617),d=n.n(a),p=n(17543),c=n.n(p),r=n(86013),l=n.n(r),m=n(63723),u=n.n(m),f=(n(18766),n(79329),n(9303));const h={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:"eJzdWF9vGzcS/ypTvlwKrCXZcVtUT5c2QWtcURuxgwDnGMZoOatlzSVZkitZEPR2n+Q+Wj9JMeSutLIUN7kWd8C9GDJ3/v44nPmRaxFxHsT0Vry2ZduQiUHcFUJSKL1yUVkjpuKmJnjnJEaCXgpeXV0Aam2XAdpAPkC00FipqhWgkdBm8VgTSIqodABbAUJwVKpKlSA7QyP42SZBjBBrFZJha/Sqtx5tbwyhoiU49NhQJB8KWNkWSjTGRihrNPPssFKawJqSQMUcQR+0ClB6wkhyJAphHXnkFC+kmIrspM9PFGLnSExv18JgQ2Iqelv3SopCKIbHYazFU8wuXnPCe95TjoZIpqRm1OXFdjz92ipPUkyjb6kQIa40ewuqcZpEIejRaStJTCvUgQXKmhoU07WIK5cko1dmLgpRWd9g3K1sNnfZPoX4nZUr1tkP9crbhZIEM9J2gO8A+UiN0xgpwAuMoAlDBGtoINsn8KUoRGlNZAina4HOaVUmkMe/BPa2Pgzdzn6hMiHueUuiosBfM+B/nCCDgwmmqQjpxxZysSmEsfGzzVxxigSeFoqWqZ6Dmptcn0Pbezh+nottVQxtbFhHS/JckYf2dtosSQZnmi5vrgaiM2s1oTmoRq4qOMkJ2LQIS6U1ZBtweXMFC/J8MNNejeBdOtNJxlNJasHHbygCpZUEC4VADSpdwLJWZc0Fv4KmDRHIdDXUQUeDI5+KGE7gMCCpwtGIitwOlJnv2s2BYZDKUxn1CpYq1raNgFIqVkcNIZILoyGKKYotkDe29X8eSYR5qyRJiLb1UFmfokzNyqVjxhkoE6JvS1YOIFve3ZQHi/Jv521JIexw6lFhoYH9AsiErI5QYYjkC2iNYuR96yLJrUl6dOQVmZKOQpDAvU/9uwM8fDoWV+QbFUOfKW8NSgmkKc0TCG1ZA+bvGFtPoQBlVFSoQwEhYuNCAdZDpEfuKxCt4+ZJjypEDn6p5JxiAPWxOnpLfEbKQQyVt03afcbGrIaFsI0r2ifmbnhTVeimVoWtjrBA3R7DbFOIqOLeUb4fzIb7GbfazYblPAVnTchd7WwyOezA26naTQSGjCugarVeffHXtdS8/EfNBYM8+zFcnf/ouM10Ib2KzyudTc5enpxOTibf3Jx+PT3/dvrV16PJZPJPUYjHRu/6uWBrYohe+n+woIxWhu571O7PJpP7lx2U58fQ67q168bYArWSUCnSEthn+AsBJO+t/w+nyTPxPZc+p9wnf/5M6TAJqmxr5P863WMRPZ/g+f35NsWvDlO8MBkyZoY39oHMfyPDXT5D9zG751D3q1plofRd7CU7XM9JBipbr+Iq0crHE3TqJH+f3t4xWWso1pYpqWszD421mIpx313G60Gf2Qi25xc9S229FlNRx+jCdDwOaOTMPo6sI8OdUeMsjErbjNGp8eJUbIqnGujcZ0iHiHNl5ifPat3tMr7mXcnA7+W9hR+d+getRNHDOpTq2HZNKMmnLeDNfrtjtm/6LdvuylM62LPBTyN4T8fdUco2ZGxC7LGyjqoP6UW3dHTc9rNYmcomSLoSunRkrjk6LsDF6UFY70mXtqF+nPXiv/3r30mjjzq5+QIuWw/OLslXrU6JV5oeFZOLwY2O71VMsAgbTSHoFTCnmHu+C0g1V5H5VMcsSnQ4U1rxiWIxy9oeBocyjOB9TbEmz5/+5pklSVqQ5oMI2tqHRIAsYBttk3z0SC+tf6g4pAIQZm1QhkKAQNSrkKmRb3p9hSUegSazT+dVIEDVsDBzMaoqVSo2zO3DYxmhQYPzRAgK4LgZha5TB/B2xlQ2WN1mssaXXKKYU0xXuRG8ZnKcEufFfNslmXlaKDJP7roJp2EkzChEcOxelZSpbETPF6sF+XSi8j221Rqc5TanUDMjGu4tG4oeTeBenAPqt2YLX0ckkw+JqxF8MB/MNRdLG4gLQCvzEKYfzAncbsvsPc2CinT3oj/ly+Xy4HR/ua/zg4p1OwNPzu705mkx9YKh+vYfvitG8k24rK7JL1RJXWv5iM9xEh53zR/L1PzT7SN3jr8/VeBGrFVJJgybwqsfrn6CBbwcTUQx6GefEPD4p4vv3/x8/YbtcsfN5+90NBlNeMnZEBs0A1dPHk2eHt31bor9v76xdH2dmf3YaVRpOCbQ191guxWDhjsdPq/cFaK2IbLIej3DQO+83mx4+deWPI/Pu0Is0Cvur2n6dfckuW20H4X7xdv+wQI+76XmaEL99DI8utKNIQ+DB1o9eTLa3G2KfoRxxFni+xzXyQ3b2Vk4IDY8gbPGq7IkF5+VHTKJq3c3ohCz7vmnSS9JwuOSn55wmYPNt9k0nNPaWmg08xbnLJtN8tDFlndtOLEf0sTufnBSR+HYH+U5C/7LOR1VWK8zG9hstvL500c1Olx7ad6bu81m8zvLylmf",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,P={},g=[];function I(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,i.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.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,i.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.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,i.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}},title:"document_document_id_body"}}}}}),"\n",(0,i.jsx)(u(),{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 b(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(I,{...e})}):I(e)}}}]); |