WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-21 17:17:44 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
cb3d2e5c88088db0d8a8ec55b2d69c5e0aefcc2c
OpenSign/assets/js/293ced56.c4d711c7.js
T

1 line
18 KiB
JavaScript
Raw Blame History

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[3588],{97016(e,t,n){n.r(t),n.d(t,{assets:()=>w,contentTitle:()=>v,default:()=>y,frontMatter:()=>f,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"id":"API-docs/v1.2/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.2/update-document.api.mdx","sourceDirName":"API-docs/v1.2","slug":"/API-docs/v1.2/update-document","permalink":"/docs/API-docs/v1.2/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":"eJzdWt1uG7kVfpXTWaCxhZHkZLNbVC3aZh1vEjSNDdtpgNqGRA2PJNYUOSU5kgVHwF4UfYCiN73tS/S+j7JPUhz+zIx+1kl2ty3Qi8T2zOHh+ec5H+c+c2xqs8FV9lwX1RyVs9lNnnG0hRGlE1plg+xyhvC25MwhJCp4dvYKmJR6aaGyaCw4DXPNxWQFTHGoArmbIXB0TEgLegIMbImFmIgCeGTUgzfaEzIHbiasZ6yVXCXuTidmDCa4hJIZNkeHxuaw0hUUTCntoJgxNQ0bToRE0KpAEC5IkIQWFgqDzCHvZXmmSzSMVHzFs0EWNkn6ZXnWbJQNru4zxeaYDbLEayh4lmeCzFMyN8u2bfbqOSm8sbvXUSFyr9QYo17Ex+CfKmGQZwNnKswz61aSdrNiXkrM8gzvSqk5ZoMJk5YIihnOWTa4z9yq9JTOCDXN8myizZy55sl6fRP4o3Vfab6iNZuinhm9EBxhjFK37NuyvMN5KZlDCwfMgURmHWiFLdqkwGGWZ4VWjkw4uM9YWUpReCP3/2hpt/td0fX4j1h4ixtyiRNo6W0w+IcVJOMwb6ZBZv0vtcmzdZ4p7T6ZzRmpiGBwIXDp49mKqQrx2ea9YcdP26KOijaPNa2RHA1F5C6/ZjVRomJjiaeXZy3SsdYSmdqJRooq6AYFtH8ISyElBB5wenkGCzSUmN5XPXjrc9rTGCxQLCj92iRQaI6wEAxwzoTMYTkTxYwCfgXzyjpAFWMomg5bKe+DGLqwKxAXdq9EeSgHQk2bcrPDGLgwWDi5gqVwM105YJwLWs4kWIel7bWt6KWoDXmpK/PDLclgWgmOHJyuDEy08VL6YlX6NCMNhLLOVAUttsAr8q7Xg0jp99LoAq1t7JSsQkQt/jmgsmE5gwmzDk0OlRJkeVOVDnnNEu9KNAJVgXtN4I079PU7Gtx+vC3O0MyFs0lTcg3jHFCiP0/AVsUMWHjPXGXQ5iCUcIJJm4N1bF7aHLQBh3dUV8Dpkoon3gnrSPil4FN0FsR3xdE5Uo4ULRkmRs+998k2atUOhFoup7fYXZJThY2n1oRV0sGCyWq/zSwqPhRqqA1HMwwCfITR3s1QgUVH2z8iCz7KAVkxi6LT/mOpi1vkUYmCYiGFSB3qlXJCUlJASQnqFU3Kz9gCodAkLsWAm6EwwIqQ2Sdqok2BFoLEYOloUOSMFCw9OPXnL9VutLAkgR+Rtq/UKen6iGRk0ib5e/A8GMub9JG3z6O9JjMYMnRYGbmvwG1a6iL0Chgc8vb8NYlisE4VNCH1xlSpA2OkzsMXJ6/8jtW2M2ynqLLK6aHBuVAcP6YcXARH+kxwuq4CldNz5kQBiZXtQSQNMet0O6nncJDibYwzthDaHH6HAYndkJobCj1coFm1pFTVfIxmR8g3/jGlFGcrC2N0S0TVli1Fvq4dX3jZvO83bEJUtlF6Q8ovwnErJquhVsMm3ffacVO3bZE7HeLe6UAXLtsO9O2bNlsnkwqHEPjN0wFFspOBqOsM0UI/7GbOX6tr1el4ET6wGTWZP9KG1PEO4BynzHCJ1oZOMRiWYjYHVkewTlvRkdaEPm+kpPakRV1QB+VlQmDOsWKGnJzGsUTFqbz6XB56ro+aFq537fuPEtWw0FKbtteYMWxF7a7Dud1N3HXLm1fZWFboW1pqbMeSFbfZzTrPxkXxfTnSif+b+Hev0PMs94+ebDzbmVrGRQEHYynIPMyMfVUoV4eD2NswTseoLyhbbc6GU4Px/TSxM0qkCtsDCMb7b6tIGv6ndSPN1nnmhNvoW4etQWg4prlivV77CmVLrWxI+idHR7vjRj1CxvGH+gMqxpNKytVPfrz5ITz+UCfNLH/y0p49fVmSR6JIz9zDi54cPfm8+/ioe/Szy8dfDp7+fPDFl72jo6M/ZHl2N5fN8JIRt6xtPf9364FQUigcJqsNnxwdDT+Ppny6z3pxNCnjzLZgUnCYCJQcaE/7IxoQjdHme45OD8j3kPqkclL+6QOhQ8V4oivF/9fq7pPoYQWfDp/WKn6xq+IrFUxGMMilvkX139Cw0ae9vQvbk6ibUS0CkX+fbSjbfh6UtFhURriVx1DuuqwU3fB+cHVDyMQc3UwT/lJWAXRxs2yQ9VN16d+36sw6I35mkSAZ30VmM+dKO+j3LVN8rO96ukRFZ6RkY0tls89K0V887j3J1vn2GlaWn0SPVfdTl1jHpkJNP7TupjHVBbkzeGzDYM3JUorfIh0t0R9tqohJzZBRA0seoCg5b/Cfk+Tr2p3boEnCTD4OBtk+k/YCG21cI8s2sIvY/rWH8Pho71Ca8K+9w1d8uTlm0H5bbX1Nt6+b/uK7mti4qt0h7e92YrPz8af6p1CvycMT7cMh5t1pieqCPENZ68Np2ymfQaL59s//qMmoF/0VdDrU9FJodq2uTBFAXs+PSYdGMUe9w7ff/A3GlZDOoxocFyipttic5gBL5/h4FUCf0giLttfpEP/2vlOxQOtB27q/RY+L8ACGdA0yvgLs1lYHgh2p/oKbGV1NZ763VlOJOZyfXFxOKkna0HClmpbY1sCLZ5LDnCk2bcGYJDMrbutx0DrmKo8vGGQSnJhj7uM9DnJIQhvSTphWnyTFBItVIYNxaBZPuNMCFdcGaI7vCuWb/m63Sz8++wxehC4fLhwzDjk9PaHQg4jSBvysYMaswr51MU4IyKiV8SMIue43GY1G16r1cgC/JA7Ng19FGpp6vv3LX+HqpV7SLDdFRWA4bm14c5DKGNeF3a1f9LQ/Q1n2L4JStv/s7JU/tw6D/99oB5Y8GWd3Ar6nQv2aOlWvS6cTCzegWgijFZm204GD0UcX9tEh8S2NdpoqZIP+TSZYeFNLimDOHNtyxbE2CMesZGMhBR2T9Pw9HDOHU21W8B7eEWgf7xmAa3h/rd53u13/j0g7nfripNOB93Ds7xdyoAKVxxY3pxKqb2NMcaS4b8Kzm9zehG/kfJni1XP+qhKSg8EqwgY1Ju8nw9Jgt5SsQJ7gsl94GcgyBNVrQ1mwqjGiuMUFykmX8tNv8SJFgaXHW4OmbexaY1VqIVyYJSZ0dxCZnlVjKQrYFP9ixgxNIGV4mVJPCnXr00fpxFUK6+oLhcTzuWETB++0uaWdAkeCuRrpPICYbMIscFphvcknQjEpbMRaiMIkvsdaOVZE5/0u1AmfA1GYIryHsda3FGJTw+Ye2mFSrhKTr/3hFnicmilTtFcjmVCWeuG6TD83FI7hRKw98Q7HM61vA5PzOLBROepSOQJcxC6zOQwhRKYBvVSAipdaKJfY+UEw8nJGIE1/RaGrBBjQGemAThJqbsmD7zdTgwL/22/+buENLqnupAODXn4Gzzyy4KvgOx9ucFGVpTbuWtFpMmL1ezuKAUljpdJLsIEQPRbhnVSbKo/Xc60HgSA5tiZoHpA2MabSQ6pftpdEfUm2vwjevIhR91qoW3utCJIbXWczwXEY/D2McTmUniIbBGjvfYDtRiTy6Oz04hL6XrAk54jSjNi0kZ8U3g1wvaEspKGg15j1mMAxNHXqJOcxea1GL04uoZ907A8EH3nlN59T8owCAjwmkM86g2xOQwj3aWaQV4oz5VoXqUCZaXCuF8g9y06nNDjx9zHMseQ4g64yxMcirXUoVwGijjo3DDsdOnNvyQA1HgDIrAg3QoVWtppj7aEzZu1SG949M9oFFPfs+ddNRNF78hNd7A7LSHydjZJdUwElGCJAlkttbsPNgZsBqsKsysiVgNhWAA6uVfRnCKxkxhH8658wOnu7Y3H/uLWgHlQGiW64SbYVJ1svtvbzL6j4kklHyT6nkwk5sI5eqllGyzp+Q6OsA5WP4IcCd1tRH0N7NCU4+46GTUE3ahHZptYv4tZxvzrUqefyFxmJTe3fmHznWtIB6+tDPIZGEEZVH19001FSxSadYjoaLZE8HRAEVhhtre+0vBZUtoyuHHoI2yAC0Yd4rsvMIJzptDudogFfr8zOSR5lGkEngfGH/kzwzVjsVmHj+rtpU2OFC3xoWiI+dRnfhIC9oeJM5fH2ePqlWy7vzXTwjVhJUEpgd8xUyGw6yBM53pHV4pkcpIlnp9/sfV1aAk54rMsVHBwfH5JwohRUoa/VM1C4JLMXRWPtnXrNpFZTf5SRPvX13Oia5p1mHZX1un43hTpUPz9Fpu6i9mI/fmiQnHnikUnGuUFLtYOqGsHYqpGxwTQDAtolBPT7YLevxS02OuQk/oY0cJAuMEOWNBkv+Oiwda1bi0b+MoJHv9enkr9KzP1JHqoUWVYKMqwNVwqlW4GHjeFgdHUzOvwF6Hn8hiWY1mkQaoYmPtxkvdXbPlswIX2mnjSNdWxwW08oJ2jKp/u13eb2IvTevpH4hIa87gTr2W6Tw4NgSL365C1dkuws/hAIM9puZX6Pxgrti9RP4StW3C6Z4RaO9bxkTvjWf0WktJiCwyPRME6E3SISyjBawOKxD+PF497jevJL/Ve8enYzbZG+YLChU6PWt/aHjhjKONndc1UaxgbDqRm+ZrI933y1DmpBhZ9XRcgFLy+xDh8iMAmVCvdJboZmSU0oITl8KzDeWqS5OfZA16oLV3Vr+g7HVjhs5r7lcrlj6UO/5utKyvp7MJ9wH5gWw7IXwr2sxnCOpbbCabNqVk2Fm1Vj78v22vqPyCANKTVE+kOmVM/yEs3c38JdoFmI4gPq9x2R9w+vCdfaQug2YReDEzRUd+zGjM1KEef5qyQHkHg/RA9//RRmFQ/1UukLUOFvtvl4yJZUOJ1EfSNc+bC+WZ5JUaCybezw2Yuz17D4vHdEYFWNe36EL/uvXx2fvLk4IWFimmSD7HHvqHfkryG1dXOmWjttfYC4DXHdNyD5/+v3ihH9pa9k+qVkwmPv8UuKgJtfZS1YdtD+VPEmz2baOiK5v6e689bI9Zoe/6nyqOfVTZ4tmBFUoDy4Hts8vv+Cvm3ug/P08R982lePexVKGLcigNufawHCvcXV1ueXa8JCI9BNEgeK4yBX95L4NBx27k0IqQ8rnvm+80Ha9kXF2dtLgnrjp5Rz/1VmZtiSUGC2DMKGguwhfP/sPpNMTSs2JdrAch2+Nplt4vq3HtePv5BSe82xCfgHLeh/0mnvgvv7cGewXtf04dV3roh2TdTkm5v1ev1vtqGvVw==","sidebar_class_name":"put api-method","info_path":"docs/API-docs/v1.2/opensign-api-v-1-2","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Get Document","permalink":"/docs/API-docs/v1.2/getdocument"},"next":{"title":"Revoke Document","permalink":"/docs/API-docs/v1.2/revokedocument"}}');var o=n(74848),a=n(28453),s=n(57742),d=n.n(s),p=n(78178),r=n.n(p),m=n(19624),c=n.n(m),l=n(96226),u=n.n(l),h=(n(77675),n(19365),n(51107)),g=n(21312);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:"eJzdWt1uG7kVfpXTWaCxhZHkZLNbVC3aZh1vEjSNDdtpgNqGRA2PJNYUOSU5kgVHwF4UfYCiN73tS/S+j7JPUhz+zIx+1kl2ty3Qi8T2zOHh+ec5H+c+c2xqs8FV9lwX1RyVs9lNnnG0hRGlE1plg+xyhvC25MwhJCp4dvYKmJR6aaGyaCw4DXPNxWQFTHGoArmbIXB0TEgLegIMbImFmIgCeGTUgzfaEzIHbiasZ6yVXCXuTidmDCa4hJIZNkeHxuaw0hUUTCntoJgxNQ0bToRE0KpAEC5IkIQWFgqDzCHvZXmmSzSMVHzFs0EWNkn6ZXnWbJQNru4zxeaYDbLEayh4lmeCzFMyN8u2bfbqOSm8sbvXUSFyr9QYo17Ex+CfKmGQZwNnKswz61aSdrNiXkrM8gzvSqk5ZoMJk5YIihnOWTa4z9yq9JTOCDXN8myizZy55sl6fRP4o3Vfab6iNZuinhm9EBxhjFK37NuyvMN5KZlDCwfMgURmHWiFLdqkwGGWZ4VWjkw4uM9YWUpReCP3/2hpt/td0fX4j1h4ixtyiRNo6W0w+IcVJOMwb6ZBZv0vtcmzdZ4p7T6ZzRmpiGBwIXDp49mKqQrx2ea9YcdP26KOijaPNa2RHA1F5C6/ZjVRomJjiaeXZy3SsdYSmdqJRooq6AYFtH8ISyElBB5wenkGCzSUmN5XPXjrc9rTGCxQLCj92iRQaI6wEAxwzoTMYTkTxYwCfgXzyjpAFWMomg5bKe+DGLqwKxAXdq9EeSgHQk2bcrPDGLgwWDi5gqVwM105YJwLWs4kWIel7bWt6KWoDXmpK/PDLclgWgmOHJyuDEy08VL6YlX6NCMNhLLOVAUttsAr8q7Xg0jp99LoAq1t7JSsQkQt/jmgsmE5gwmzDk0OlRJkeVOVDnnNEu9KNAJVgXtN4I079PU7Gtx+vC3O0MyFs0lTcg3jHFCiP0/AVsUMWHjPXGXQ5iCUcIJJm4N1bF7aHLQBh3dUV8Dpkoon3gnrSPil4FN0FsR3xdE5Uo4ULRkmRs+998k2atUOhFoup7fYXZJThY2n1oRV0sGCyWq/zSwqPhRqqA1HMwwCfITR3s1QgUVH2z8iCz7KAVkxi6LT/mOpi1vkUYmCYiGFSB3qlXJCUlJASQnqFU3Kz9gCodAkLsWAm6EwwIqQ2Sdqok2BFoLEYOloUOSMFCw9OPXnL9VutLAkgR+Rtq/UKen6iGRk0ib5e/A8GMub9JG3z6O9JjMYMnRYGbmvwG1a6iL0Chgc8vb8NYlisE4VNCH1xlSpA2OkzsMXJ6/8jtW2M2ynqLLK6aHBuVAcP6YcXARH+kxwuq4CldNz5kQBiZXtQSQNMet0O6nncJDibYwzthDaHH6HAYndkJobCj1coFm1pFTVfIxmR8g3/jGlFGcrC2N0S0TVli1Fvq4dX3jZvO83bEJUtlF6Q8ovwnErJquhVsMm3ffacVO3bZE7HeLe6UAXLtsO9O2bNlsnkwqHEPjN0wFFspOBqOsM0UI/7GbOX6tr1el4ET6wGTWZP9KG1PEO4BynzHCJ1oZOMRiWYjYHVkewTlvRkdaEPm+kpPakRV1QB+VlQmDOsWKGnJzGsUTFqbz6XB56ro+aFq537fuPEtWw0FKbtteYMWxF7a7Dud1N3HXLm1fZWFboW1pqbMeSFbfZzTrPxkXxfTnSif+b+Hev0PMs94+ebDzbmVrGRQEHYynIPMyMfVUoV4eD2NswTseoLyhbbc6GU4Px/TSxM0qkCtsDCMb7b6tIGv6ndSPN1nnmhNvoW4etQWg4prlivV77CmVLrWxI+idHR7vjRj1CxvGH+gMqxpNKytVPfrz5ITz+UCfNLH/y0p49fVmSR6JIz9zDi54cPfm8+/ioe/Szy8dfDp7+fPDFl72jo6M/ZHl2N5fN8JIRt6xtPf9364FQUigcJqsNnxwdDT+Ppny6z3pxNCnjzLZgUnCYCJQcaE/7IxoQjdHme45OD8j3kPqkclL+6QOhQ8V4oivF/9fq7pPoYQWfDp/WKn6xq+IrFUxGMMilvkX139Cw0ae9vQvbk6ibUS0CkX+fbSjbfh6UtFhURriVx1DuuqwU3fB+cHVDyMQc3UwT/lJWAXRxs2yQ9VN16d+36sw6I35mkSAZ30VmM+dKO+j3LVN8rO96ukRFZ6RkY0tls89K0V887j3J1vn2GlaWn0SPVfdTl1jHpkJNP7TupjHVBbkzeGzDYM3JUorfIh0t0R9tqohJzZBRA0seoCg5b/Cfk+Tr2p3boEnCTD4OBtk+k/YCG21cI8s2sIvY/rWH8Pho71Ca8K+9w1d8uTlm0H5bbX1Nt6+b/uK7mti4qt0h7e92YrPz8af6p1CvycMT7cMh5t1pieqCPENZ68Np2ymfQaL59s//qMmoF/0VdDrU9FJodq2uTBFAXs+PSYdGMUe9w7ff/A3GlZDOoxocFyipttic5gBL5/h4FUCf0giLttfpEP/2vlOxQOtB27q/RY+L8ACGdA0yvgLs1lYHgh2p/oKbGV1NZ763VlOJOZyfXFxOKkna0HClmpbY1sCLZ5LDnCk2bcGYJDMrbutx0DrmKo8vGGQSnJhj7uM9DnJIQhvSTphWnyTFBItVIYNxaBZPuNMCFdcGaI7vCuWb/m63Sz8++wxehC4fLhwzDjk9PaHQg4jSBvysYMaswr51MU4IyKiV8SMIue43GY1G16r1cgC/JA7Ng19FGpp6vv3LX+HqpV7SLDdFRWA4bm14c5DKGNeF3a1f9LQ/Q1n2L4JStv/s7JU/tw6D/99oB5Y8GWd3Ar6nQv2aOlWvS6cTCzegWgijFZm204GD0UcX9tEh8S2NdpoqZIP+TSZYeFNLimDOHNtyxbE2CMesZGMhBR2T9Pw9HDOHU21W8B7eEWgf7xmAa3h/rd53u13/j0g7nfripNOB93Ds7xdyoAKVxxY3pxKqb2NMcaS4b8Kzm9zehG/kfJni1XP+qhKSg8EqwgY1Ju8nw9Jgt5SsQJ7gsl94GcgyBNVrQ1mwqjGiuMUFykmX8tNv8SJFgaXHW4OmbexaY1VqIVyYJSZ0dxCZnlVjKQrYFP9ixgxNIGV4mVJPCnXr00fpxFUK6+oLhcTzuWETB++0uaWdAkeCuRrpPICYbMIscFphvcknQjEpbMRaiMIkvsdaOVZE5/0u1AmfA1GYIryHsda3FGJTw+Ye2mFSrhKTr/3hFnicmilTtFcjmVCWeuG6TD83FI7hRKw98Q7HM61vA5PzOLBROepSOQJcxC6zOQwhRKYBvVSAipdaKJfY+UEw8nJGIE1/RaGrBBjQGemAThJqbsmD7zdTgwL/22/+buENLqnupAODXn4Gzzyy4KvgOx9ucFGVpTbuWtFpMmL1ezuKAUljpdJLsIEQPRbhnVSbKo/Xc60HgSA5tiZoHpA2MabSQ6pftpdEfUm2vwjevIhR91qoW3utCJIbXWczwXEY/D2McTmUniIbBGjvfYDtRiTy6Oz04hL6XrAk54jSjNi0kZ8U3g1wvaEspKGg15j1mMAxNHXqJOcxea1GL04uoZ907A8EH3nlN59T8owCAjwmkM86g2xOQwj3aWaQV4oz5VoXqUCZaXCuF8g9y06nNDjx9zHMseQ4g64yxMcirXUoVwGijjo3DDsdOnNvyQA1HgDIrAg3QoVWtppj7aEzZu1SG949M9oFFPfs+ddNRNF78hNd7A7LSHydjZJdUwElGCJAlkttbsPNgZsBqsKsysiVgNhWAA6uVfRnCKxkxhH8658wOnu7Y3H/uLWgHlQGiW64SbYVJ1svtvbzL6j4kklHyT6nkwk5sI5eqllGyzp+Q6OsA5WP4IcCd1tRH0N7NCU4+46GTUE3ahHZptYv4tZxvzrUqefyFxmJTe3fmHznWtIB6+tDPIZGEEZVH19001FSxSadYjoaLZE8HRAEVhhtre+0vBZUtoyuHHoI2yAC0Yd4rsvMIJzptDudogFfr8zOSR5lGkEngfGH/kzwzVjsVmHj+rtpU2OFC3xoWiI+dRnfhIC9oeJM5fH2ePqlWy7vzXTwjVhJUEpgd8xUyGw6yBM53pHV4pkcpIlnp9/sfV1aAk54rMsVHBwfH5JwohRUoa/VM1C4JLMXRWPtnXrNpFZTf5SRPvX13Oia5p1mHZX1un43hTpUPz9Fpu6i9mI/fmiQnHnikUnGuUFLtYOqGsHYqpGxwTQDAtolBPT7YLevxS02OuQk/oY0cJAuMEOWNBkv+Oiwda1bi0b+MoJHv9enkr9KzP1JHqoUWVYKMqwNVwqlW4GHjeFgdHUzOvwF6Hn8hiWY1mkQaoYmPtxkvdXbPlswIX2mnjSNdWxwW08oJ2jKp/u13eb2IvTevpH4hIa87gTr2W6Tw4NgSL365C1dkuws/hAIM9puZX6Pxgrti9RP4StW3C6Z4RaO9bxkTvjWf0WktJiCwyPRME6E3SISyjBawOKxD+PF497jevJL/Ve8enYzbZG+YLChU6PWt/aHjhjKONndc1UaxgbDqRm+ZrI933y1DmpBhZ9XRcgFLy+xDh8iMAmVCvdJboZmSU0oITl8KzDeWqS5OfZA16oLV3Vr+g7HVjhs5r7lcrlj6UO/5utKyvp7MJ9wH5gWw7IXwr2sxnCOpbbCabNqVk2Fm1Vj78v22vqPyCANKTVE+kOmVM/yEs3c38JdoFmI4gPq9x2R9w+vCdfaQug2YReDEzRUd+zGjM1KEef5qyQHkHg/RA9//RRmFQ/1UukLUOFvtvl4yJZUOJ1EfSNc+bC+WZ5JUaCybezw2Yuz17D4vHdEYFWNe36EL/uvXx2fvLk4IWFimmSD7HHvqHfkryG1dXOmWjttfYC4DXHdNyD5/+v3ihH9pa9k+qVkwmPv8UuKgJtfZS1YdtD+VPEmz2baOiK5v6e689bI9Zoe/6nyqOfVTZ4tmBFUoDy4Hts8vv+Cvm3ug/P08R982lePexVKGLcigNufawHCvcXV1ueXa8JCI9BNEgeK4yBX95L4NBx27k0IqQ8rnvm+80Ha9kXF2dtLgnrjp5Rz/1VmZtiSUGC2DMKGguwhfP/sPpNMTSs2JdrAch2+Nplt4vq3HtePv5BSe82xCfgHLeh/0mnvgvv7cGewXtf04dV3roh2TdTkm5v1ev1vtqGvVw==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/v1.2/opensign-api-v-1-2",custom_edit_url:null},v=void 0,w={},b=[];function x(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:(0,o.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,o.jsx)(r(),{...n(66370)}),"\n",(0,o.jsx)(c(),{...n(32744)}),"\n",(0,o.jsx)(u(),{...n(46658)})]})}function y(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},66370(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"}}]}')},32744(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},"send_in_order_strict":{"type":"boolean","description":"When set to \'true\', each signer is blocked from accessing the document until all preceding signers have completed their action. Enforces strict sequential signing. Only applies when \'sendInOrder\' is also \'true\'. Defaults to \'false\'.","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"},"cc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"],"description":"cc (carbon copy): Users added here will receive a notification email once the document is completed.\\n"}},"title":"document_document_id_body"}}}}}')},46658(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