WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 04:24:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
cb3d2e5c88088db0d8a8ec55b2d69c5e0aefcc2c
OpenSign/assets/js/1e1b513c.2c761e08.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3148],{94348(e,t,i){i.r(t),i.d(t,{assets:()=>w,contentTitle:()=>f,default:()=>v,frontMatter:()=>g,metadata:()=>o,toc:()=>x});const o=JSON.parse('{"id":"API-docs/v1/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/update-document.api.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/update-document","permalink":"/docs/API-docs/v1/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":"eJzdWF1u5LgRvkotXzIzkLvbM54N0k9xdgczRoyx4R8MEI/RoKRSi2uK5JJUtxsNAXnIDXKDHG1PEhQpqdU/9o6ziwTIi9GmisWqr4pVX3HNPJ87Nr1jP+qsrlB5x+4TlqPLrDBeaMWm7KZEuDU59widFJxengGXUi8d1A6tA6+h0rkoVsBVDnUU9yVCjp4L6UAXwMEZzEQhMshbRSP4rIMg9+BL4YJireSq0+51p4xDgUsw3PIKPVqXwErXkHGltIes5GoeDyyERNAqQxA+WtAZLRxkFrnHfMQSpg1aTi6e5WzK4iGdfyxhm4PY9G7NFK+QTVmnayZyljBB8BjuS7aL2dmP5PDW6cFHhZgHp1Js/SI9Fn+uhcWcTb2tMWHOrySd5kRlJLKE4aOROkc2Lbh0JJCVWHE2XTO/MkHSW6HmLGGFthX3m5WmuY/60fm/6HxFe7ZNvbR6IXKEFKUe4DtA3mNlJPfo4BX3IJE7D1rhQLZz4DVLWKaVJwina8aNkSILII9/cnTaet90nf6EWUDcUki8QEdfI+C/7iCBwwNMU+bCjx5y1iRMaf9iNZfkIoLFhcBlyGcn5irm51D3Fo4vO6LPiqGOhvbIHC1l5L6+zW6SRMVTiRc3lwPRVGuJXO1lI2UVHEUHdFiEpZASog64uLmEBVq6mCFWI7gNdzrIWMxQLOj6DUUg0znCQnDAiguZwLIUWUkJv4Kqdh5QtTnUQoeDKx+SGI5g36BcuIMWJbEcCDXflJs9xZALi5mXK1gKX+raA89zQdu5BOfRuNEQxWBFD+SNru1vR5LDvBY55uB1baHQNlgZipUJ14w8EMp5W2e02UFeU3SDHyRKv43VGTq3walDhYQG+hNA5eJ2DgV3Hm0CtRKEvK2Nx7xXiY8GrUCV4UEIArizUL9bwN23Y3GJthLedZ5SaHieA0oM/QRcnZXA43fua4suAaGEF1y6BJznlXEJaAseH6mugNeGiic+CufJ+KXI5+gdiKfy6ArpjmQDGwqrqxB9wkathonQ2+X1jrobCqpwbdcqeC09LLisD2NmMabbrLby0G3dxuo6Nj6M2m+vzmFZosU+7mhjHqVUdqJipDYabhod7Lss6bN9N132KgSvvZ5ZrITK8Vty+xp9AIXC6nWf0rXXFfcig06VG0ErGgPg9TBDK3jVgZdiyRdC29dPAEjqZtSpZ0LNcIF2NbBS1VWKds/Iz2GZ8iPnKwcp+iWiGtrWhTGyiNiByLZliQq2MCEpt3F6y8r3TZMwL/xWtZ4N2v8spW7aNE1wxRmtXGxcbyeT/SbbE6e26dOtoKgVtZSr736/rhmXf61/cJe//eQuTz4ZypPWpFP//Ka3k7fvjo4nR5M/3hx/Pz350/T996PJZPI3lrDHSm5aNiNtbIhe+H+wIJQUCmcdarO3k8nsXQvlySH02oZsWqay4FLkUAiUOdCZ7ncEEK3V9j8kDM/Y95z75HLn/MkzqUM8t9C1yv/X7h6y6HkHT2YnvYvv9108UxEyIv83+gHVf8PDjT/D4308nkzdzmoRhcJ3tuXscD066TCrrfCrMDk8HnEjjuL36d098fEKfalp6jB1HDV8yaZs3FWX8XpQZxpG+uyiG0RCu2Gl98ZNx2PHVZ7qx5E2qKghSJ66UaarMTdivDhmTbK7gxvzAmmsj162wXk+F2r+/K77DUTXFMYYqS2g+nhxI/6KK5Z0cRhKtRNYiZw6HCFP2XG1mXY+dDHuw7g7InQTwreR/t1udJDGD1k8Y1tMvR3fhpSzXTpIwdpv21SDVO609l7uUEd93xBMhQ6Ytkl7YVBdk3uU8ovjPb++oMx0hR1H6sR/+ce/wo7O7WDnd1/VV3VRWzB6ibaoZQCvkPgoqO2SPFbhmwsTO1F35JVE5+QKiK3OLU2ZuZgLT0y95TUZNzwVUtBFJjFNuy0MaoEbwZcSfYmWPv3BEv/OcYGS7n9PXNR8w5mW2j4U9K6QAIe0dkKhc4Cq5CojwS4rAx/lKk4xxgqH4Lwlq0W0TStveeah4orPA6FMtlDKUQq6smB1SuOQ07KOhJ9eQ7QNFD46FJ4ERgTiB5ryLQKtEuuzWNIFWrSs3yVx6oopTC6oHFJ0HgzZIjKMzyVK6uwhPoXUUoLRVEYFl0SahjbSdm+5clTroy1dDHrAWnKJ0cA3b24dUoTPhXpw0zdvvqojuOuT6QumTni8f9UVg+VyuVcEXm/v+Sj8pzqFKzTaCa/tarN7LnxZp6FwDJX0/0RNH1FhyJ9BYdjoyHXm9usQrY5LlGZ8jZ4yxI1PL89C53kNv/z9n3CO3Coo9TJma1ZblCuYd0cRcjHyEba+cYSRj9e+JMSzmHzt4wshSFRpu8htXzuLBVoCPwRyc5wRrfq7zkwg63+Lm9TCKIt5FjpsmOJjtf3zrp7Q7dBW7qK4RrsQGbb1/okIj4PwmCVMigyVG5bf04+X57CAd6MJSwad4xuiPT4/++HD5+sPZA3drIjY8WgymtCS0c5XXA2O2nmy3K1x6w3B+H994Ww7KM3VYyO5CLylHVcj57hjg9Y2HT5u3ies1M6TyHqdcoe3VjYNLf9ch7Zyd5+wBbeCOlkgJu0MmPft6Em4X111z4XwsnfSgw51PEERSQjzeuyRD7jaebBt7pukIwtkcZT4Idp1dEN6Nhr2OCdxnbjjNMvQ+GdlhyTv8vaGJSxtH1+r8I7LLF/Swy9fRmPjW1KgQWFtzSRX85rPSTaqbOJIX25zo4fAjdof5NRBOLZJU/SC/pJPBzes15F3NU0vHz89uaPFtZOm2Nw3TfNvtvudpQ==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1/revokedocument"}}');var n=i(74848),a=i(28453),s=i(57742),d=i.n(s),r=i(78178),c=i.n(r),p=i(19624),l=i.n(p),u=i(96226),m=i.n(u),h=(i(77675),i(19365),i(51107)),y=i(21312);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:"eJzdWF1u5LgRvkotXzIzkLvbM54N0k9xdgczRoyx4R8MEI/RoKRSi2uK5JJUtxsNAXnIDXKDHG1PEhQpqdU/9o6ziwTIi9GmisWqr4pVX3HNPJ87Nr1jP+qsrlB5x+4TlqPLrDBeaMWm7KZEuDU59widFJxengGXUi8d1A6tA6+h0rkoVsBVDnUU9yVCjp4L6UAXwMEZzEQhMshbRSP4rIMg9+BL4YJireSq0+51p4xDgUsw3PIKPVqXwErXkHGltIes5GoeDyyERNAqQxA+WtAZLRxkFrnHfMQSpg1aTi6e5WzK4iGdfyxhm4PY9G7NFK+QTVmnayZyljBB8BjuS7aL2dmP5PDW6cFHhZgHp1Js/SI9Fn+uhcWcTb2tMWHOrySd5kRlJLKE4aOROkc2Lbh0JJCVWHE2XTO/MkHSW6HmLGGFthX3m5WmuY/60fm/6HxFe7ZNvbR6IXKEFKUe4DtA3mNlJPfo4BX3IJE7D1rhQLZz4DVLWKaVJwina8aNkSILII9/cnTaet90nf6EWUDcUki8QEdfI+C/7iCBwwNMU+bCjx5y1iRMaf9iNZfkIoLFhcBlyGcn5irm51D3Fo4vO6LPiqGOhvbIHC1l5L6+zW6SRMVTiRc3lwPRVGuJXO1lI2UVHEUHdFiEpZASog64uLmEBVq6mCFWI7gNdzrIWMxQLOj6DUUg0znCQnDAiguZwLIUWUkJv4Kqdh5QtTnUQoeDKx+SGI5g36BcuIMWJbEcCDXflJs9xZALi5mXK1gKX+raA89zQdu5BOfRuNEQxWBFD+SNru1vR5LDvBY55uB1baHQNlgZipUJ14w8EMp5W2e02UFeU3SDHyRKv43VGTq3walDhYQG+hNA5eJ2DgV3Hm0CtRKEvK2Nx7xXiY8GrUCV4UEIArizUL9bwN23Y3GJthLedZ5SaHieA0oM/QRcnZXA43fua4suAaGEF1y6BJznlXEJaAseH6mugNeGiic+CufJ+KXI5+gdiKfy6ArpjmQDGwqrqxB9wkathonQ2+X1jrobCqpwbdcqeC09LLisD2NmMabbrLby0G3dxuo6Nj6M2m+vzmFZosU+7mhjHqVUdqJipDYabhod7Lss6bN9N132KgSvvZ5ZrITK8Vty+xp9AIXC6nWf0rXXFfcig06VG0ErGgPg9TBDK3jVgZdiyRdC29dPAEjqZtSpZ0LNcIF2NbBS1VWKds/Iz2GZ8iPnKwcp+iWiGtrWhTGyiNiByLZliQq2MCEpt3F6y8r3TZMwL/xWtZ4N2v8spW7aNE1wxRmtXGxcbyeT/SbbE6e26dOtoKgVtZSr736/rhmXf61/cJe//eQuTz4ZypPWpFP//Ka3k7fvjo4nR5M/3hx/Pz350/T996PJZPI3lrDHSm5aNiNtbIhe+H+wIJQUCmcdarO3k8nsXQvlySH02oZsWqay4FLkUAiUOdCZ7ncEEK3V9j8kDM/Y95z75HLn/MkzqUM8t9C1yv/X7h6y6HkHT2YnvYvv9108UxEyIv83+gHVf8PDjT/D4308nkzdzmoRhcJ3tuXscD066TCrrfCrMDk8HnEjjuL36d098fEKfalp6jB1HDV8yaZs3FWX8XpQZxpG+uyiG0RCu2Gl98ZNx2PHVZ7qx5E2qKghSJ66UaarMTdivDhmTbK7gxvzAmmsj162wXk+F2r+/K77DUTXFMYYqS2g+nhxI/6KK5Z0cRhKtRNYiZw6HCFP2XG1mXY+dDHuw7g7InQTwreR/t1udJDGD1k8Y1tMvR3fhpSzXTpIwdpv21SDVO609l7uUEd93xBMhQ6Ytkl7YVBdk3uU8ovjPb++oMx0hR1H6sR/+ce/wo7O7WDnd1/VV3VRWzB6ibaoZQCvkPgoqO2SPFbhmwsTO1F35JVE5+QKiK3OLU2ZuZgLT0y95TUZNzwVUtBFJjFNuy0MaoEbwZcSfYmWPv3BEv/OcYGS7n9PXNR8w5mW2j4U9K6QAIe0dkKhc4Cq5CojwS4rAx/lKk4xxgqH4Lwlq0W0TStveeah4orPA6FMtlDKUQq6smB1SuOQ07KOhJ9eQ7QNFD46FJ4ERgTiB5ryLQKtEuuzWNIFWrSs3yVx6oopTC6oHFJ0HgzZIjKMzyVK6uwhPoXUUoLRVEYFl0SahjbSdm+5clTroy1dDHrAWnKJ0cA3b24dUoTPhXpw0zdvvqojuOuT6QumTni8f9UVg+VyuVcEXm/v+Sj8pzqFKzTaCa/tarN7LnxZp6FwDJX0/0RNH1FhyJ9BYdjoyHXm9usQrY5LlGZ8jZ4yxI1PL89C53kNv/z9n3CO3Coo9TJma1ZblCuYd0cRcjHyEba+cYSRj9e+JMSzmHzt4wshSFRpu8htXzuLBVoCPwRyc5wRrfq7zkwg63+Lm9TCKIt5FjpsmOJjtf3zrp7Q7dBW7qK4RrsQGbb1/okIj4PwmCVMigyVG5bf04+X57CAd6MJSwad4xuiPT4/++HD5+sPZA3drIjY8WgymtCS0c5XXA2O2nmy3K1x6w3B+H994Ww7KM3VYyO5CLylHVcj57hjg9Y2HT5u3ies1M6TyHqdcoe3VjYNLf9ch7Zyd5+wBbeCOlkgJu0MmPft6Em4X111z4XwsnfSgw51PEERSQjzeuyRD7jaebBt7pukIwtkcZT4Idp1dEN6Nhr2OCdxnbjjNMvQ+GdlhyTv8vaGJSxtH1+r8I7LLF/Swy9fRmPjW1KgQWFtzSRX85rPSTaqbOJIX25zo4fAjdof5NRBOLZJU/SC/pJPBzes15F3NU0vHz89uaPFtZOm2Nw3TfNvtvudpQ==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1/opensign-api-v-1",custom_edit_url:null},f=void 0,w={},x=[];function b(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Update Document"}),"\n",(0,n.jsx)(d(),{method:"put",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,n.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,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,n.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(c(),{...i(76810)}),"\n",(0,n.jsx)(l(),{...i(69184)}),"\n",(0,n.jsx)(m(),{...i(74922)})]})}function v(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}},76810(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"ID of the document that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string"}}]}')},69184(e){e.exports=JSON.parse('{"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":false},"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":false},"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":false},"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":false},"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"}}}}}')},74922(e){e.exports=JSON.parse('{"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"}}}}}}')}}]);
Reference in New Issue View Git Blame Copy Permalink