mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-12 12:47:40 +02:00
1 line
14 KiB
JavaScript
1 line
14 KiB
JavaScript
"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[2703],{37055(e,t,i){i.r(t),i.d(t,{assets:()=>x,contentTitle:()=>v,default:()=>P,frontMatter:()=>y,metadata:()=>o,toc:()=>g});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":"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuEZFKahvHPRqYBob425LmusRLcwbLzVRRtQV1wVt7B5E7AeJmVIva530CD440lom3YwOjhcBaq75KjZ0GYzBEqgkZQ1wJqdxhDeqSQ03TSONiy10MiiO5CKIz2nK5hBolQiRw4pe77rtun2Wph7p9ZAJWkCOPoAlXWSBaVyplSlu0yiyUQqsoUwuuSJqPNaRjgfHtadyk3TpfNAD1jZ36Ft2/9Yjefil1Ld+MZm812dw3cfVO8y9DHjzoMtEm83mKAM93D/zoww/NTm8QWu8DMZth9MrGaomj1lrLKT/I0n6ETXG+BnlpEGGMIU/ToK0OqtQ2dll6hL87PziRSx+D+G3X/8JL5E7DZXZpGgtGodqC6vuKkIueT7B1teuOHLhTagI8SIFXzv87BB8V/Hw26//8vAKNzRSSE+KTJlMLppcyQKuunnnZLKAZ3FiPJqBxjluwTX16r7iFEo0B+Ng02kl9e0UzvU2jqqGXofW47k9M2J+7dztIeceY2NDJ7o7p4NGscP2qNbou9F3joBCEq0OlTPNKt02VqY1zmFJzcG7NE4h286FANsud1MW6uYHdbA0aUqxBe4QfByUXBwciV8aa40jLdoxTWm6iR1qYY3UwS9AOF6GQX520J/GSd/RUoKQ93BkrZjeJeklthb3q9QEZof1dD/fOizR0YXR7MEvVrbhdN2FJVC0/pGwJtZEWYsXkdTFViwV9u8P5USCha72r8tLdGtZYEsuPvCiZ3HzjGVMyQK1H1f68x8vXsL62+mcqlTPUj7jcc9evnj2/NXlc1KGEmkC7NF0Pp3H1tr4UHM9uungF6LD2nY/UNr/1x+UWq5GY8yZVVxGptxOBxPLvWYjErUY/5Z0k7HK+EBb7u8pCbx1arej5V+aSGCubzK25k4SZ4pUuB25idNDpzHcD950v87Al/0sddKgjpFqoqNxPJrY2C1uD34f2xEJamkpaZx2PEt6nV2RnEHCUZdDvDqdOC8KtOGje8dtxcXbK2Jt7W9ddfzZjDm+IULHN0nZNLqPhDuu3TPF9arhK9qbRO7SBLXaZ+G3kYW3/yCjTsKxT8+TFfRfsunkgfv7xPB3u35/+vTBEy2u3W7yzc1ut/sPt1iLdQ==","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 n=i(74848),a=i(28453),s=i(57742),d=i.n(s),l=i(78178),r=i.n(l),c=i(19624),u=i.n(c),p=i(96226),m=i.n(p),h=(i(77675),i(19365),i(51107)),f=i(21312);const y={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:"eJzdWc2OHLcRfpUKL5YGvTMjWXKQOXkjC7YQQVpoVxCQ1WLAblZP08smaZI9s4PFAD7kDXLKNY/mJwmK7L/50Z8tJEAutpZNFqu+KlZ9VXPPAl95trhmP5iiqVEHz24yJtAXTtogjWYLdlUhvLWCB4RuF5xfvACulNl4aDw6D8FAbYQst8C1gCZtDxWCwMCl8mBK4OAtFrKUBYhW0BRembiRBwiV9FGw0WrbSQ+mE8ahxA1Y7niNAZ3PYGsaKLjWJkBRcb1KF5ZSIRhdIMiQNOiUlh4KhzygmLKMGYuOk4kvBFuwdElnH8vYcBFbXN8zzWtkC9bJWkrBMiYJHstDxQ4xe/EDGbx3e7RRI4poVI6tXSTH4S+NdCjYIrgGM+bDVtFtXtZWIcsY3lllBLJFyZWnDUWFNWeLexa2Nu4MTuoVy1hpXM3DsLLb3ST56MNfjdjSmX1VL5xZS4GQozIjfEfIB6yt4gE9POABFHIfwGgc7e0MeMgyVhgdCMLFPePWKllEkGc/e7rt/lh1k/+MRUTckUuCRE9fE+CfNpDA4RGmBfPxHz3kbJcxbcIXi7kgExEcriVuYjx7udIpPsey93D8siv6qBjL2NEZJdBRRB7LG07TTtQ8V/j66mK0NTdGIddH0UhRBWfJABMXYSOVgiQDXl9dwBodPczoqym8jW867nFYoFzT8xtvgcIIhLXkgDWXKoNNJYuKAn4LdeMDoG5jqIUOR08+BjGcwbFCQvqTGmUpHUi9GtLNkWAQ0mER1BY2MlSmCcCFkHScK/ABrZ+OUYxa9EBemcb9cSQ5rBopUEAwjYPSuKhlTFY2PjOyQGofXFPQYQ+iIe9GO2gr/ds6U6D3A04dKrRpJD8D1D4d51ByH9Bl0GhJyLvGBhS9SLyz6CTqAk9CEMFdxvzdAu4/H4sLdLUMvrOUXMOFAFQY6wn4pqiAp+88NA59BlLLILnyGfjAa+szMA4C3lFegWAsJU+8kz6Q8hspVhg8yA/F0RukN1KMdCidqaP3CRu9HQdCr1cwB+KuyKnSt1Wr5I0KsOaqOY2ZwxRuy8apU691H6vLVPgwSX/75iVsKnTY+x1diqOc0k4SjFRG40uji0MXJX20H4bLUYbgTTBLh7XUAj8nti8xRFDIrcH0Id0EU/MgC+hE+Sm0W5MDghlHaA0POvByrPhaGvfwAwCSuCVV6qXUS1yj24601E2doztS8lVcpvgQfOshx7BB1GPdOjcmFpEqEOm2qVDDHia0yw9G72n5NNUOWW6XRi+H2D2J475thypPJiR9MoEzuBo7MHIR4w7SrE4ZFeLlXbYl3QkgolApWuh/fj+A3+v3ejKJKnziMmJMX+lCom8LeIMr7oRC7xPtScBSzGbA+wg23VWUn4fQF4OWVGtHuwuiA1EnBB4CLyoU5DSBFrWgXPGNRy2WUeo3Ax+Zvo/F1KJeFkYZN/Yad45vibsFrP3xw92NvHnNctVg5GfE0nLFi1t2s8tYXhS/VyKVr+/bv6eFqVkWlx7vrR1R8Lwo4EGuJMHDXR6zgt0+XLSFmguqCTGhHNTsPacm8CM1PuLFCXQUUwACb5exIMMeVVmOuO8yJyq52+3iO/bWaJ+exuP5/Jhh9l1Dy3ipJFDKKhultn/6epQxLX+KPHEvHv/kL578ZMk1rUrn4eOHHs8ff3v2aH42//PVo+8WT/6yePrddD6f/51l7K5WA19lJI2N0Yt/jxakVlLjskNt+Xg+X37bQvnkFHotG7UtTV9zJQWUEpUAutN/RQDROeN+J1v+iH4fM59M7ox/8pHQoZRVmkaL/7W5pzT6uIFPlk96E58em/hCJ8io870yt6j/GxYO9oyvD+l6UnU/qmXaFL+zPWPH68lIj0XjZNjGtvnujFt5lr4vrm+oGa0xVIZabtukPjtUbMFmXXaZ3Y/yzI6RPLfuuvDItVgVgvWL2cxzLXJzNzUWNVUSxXNP+XPGrZytH00fsV12eIZb+0X7sTn70iM+8JXUq0+duxmguiR3Jo/tATaUGCv/hlRjWn+Md7VjiAo50TzyAEXJm6Hlf975unfnYZ/ctcmf1/keFqeTvey4lWVsr11tSdK472qXTvYh7bd9vk0iD/htv+8UrXz6ITbXnhpThdNlv636n1vBd+SW0kQfto/ltUV9SXDSU4sxcIjkO1SFqbFrTSaT7shv//h3f2oy6V2RunWiYa8bB9Zs0JWNin4rFd5Jor10DOv4zceJGbXOyGsia2oL1C2uHBEsIVcyUKfc9hUFtzyXSlIuoW2GTjsYpSM/hXcVhgodffrGEeEQuEZFKahvHPRqYBob425LmusRLcwbLzVRRtQV1wVt7B5E7AeJmVIva530CD440lom3YwOjhcBaq75KjZ0GYzBEqgkZQ1wJqdxhDeqSQ03TSONiy10MiiO5CKIz2nK5hBolQiRw4pe77rtun2Wph7p9ZAJWkCOPoAlXWSBaVyplSlu0yiyUQqsoUwuuSJqPNaRjgfHtadyk3TpfNAD1jZ36Ft2/9Yjefil1Ld+MZm812dw3cfVO8y9DHjzoMtEm83mKAM93D/zoww/NTm8QWu8DMZth9MrGaomj1lrLKT/I0n6ETXG+BnlpEGGMIU/ToK0OqtQ2dll6hL87PziRSx+D+G3X/8JL5E7DZXZpGgtGodqC6vuKkIueT7B1teuOHLhTagI8SIFXzv87BB8V/Hw26//8vAKNzRSSE+KTJlMLppcyQKuunnnZLKAZ3FiPJqBxjluwTX16r7iFEo0B+Ng02kl9e0UzvU2jqqGXofW47k9M2J+7dztIeceY2NDJ7o7p4NGscP2qNbou9F3joBCEq0OlTPNKt02VqY1zmFJzcG7NE4h286FANsud1MW6uYHdbA0aUqxBe4QfByUXBwciV8aa40jLdoxTWm6iR1qYY3UwS9AOF6GQX520J/GSd/RUoKQ93BkrZjeJeklthb3q9QEZof1dD/fOizR0YXR7MEvVrbhdN2FJVC0/pGwJtZEWYsXkdTFViwV9u8P5USCha72r8tLdGtZYEsuPvCiZ3HzjGVMyQK1H1f68x8vXsL62+mcqlTPUj7jcc9evnj2/NXlc1KGEmkC7NF0Pp3H1tr4UHM9uungF6LD2nY/UNr/1x+UWq5GY8yZVVxGptxOBxPLvWYjErUY/5Z0k7HK+EBb7u8pCbx1arej5V+aSGCubzK25k4SZ4pUuB25idNDpzHcD950v87Al/0sddKgjpFqoqNxPJrY2C1uD34f2xEJamkpaZx2PEt6nV2RnEHCUZdDvDqdOC8KtOGje8dtxcXbK2Jt7W9ddfzZjDm+IULHN0nZNLqPhDuu3TPF9arhK9qbRO7SBLXaZ+G3kYW3/yCjTsKxT8+TFfRfsunkgfv7xPB3u35/+vTBEy2u3W7yzc1ut/sPt1iLdQ==",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,x={},g=[];function j(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)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,n.jsx)(r(),{...i(38679)}),"\n",(0,n.jsx)(u(),{...i(96925)}),"\n",(0,n.jsx)(m(),{...i(24083)})]})}function P(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(j,{...e})}):j(e)}},38679(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"}}]}')},96925(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},"notify_on_signatures":{"type":"boolean","example":false,"description":"**true** - The document creator will receive an email notification whenever a signer signs the document.\\n\\n**false** - The document creator will not receive an email notification whenever a signer signs the document.\\n\\nNote: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on \'send_email\' parameter.\\n"},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"bcc (blind carbon copy): Users added here will receive a notification email once the document is completed. \\n"}},"title":"document_document_id_body"}}}}}')},24083(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"}}}}}}')}}]); |