mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-29 13:05:03 +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:()=>b,contentTitle:()=>I,default:()=>g,frontMatter:()=>f,metadata:()=>a,toc:()=>y});const a=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":"eJzdWFFvI7cR/isTvvQCrCXZ56SonnrNHRKjQWycfTigPsMYLWe1jLkkQ3IlC4Le+kv60/JLgiF3pZWlc85t0AJ9MWTuzHDmm+HMR65FxHkQ01vx1pZtQyYGcVcISaH0ykVljZiKm5rgg5MYCXopeHN1Aai1XQZoA/kA0UJjpapWgEZCm8VjTSApotIBbAUIwVGpKlWC7AyN4CebBDFCrFVIhq3Rq956tL0xhIqW4NBjQ5F8KGBlWyjRGBuhrNHM84aV0gTWlAQqZg96p1WA0hNGkiNRCOvII4d4IcVU5E36+EQhdhuJ6e1aGGxITEVv615JUQjF8DiMtXiK2cVbDnhv9xSjIZIpqBl1cbEdT7+0ypMU0+hbKkSIK827BdU4TaIQ9Oi0lSSmFerAAmVNDYrpWsSVS5LRKzMXhaisbzDuVjabu2yfQvyblSvW2Xf1ytuFkgQz0naA7wD5SI3TGCnAK4ygCUMEa2gg2wfwtShEaU1kCKdrgc5pVSaQxz8H3m196Lqd/UxlQtxzSqKiwF8z4L8fIIODCaapCOnHFnKxKYSx8cVmrjhEAk8LRctUz0HNTa7Poe09HF+2xbYqhjY2rKMlea7IQ3s7bZYkgzNNlzdXA9GZtZrQHFQjVxWc5ABsWoSl0hqyDbi8uYIFeT6YKVcj+JDOdJLxVJJa8PEbikBpJcFCIVCDShewrFVZc8GvoGlDBDJdDXXQ0eDIpyKGEzh0SKpw1KMitwNl5rt2c2AYpPJURr2CpYq1bSOglIrVUUOI5MJoiGLyYgvkjW39f44kwrxVkiRE23qorE9epmbl0jHjCJQJ0bclKweQLWc3xcGi/Nt5W1IIO5x6VFhoYL8AMiGrI1QYIvkCWqMYed+6SHJrkh4deUWmpKMQJHDvU//uAA9fjsUV+UbF0EfKqUEpgTSleQKhLWvA/B1j6ykUoIyKCnUoIERsXCjAeoj0yH0FonXcPOlRhcjOL5WcUwygPldH74nPSDnwofK2SdlnbMxqWAhbv6J9Yu6Gk6pCN7UqbHWEBer2GGabQkQV947y/WA23M+41W42LOcpOGtC7mpnk8lhB95O1W4iMGRcAVWr9eqrP66l5uXfay4Y5NkP4er8B8dtpnPpTXxe6Wxy9vrkdHIy+fPN6bfT879Mv/l2NJlM/iEK8djoXT8XbE0M0Uv/DxaU0crQfY/a/dlkcv+6g/L8GHpdt3bdGFugVhIqRVoC7xn+QADJe+v/zWnyjH/Phc8h98GfP1M6TIIq2xr5vw73mEfPB3h+f74N8ZvDEC9MhoyZ4Y19IPPfiHAXz3D7mLdnV/erWmWh9F3sBTtcz0EGKluv4irRyscTdOokf5/e3jFZayjWlimpazMPjbWYinHfXcbrQZ/ZCLbnFz1Lbb0WU1HH6MJ0PA5o5Mw+jqwjw51R4yyMStuM0anx4lRsiqca6NwLpKk9eZlCiDhXZv681t0OomtOY87UHlDbfKFTf6eVKPo8DKU6el4TSvIpZ1wd73dU+F2f420an/LHnj5+GSN8Oh+PcrwhxRNij8Z13H7IR7qlo/O5H97KVDZB0tXcpSNzzd5xxS5OD9z6SLq0DfXzrxf/9Z//Shq912mbr+Cy9eDsknzV6hR4pelRMRsZXAH5IsaMjLDRFIJeAZOQuefLg1RzFZmAdVSkRIczpRUfQRazrO1hcIrDCD7WFGvy/OlPnmmVpAVpPrmgrX1IjMkCttE2aY8e6aX1DxW7VADCrA3KUAgQiHoVMjXy1bCvsEQ80GS66rwKBKgaFmbyRlWlSsWGud94LCM0aHCeGEQB7Dej0LX2AN7OmPsGq9vM7vhWTBRziOnuN4K3zKZT4LyYr8ckM7ELRSbWXfvhMIyEGYUIjrdXJWXuG9HzTWxBPp2ofPFttQZnuS8q1EyhhrllQ9GjCdy8s0N9arbwdcwz7SFxNYJP5pO55mJpA3EBaGUewvSTOYHbbZl9pFlQke5e9ad8uVwenO6v93W+V7FuZ+DJ2Z3ePC2mXjBU3/7Dl8tIvgmX1TX5hSqpay2f2XOchMfdtMAyTYt0Xcmd469PFbhza1WSCcOm8Ob7qx9hAa9HE1EM+tkXODz+8eK7dz9dv2O73KLz+TsdTUYTXnI2xAbNYKsnryxPj+56N/b+Xx9lur7OV4Gx06jSNE2gr7tJeCsGDXc6fI+5K0RtQ2SR9XqGgT54vdnw8i8teZ63d4VYoFfcX9O47C5WcttoPwv3q/f9Cwe87GnnaED99DI8utIVIw+DB1o9eWPa3G2KfoSxx1niu+zXyQ3b2Vk4YEI8gbPGm7IkF5+VHVKPqw83ohCz7r2oSU9PwuOS36pwmZ3N1980nNPaWmg08xbnLJtN8tDFlrM2nNgPaWJ3Pzioo3Dsj/IcBf/lmI4qrNeZDWw2W/n86bMaHa69NOfmbrPZ/AbxRGrK","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":"Revoke Document","permalink":"/docs/API-docs/revokedocument"}}');var o=n(74848),i=n(28453),s=n(33617),d=n.n(s),r=n(17543),c=n.n(r),l=n(86013),p=n.n(l),m=n(63723),u=n.n(m),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:"eJzdWFFvI7cR/isTvvQCrCXZ56SonnrNHRKjQWycfTigPsMYLWe1jLkkQ3IlC4Le+kv60/JLgiF3pZWlc85t0AJ9MWTuzHDmm+HMR65FxHkQ01vx1pZtQyYGcVcISaH0ykVljZiKm5rgg5MYCXopeHN1Aai1XQZoA/kA0UJjpapWgEZCm8VjTSApotIBbAUIwVGpKlWC7AyN4CebBDFCrFVIhq3Rq956tL0xhIqW4NBjQ5F8KGBlWyjRGBuhrNHM84aV0gTWlAQqZg96p1WA0hNGkiNRCOvII4d4IcVU5E36+EQhdhuJ6e1aGGxITEVv615JUQjF8DiMtXiK2cVbDnhv9xSjIZIpqBl1cbEdT7+0ypMU0+hbKkSIK827BdU4TaIQ9Oi0lSSmFerAAmVNDYrpWsSVS5LRKzMXhaisbzDuVjabu2yfQvyblSvW2Xf1ytuFkgQz0naA7wD5SI3TGCnAK4ygCUMEa2gg2wfwtShEaU1kCKdrgc5pVSaQxz8H3m196Lqd/UxlQtxzSqKiwF8z4L8fIIODCaapCOnHFnKxKYSx8cVmrjhEAk8LRctUz0HNTa7Poe09HF+2xbYqhjY2rKMlea7IQ3s7bZYkgzNNlzdXA9GZtZrQHFQjVxWc5ABsWoSl0hqyDbi8uYIFeT6YKVcj+JDOdJLxVJJa8PEbikBpJcFCIVCDShewrFVZc8GvoGlDBDJdDXXQ0eDIpyKGEzh0SKpw1KMitwNl5rt2c2AYpPJURr2CpYq1bSOglIrVUUOI5MJoiGLyYgvkjW39f44kwrxVkiRE23qorE9epmbl0jHjCJQJ0bclKweQLWc3xcGi/Nt5W1IIO5x6VFhoYL8AMiGrI1QYIvkCWqMYed+6SHJrkh4deUWmpKMQJHDvU//uAA9fjsUV+UbF0EfKqUEpgTSleQKhLWvA/B1j6ykUoIyKCnUoIERsXCjAeoj0yH0FonXcPOlRhcjOL5WcUwygPldH74nPSDnwofK2SdlnbMxqWAhbv6J9Yu6Gk6pCN7UqbHWEBer2GGabQkQV947y/WA23M+41W42LOcpOGtC7mpnk8lhB95O1W4iMGRcAVWr9eqrP66l5uXfay4Y5NkP4er8B8dtpnPpTXxe6Wxy9vrkdHIy+fPN6bfT879Mv/l2NJlM/iEK8djoXT8XbE0M0Uv/DxaU0crQfY/a/dlkcv+6g/L8GHpdt3bdGFugVhIqRVoC7xn+QADJe+v/zWnyjH/Phc8h98GfP1M6TIIq2xr5vw73mEfPB3h+f74N8ZvDEC9MhoyZ4Y19IPPfiHAXz3D7mLdnV/erWmWh9F3sBTtcz0EGKluv4irRyscTdOokf5/e3jFZayjWlimpazMPjbWYinHfXcbrQZ/ZCLbnFz1Lbb0WU1HH6MJ0PA5o5Mw+jqwjw51R4yyMStuM0anx4lRsiqca6NwLpKk9eZlCiDhXZv681t0OomtOY87UHlDbfKFTf6eVKPo8DKU6el4TSvIpZ1wd73dU+F2f420an/LHnj5+GSN8Oh+PcrwhxRNij8Z13H7IR7qlo/O5H97KVDZB0tXcpSNzzd5xxS5OD9z6SLq0DfXzrxf/9Z//Shq912mbr+Cy9eDsknzV6hR4pelRMRsZXAH5IsaMjLDRFIJeAZOQuefLg1RzFZmAdVSkRIczpRUfQRazrO1hcIrDCD7WFGvy/OlPnmmVpAVpPrmgrX1IjMkCttE2aY8e6aX1DxW7VADCrA3KUAgQiHoVMjXy1bCvsEQ80GS66rwKBKgaFmbyRlWlSsWGud94LCM0aHCeGEQB7Dej0LX2AN7OmPsGq9vM7vhWTBRziOnuN4K3zKZT4LyYr8ckM7ELRSbWXfvhMIyEGYUIjrdXJWXuG9HzTWxBPp2ofPFttQZnuS8q1EyhhrllQ9GjCdy8s0N9arbwdcwz7SFxNYJP5pO55mJpA3EBaGUewvSTOYHbbZl9pFlQke5e9ad8uVwenO6v93W+V7FuZ+DJ2Z3ePC2mXjBU3/7Dl8tIvgmX1TX5hSqpay2f2XOchMfdtMAyTYt0Xcmd469PFbhza1WSCcOm8Ob7qx9hAa9HE1EM+tkXODz+8eK7dz9dv2O73KLz+TsdTUYTXnI2xAbNYKsnryxPj+56N/b+Xx9lur7OV4Gx06jSNE2gr7tJeCsGDXc6fI+5K0RtQ2SR9XqGgT54vdnw8i8teZ63d4VYoFfcX9O47C5WcttoPwv3q/f9Cwe87GnnaED99DI8utIVIw+DB1o9eWPa3G2KfoSxx1niu+zXyQ3b2Vk4YEI8gbPGm7IkF5+VHVKPqw83ohCz7r2oSU9PwuOS36pwmZ3N1980nNPaWmg08xbnLJtN8tDFlrM2nNgPaWJ3Pzioo3Dsj/IcBf/lmI4qrNeZDWw2W/n86bMaHa69NOfmbrPZ/AbxRGrK",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},I=void 0,b={},y=[];function x(e){const t={p:"p",...(0,i.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)(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,o.jsx)(p(),{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,o.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 g(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}}}]); |