OpenSign/assets/js/da66eb9c.b5f1e6c1.js

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2703],{56200:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>w,contentTitle:()=>v,default:()=>y,frontMatter:()=>f,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":"eJzdWd1uG7sRfpUpb5oIa0lJnFNUV3VzgiRomgixjQB1DIFazmp5zCV5SK5kQRBwLvoGveptHy1PUgy5u1r9xEl6DlqgN4bNnRnOfDOcP29Y4AvPJjfsR5PXFerg2W3GBPrcSRuk0WzCrkqEayt4QGip4GL6BrhSZuWh9ug8BAOVEbJYA9cC6kQeSgSBgUvlwRTAwVvMZSFzEI2gIbwzkZAHCKX0UbDRat1KD6YVxqHAFVjueIUBnc9gbWrIudYmQF5yvUgXFlIhGJ0jyJA0aJWWHnKHPKAYsowZi46TiW8Em7B0SWsfy9juIja52TDNK2QT1sqaScEyJgkey0PJDjF78yMZvHd7tFEjimjUHBu7SI7Dn2vpULBJcDVmzIe1otu8rKxCljG8t8oIZJOCK08EeYkVZ5MNC2sbKYOTesEyVhhX8bA72W5vk3z04c9GrIlnX9WpM0spEOaoTA/fHvIBK6t4QA+PeACF3AcwGnu0rQGPWcZyowNBONkwbq2SeQR59JOn2zbHqpv5T5hHxB25JEj09DUB/nUDCRweYZowH3/pIGfbjGkTvlvMlExEcLiUuIrx7OVCp/jsy97D8fuu6KKiL2NLPEqgo4g8lrfjJkrUfK7w/dW0Rzo3RiHXR9FIUQVnyQATD2EllYIkA95fTWGJjh5m9NUQruObjjQOc5RLen59EsiNQFhKDlhxqTJYlTIvKeDXUNU+AOomhhrosPfkYxDDGRwrJKQ/qVGW0oHUi126ORIMQjrMg1rDSobS1AG4EJLYuQIf0PphH8WoRQfklandr0eSw6KWAgUEUzsojItaxmRl4zMjC6T2wdU5MXsQNXk32kGk9Lt1Jkfvdzi1qBBRT34GqH1i51BwH9BlUGtJyLvaBhSdSLy36CTqHE9CEMGdxfzdAO6/HYspukoG31pKruFCACqM9QR8nZfA03ceaoc+A6llkFz5DHzglfUZGAcB7ymvQDCWkifeSx9I+ZUUCwwe5Jfi6APSG8l7OhTOVNH7hI1e9wOh0yuYA3FX5FTpm6pV8FoFWHJVn8bMYQq3We3Uqde6j9VlKnyYpF9/eAurEh12fkeX4mhOaScJRiqj8aXRxaGNki7aD8PlKEPwOpiZw0pqgd8S25cYIijk1mC6kK6DqXiQObSi/BAa0uSAYPoRWsGjFrw5lnwpjXv8BQBJ3Iwq9UzqGS7RrXta6rqaoztS8l08pvgQfO1hjmGFqPu6tW5MXUSqQKTbqkQNe5gQld8Zvafl8+02Y0GGvWw965X/2Zyq6Xa7jaZ4a7RPhevpeHxcZLvGqSn69CrIa0Wt1Pp3v13VTMdfqx/ci6ev/fT8taU4aVS6CA8zPR0/fXb2ZHw2/sPVkx8m53+cPP9hOB6P/8Yydl+pXclmJI310Yt/9w6kVlLjrEVt9nQ8nj1roDw/hV5TkG3TqSy5kgIKiUoA3el/QwDROeP+w4bhAf0eMp9Mbo0/fyB0qM8tTK3F/9rcUxo9bOD57Lwz8fmxiW90goya/ytzh/q/YeHOnv71IV1Pqu5HtUxE8TvbM7Z/noz0mNdOhnWcHO7PuJVn6fvk5pb68QpDaWjqsHUaNULJJmzUZpfRppdntozkuWU7iBzk7BVfLNC9rudR+4s6GPirye+SibE0sTIE6yej0VK6kCQNfWIr6/kwN9Vo6jglond8ecfdyFjUoyfD8XDMttnmQIjnWszN/ZCIqAIpPvdRBrdytHwyfHKCh1v7XfRYn30viw98IfXia3y3O99cUvykENnzUBco3Mq/4JplbQD0qZrRr0ROpZVcTmH5YTdmvWyDq4ufw9mkHU2+bdo4LIMn54f++MDY3ojQzI39Xrc5Otn7Nd/2exwSedBTdHSnSvnzLcFUmIhp81reW9SXZB5Fa/TJoWUfUeWmwrY9Gwxals9//1fHNRh00KSJ5ZP+pN/XDqxZoStqFXEsFN5LKv3EhlX85uPWgMYH5JVC79UaqGNeOJp0hVzIQNNC01vl3PK5VJKSCZEZ4nbQy0d+CB9LDCU6+vR7RzOAwCUqykFd86QXu75tZdxdQbuNDDjMay81eg+oS65zImwDNPbEXKdJyjrpEXxwpLVMuhkdHM8DVFzzRWxqM+iDJVBJShvgzJxGMm9UnYYO2sgYF8eIZFBcS0QQX9KmwSHQKXWeDkt6Tctm8vBZmvxSNJMJWsAcfQBLusgc08pGK5PfpXVMrRRYQ6lcckWNW19HYg+Oa0/1JunS+qADrGlwMSk4GFx7JA+/lfrOTwaDT/oMbrq4+ohzLwPePmozw2q1OsoIj/d5XslACfQDWuNlMG69417I0CbJvpDujyTpFWqM8dPLETsZwuT+OCnR6ahEZUeXGChC/Ohi+iZWv8fw+Zd/wFvkTkNpVila89qhWsOivYqQS55PsHXFK46dvA4lIZ6n4GsWQC2CH0sePv/yTw/vcEVjVXpSZMpgMK3nSuZw1e58BoMJvIhbs94eKO6ycq5pXvElp1CiXQAHm7iV1HdDuNDrOK7HeTwGA51Hvj0zYr5r3e1hzj2KOAiWuzuHO43ilOFRLdG36785AgpJfXUonakX6ba+Mo1xDgsasz6mkZJsuxACbHPcTpo00ezUwcKkSW0N3CH4OCxOD1jil9pa40iLZlQtTLu1QC2skTr4CQjHi7CTn+0CPS4n47bj6ChByDs4skZM55L0EhuLu9PhJ6oKB/VtP986LNDRhdHsnV+sbMLppg1LoGj9NWFNbRNlLZ7Hri5ujlKh/dOhnNhhoav8++IS3VLm2BT7L7zoUSQesYwpmaP2/cp78Wr6FpbPhuO9jugbHvfo7ZsXL99dviRlKJEmwNrOiFnjQ8V176aDLflhbdvsetr/16V60zvRKmdkFZexVW42JKnNvWG9pmbS36ffZqw0PhDJZkNJ4Nqp7ZaOf65jQ3Fzm7Eld5J6mNQLp7WD6BqRL8L96EO7oYbvW82fNKjtEDW1h3FFlLqjO1wf/I9ge7vN2jaRNE4UL5JeZ1ckZyfhaMyhPjdxXOQ52vAgbX+umF5fsYzNm31/Ff91wBxf0f8a+Copm9aXsQGOZxumuF7UfEG0SeQ2bZHK/a74LnbFzS9k1Ek49tvlZAX9JJtOMmw2qePebjv69OmLHA2uLTX55na73f4bPEx8PQ==","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 i=n(74848),a=n(28453),s=n(33617),d=n.n(s),p=n(17543),r=n.n(p),l=n(86013),c=n.n(l),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:"eJzdWd1uG7sRfpUpb5oIa0lJnFNUV3VzgiRomgixjQB1DIFazmp5zCV5SK5kQRBwLvoGveptHy1PUgy5u1r9xEl6DlqgN4bNnRnOfDOcP29Y4AvPJjfsR5PXFerg2W3GBPrcSRuk0WzCrkqEayt4QGip4GL6BrhSZuWh9ug8BAOVEbJYA9cC6kQeSgSBgUvlwRTAwVvMZSFzEI2gIbwzkZAHCKX0UbDRat1KD6YVxqHAFVjueIUBnc9gbWrIudYmQF5yvUgXFlIhGJ0jyJA0aJWWHnKHPKAYsowZi46TiW8Em7B0SWsfy9juIja52TDNK2QT1sqaScEyJgkey0PJDjF78yMZvHd7tFEjimjUHBu7SI7Dn2vpULBJcDVmzIe1otu8rKxCljG8t8oIZJOCK08EeYkVZ5MNC2sbKYOTesEyVhhX8bA72W5vk3z04c9GrIlnX9WpM0spEOaoTA/fHvIBK6t4QA+PeACF3AcwGnu0rQGPWcZyowNBONkwbq2SeQR59JOn2zbHqpv5T5hHxB25JEj09DUB/nUDCRweYZowH3/pIGfbjGkTvlvMlExEcLiUuIrx7OVCp/jsy97D8fuu6KKiL2NLPEqgo4g8lrfjJkrUfK7w/dW0Rzo3RiHXR9FIUQVnyQATD2EllYIkA95fTWGJjh5m9NUQruObjjQOc5RLen59EsiNQFhKDlhxqTJYlTIvKeDXUNU+AOomhhrosPfkYxDDGRwrJKQ/qVGW0oHUi126ORIMQjrMg1rDSobS1AG4EJLYuQIf0PphH8WoRQfklandr0eSw6KWAgUEUzsojItaxmRl4zMjC6T2wdU5MXsQNXk32kGk9Lt1Jkfvdzi1qBBRT34GqH1i51BwH9BlUGtJyLvaBhSdSLy36CTqHE9CEMGdxfzdAO6/HYspukoG31pKruFCACqM9QR8nZfA03ceaoc+A6llkFz5DHzglfUZGAcB7ymvQDCWkifeSx9I+ZUUCwwe5Jfi6APSG8l7OhTOVNH7hI1e9wOh0yuYA3FX5FTpm6pV8FoFWHJVn8bMYQq3We3Uqde6j9VlKnyYpF9/eAurEh12fkeX4mhOaScJRiqj8aXRxaGNki7aD8PlKEPwOpiZw0pqgd8S25cYIijk1mC6kK6DqXiQObSi/BAa0uSAYPoRWsGjFrw5lnwpjXv8BQBJ3Iwq9UzqGS7RrXta6rqaoztS8l08pvgQfO1hjmGFqPu6tW5MXUSqQKTbqkQNe5gQld8Zvafl8+02Y0GGvWw965X/2Zyq6Xa7jaZ4a7RPhevpeHxcZLvGqSn69CrIa0Wt1Pp3v13VTMdfqx/ci6ev/fT8taU4aVS6CA8zPR0/fXb2ZHw2/sPVkx8m53+cPP9hOB6P/8Yydl+pXclmJI310Yt/9w6kVlLjrEVt9nQ8nj1roDw/hV5TkG3TqSy5kgIKiUoA3el/QwDROeP+w4bhAf0eMp9Mbo0/fyB0qM8tTK3F/9rcUxo9bOD57Lwz8fmxiW90goya/ytzh/q/YeHOnv71IV1Pqu5HtUxE8TvbM7Z/noz0mNdOhnWcHO7PuJVn6fvk5pb68QpDaWjqsHUaNULJJmzUZpfRppdntozkuWU7iBzk7BVfLNC9rudR+4s6GPirye+SibE0sTIE6yej0VK6kCQNfWIr6/kwN9Vo6jglond8ecfdyFjUoyfD8XDMttnmQIjnWszN/ZCIqAIpPvdRBrdytHwyfHKCh1v7XfRYn30viw98IfXia3y3O99cUvykENnzUBco3Mq/4JplbQD0qZrRr0ROpZVcTmH5YTdmvWyDq4ufw9mkHU2+bdo4LIMn54f++MDY3ojQzI39Xrc5Otn7Nd/2exwSedBTdHSnSvnzLcFUmIhp81reW9SXZB5Fa/TJoWUfUeWmwrY9Gwxals9//1fHNRh00KSJ5ZP+pN/XDqxZoStqFXEsFN5LKv3EhlX85uPWgMYH5JVC79UaqGNeOJp0hVzIQNNC01vl3PK5VJKSCZEZ4nbQy0d+CB9LDCU6+vR7RzOAwCUqykFd86QXu75tZdxdQbuNDDjMay81eg+oS65zImwDNPbEXKdJyjrpEXxwpLVMuhkdHM8DVFzzRWxqM+iDJVBJShvgzJxGMm9UnYYO2sgYF8eIZFBcS0QQX9KmwSHQKXWeDkt6Tctm8vBZmvxSNJMJWsAcfQBLusgc08pGK5PfpXVMrRRYQ6lcckWNW19HYg+Oa0/1JunS+qADrGlwMSk4GFx7JA+/lfrOTwaDT/oMbrq4+ohzLwPePmozw2q1OsoIj/d5XslACfQDWuNlMG69417I0CbJvpDujyTpFWqM8dPLETsZwuT+OCnR6ahEZUeXGChC/Ohi+iZWv8fw+Zd/wFvkTkNpVila89qhWsOivYqQS55PsHXFK46dvA4lIZ6n4GsWQC2CH0sePv/yTw/vcEVjVXpSZMpgMK3nSuZw1e58BoMJvIhbs94eKO6ycq5pXvElp1CiXQAHm7iV1HdDuNDrOK7HeTwGA51Hvj0zYr5r3e1hzj2KOAiWuzuHO43ilOFRLdG36785AgpJfXUonakX6ba+Mo1xDgsasz6mkZJsuxACbHPcTpo00ezUwcKkSW0N3CH4OCxOD1jil9pa40iLZlQtTLu1QC2skTr4CQjHi7CTn+0CPS4n47bj6ChByDs4skZM55L0EhuLu9PhJ6oKB/VtP986LNDRhdHsnV+sbMLppg1LoGj9NWFNbRNlLZ7Hri5ujlKh/dOhnNhhoav8++IS3VLm2BT7L7zoUSQesYwpmaP2/cp78Wr6FpbPhuO9jugbHvfo7ZsXL99dviRlKJEmwNrOiFnjQ8V176aDLflhbdvsetr/16V60zvRKmdkFZexVW42JKnNvWG9pmbS36ffZqw0PhDJZkNJ4Nqp7ZaOf65jQ3Fzm7Eld5J6mNQLp7WD6BqRL8L96EO7oYbvW82fNKjtEDW1h3FFlLqjO1wf/I9ge7vN2jaRNE4UL5JeZ1ckZyfhaMyhPjdxXOQ52vAgbX+umF5fsYzNm31/Ff91wBxf0f8a+Copm9aXsQGOZxumuF7UfEG0SeQ2bZHK/a74LnbFzS9k1Ek49tvlZAX9JJtOMmw2qePebjv69OmLHA2uLTX55na73f4bPEx8PQ==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},v=void 0,w={},b=[];function j(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(h.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)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(r(),{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)(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},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,i.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 y(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]);