mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-10-01 14:04:59 +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:()=>v,contentTitle:()=>f,default:()=>j,frontMatter:()=>g,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":"eJzdWF9vI7kN/yo8vXQXmNjObu6K+qnp7eIu6OFibLJYoNkgoEccWxeNpJM0dgzDb/0k/Wj9JAWlGXv8Z3Ob9tACfQkcDUmRP1LkT1qLiLMgxnfinS2bmkwM4r4QkkLplYvKGjEWt3OCj05iJOik4HJyBai1XQZoAvkA0UJtpapWgEZCk8XjnEBSRKUD2AoQgqNSVaoE2RoawM82CWKEOFchGbZGrzrr0XbGECpagkOPNUXyoYCVbaBEY2yEco5mljeslCawpiRQMXvQOa0ClJ4wkhyIQlhHHjnEKynGIm/SxScKsdtIjO/WwmBNYiw6Ww9KikIohsdhnItDzK7eccB7u6cYDZFMQU2pjYvtePq1UZ6kGEffUCFCXGneLajaaRKFoCenrSQxrlAHFijnVKMYr0VcuSQZvTIzUYjK+hrjbmWzuc/2KcS/WLlinX1XJ94ulCSYkrY9fHvIR6qdxkgBXmEETRgiWEM92S6A16IQpTWRIRyvBTqnVZlAHv4SeLf1set2+guVCXHPKYmKAn/NgP92gAwOJpjGIqQfW8jFphDGxhebmXCIBJ4WipapnoOamVyffdt7OL5si21V9G1sWEdL8lyRx/Z22ixJBqearm8nPdGptZrQHFUjVxWc5QBsWoSl0hqyDbi+ncCCPB/MlKsBfExnOsl4Kkkt+Pj1RaC0kmChEKhGpQtYzlU554JfQd2ECGTaGmqho96RT0UMZ3DskFThpEdFbgfKzHbt5sgwSOWpjHoFSxXntomAUipWRw0hkguDPorJiy2Qt7bx/zmSCLNGSZIQbeOhsj55mZqVS8eMI1AmRN+UrBxANpzdFAeL8m/nbUkh7HDqUGGhnv0CyISsjlBhiOQLaIxi5H3jIsmtSXpy5BWZkk5CkMB9SP27BTx8PRYT8rWKoYuUU4NSAmlK8wRCU84B83eMjadQgDIqKtShgBCxdqEA6yHSE/cViNZx86QnFSI7v1RyRjGA+lIdfSA+I2XPh8rbOmWfsTGrfiFs/Yr2wNwtJ1WFdmpV2OgIC9TNKcw2hYgq7h3lh95seJhyq91sWM5TcNaE3NXejEbHHXg7VduJwJBxBVSN1qtvfr+Wmpd/q7lgkG9+DJOLHx23mdaly/i80pvRm7dn56Oz0R9vz78bX/xp/O13g9Fo9DdRiKda7/q5YGuij176v7egjFaGHjrUHt6MRg9vWygvTqHXdmvXjrEFaiWhUqQl8J7hdwSQvLf+35wmz/j3XPgcchf8xTOlwySoso2R/+twT3n0fIAXDxfbEL89DvHKZMiYGd7aRzL/jQh38fS3j3l7dnW/qlUWSt/FXrD99RxkoLLxKq4SrXw6Q6fO8vfx3T2TtZri3DIldU3moXEuxmLYdZfhutdnNoLt+UXHUhuvxVjMY3RhPBwGNHJqnwbWkeHOqHEaBqWth+jUcHEuNsWhBjr3Amlqzl6mECLOlJk9r3W/g+iG05gztQfUNl/o1F9pJYouD32plp7PCSX5lDOujg87Kvy+y/E2jYf8saOPX8cID+fjSY7Xp3hC7NG4ltv3+Ui7dHI+d8NbmcomSNqau3Zkbtg7rtjF+ZFbn0iXtqZu/nXi//z7P5JG53Xa5hu4bjw4uyRfNToFXml6UsxGeldAvogxIyOsNYWgV8AkZOb58iDVTEUmYC0VKdHhVGnFR5DFLGt76J3iMIBPc4pz8vzpD55plaQFaT65oK19TIzJAjbR1mmPDuml9Y8Vu1QAwrQJylAIEIg6FTJz5KthV2GJeKDJdNV5FQhQ1SzM5I2qSpWKDXO/8VhGqNHgLDGIAthvRqFt7QG8nTL3DVY3md3xrZgo5hDT3W8A75hNp8B5MV+PSWZiF4pMrNv2w2EYCVMKERxvr0rK3Dei55vYgnw6Ufni22gNznJfVKiZQvVzy4aiRxO4eWeHutRs4WuZZ9pD4moAn81nc8PF0gTiAtDKPIbxZ3MGd9sy+0TToCLdv+pO+XK5PDrdr/d1flBx3kzBk7M7vVlaTL2gr779hy+XB21gv7I9VeQ5moTRjAylCkSncueGu8vJVRohMCftdjuzynFD4tUhCw5vKDITDcNO/zU3ea4JLNMMSpeg3I/+fGgnzQPydbiubsgvVEltR/wCVMMkPBSF0KokE/oN6vKHyU+wgLeDkSh6vfUrwBv+dPX9+59v3rM3PC4yYueD0WDES86GWKPpbXXw4nPYRta7Efz/+kDUzhi+lgydRpUmewJ93U7lO9Fr/uP+29B9IeY2RBZZr6cY6KPXmw0v/9qQ59l/X4gFesW9Po3u9pInt03/i3C/+tC9tsDLnplOBtRNUsNjNF138mB6pNXBe9fmflN045Q9zhLfZ7/ObtnOzsIRK2M2kDUuy5JcfFa2T4MmH29FIabt21WdnsGExyW/m+EyO5uv4okopLW10GhmDc5YNptkAoANZ63PHh4Te2h/cFAn4dinFTkK/ssxnVRYrzMz2Wy28vnTFzVaXDtpzs39ZrP5F2LSnQA=","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),a=n(28453),s=n(33617),d=n.n(s),p=n(17543),l=n.n(p),r=n(86013),c=n.n(r),m=n(63723),u=n.n(m),h=(n(18766),n(79329),n(9303));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:"eJzdWF9vI7kN/yo8vXQXmNjObu6K+qnp7eIu6OFibLJYoNkgoEccWxeNpJM0dgzDb/0k/Wj9JAWlGXv8Z3Ob9tACfQkcDUmRP1LkT1qLiLMgxnfinS2bmkwM4r4QkkLplYvKGjEWt3OCj05iJOik4HJyBai1XQZoAvkA0UJtpapWgEZCk8XjnEBSRKUD2AoQgqNSVaoE2RoawM82CWKEOFchGbZGrzrr0XbGECpagkOPNUXyoYCVbaBEY2yEco5mljeslCawpiRQMXvQOa0ClJ4wkhyIQlhHHjnEKynGIm/SxScKsdtIjO/WwmBNYiw6Ww9KikIohsdhnItDzK7eccB7u6cYDZFMQU2pjYvtePq1UZ6kGEffUCFCXGneLajaaRKFoCenrSQxrlAHFijnVKMYr0VcuSQZvTIzUYjK+hrjbmWzuc/2KcS/WLlinX1XJ94ulCSYkrY9fHvIR6qdxkgBXmEETRgiWEM92S6A16IQpTWRIRyvBTqnVZlAHv4SeLf1set2+guVCXHPKYmKAn/NgP92gAwOJpjGIqQfW8jFphDGxhebmXCIBJ4WipapnoOamVyffdt7OL5si21V9G1sWEdL8lyRx/Z22ixJBqearm8nPdGptZrQHFUjVxWc5QBsWoSl0hqyDbi+ncCCPB/MlKsBfExnOsl4Kkkt+Pj1RaC0kmChEKhGpQtYzlU554JfQd2ECGTaGmqho96RT0UMZ3DskFThpEdFbgfKzHbt5sgwSOWpjHoFSxXntomAUipWRw0hkguDPorJiy2Qt7bx/zmSCLNGSZIQbeOhsj55mZqVS8eMI1AmRN+UrBxANpzdFAeL8m/nbUkh7HDqUGGhnv0CyISsjlBhiOQLaIxi5H3jIsmtSXpy5BWZkk5CkMB9SP27BTx8PRYT8rWKoYuUU4NSAmlK8wRCU84B83eMjadQgDIqKtShgBCxdqEA6yHSE/cViNZx86QnFSI7v1RyRjGA+lIdfSA+I2XPh8rbOmWfsTGrfiFs/Yr2wNwtJ1WFdmpV2OgIC9TNKcw2hYgq7h3lh95seJhyq91sWM5TcNaE3NXejEbHHXg7VduJwJBxBVSN1qtvfr+Wmpd/q7lgkG9+DJOLHx23mdaly/i80pvRm7dn56Oz0R9vz78bX/xp/O13g9Fo9DdRiKda7/q5YGuij176v7egjFaGHjrUHt6MRg9vWygvTqHXdmvXjrEFaiWhUqQl8J7hdwSQvLf+35wmz/j3XPgcchf8xTOlwySoso2R/+twT3n0fIAXDxfbEL89DvHKZMiYGd7aRzL/jQh38fS3j3l7dnW/qlUWSt/FXrD99RxkoLLxKq4SrXw6Q6fO8vfx3T2TtZri3DIldU3moXEuxmLYdZfhutdnNoLt+UXHUhuvxVjMY3RhPBwGNHJqnwbWkeHOqHEaBqWth+jUcHEuNsWhBjr3Amlqzl6mECLOlJk9r3W/g+iG05gztQfUNl/o1F9pJYouD32plp7PCSX5lDOujg87Kvy+y/E2jYf8saOPX8cID+fjSY7Xp3hC7NG4ltv3+Ui7dHI+d8NbmcomSNqau3Zkbtg7rtjF+ZFbn0iXtqZu/nXi//z7P5JG53Xa5hu4bjw4uyRfNToFXml6UsxGeldAvogxIyOsNYWgV8AkZOb58iDVTEUmYC0VKdHhVGnFR5DFLGt76J3iMIBPc4pz8vzpD55plaQFaT65oK19TIzJAjbR1mmPDuml9Y8Vu1QAwrQJylAIEIg6FTJz5KthV2GJeKDJdNV5FQhQ1SzM5I2qSpWKDXO/8VhGqNHgLDGIAthvRqFt7QG8nTL3DVY3md3xrZgo5hDT3W8A75hNp8B5MV+PSWZiF4pMrNv2w2EYCVMKERxvr0rK3Dei55vYgnw6Ufni22gNznJfVKiZQvVzy4aiRxO4eWeHutRs4WuZZ9pD4moAn81nc8PF0gTiAtDKPIbxZ3MGd9sy+0TToCLdv+pO+XK5PDrdr/d1flBx3kzBk7M7vVlaTL2gr779hy+XB21gv7I9VeQ5moTRjAylCkSncueGu8vJVRohMCftdjuzynFD4tUhCw5vKDITDcNO/zU3ea4JLNMMSpeg3I/+fGgnzQPydbiubsgvVEltR/wCVMMkPBSF0KokE/oN6vKHyU+wgLeDkSh6vfUrwBv+dPX9+59v3rM3PC4yYueD0WDES86GWKPpbXXw4nPYRta7Efz/+kDUzhi+lgydRpUmewJ93U7lO9Fr/uP+29B9IeY2RBZZr6cY6KPXmw0v/9qQ59l/X4gFesW9Po3u9pInt03/i3C/+tC9tsDLnplOBtRNUsNjNF138mB6pNXBe9fmflN045Q9zhLfZ7/ObtnOzsIRK2M2kDUuy5JcfFa2T4MmH29FIabt21WdnsGExyW/m+EyO5uv4okopLW10GhmDc5YNptkAoANZ63PHh4Te2h/cFAn4dinFTkK/ssxnVRYrzMz2Wy28vnTFzVaXDtpzs39ZrP5F2LSnQA=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,v={},y=[];function I(e){const t={p:"p",...(0,a.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)(c(),{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 j(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(I,{...e})}):I(e)}}}]); |