{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/sites/:site_id/documents/:id","auth":"required","examples":{"codes":[]},"method":"put","params":[{"name":"auth_token","type":"string","default":"","desc":"Your authentication token.","required":true,"in":"body","ref":"","_id":"5628d5d748742a0d00474575"},{"name":"site_id","type":"int","default":"","desc":"Your project id or your own client_internal_unique_id. The site will be search first by client_internal_unique_id and if not found will be search by id.","required":true,"in":"path","ref":"","_id":"5628d5d748742a0d00474574"},{"name":"id","type":"int","default":"","desc":"The id of the current document to update.","required":true,"in":"path","ref":"","_id":"5628d5d748742a0d00474573"},{"name":"document.name","type":"string","default":"","desc":"The new name for the document.","required":false,"in":"body","ref":"","_id":"5628d5d748742a0d00474572"},{"name":"document.responsible","type":"string","default":"","desc":"The new responsible for the document.","required":false,"in":"body","ref":"","_id":"5628d5d748742a0d00474571"},{"name":"document.status","type":"string","default":"","desc":"The new status of the document, possible values: [received, to_receive, unknown]","required":false,"in":"body","ref":"","_id":"5628d5d748742a0d00474570"},{"name":"document.date","type":"yyyy-mm-dd","default":"","desc":"The new date for your document.","required":false,"in":"body","ref":"","_id":"5628d5d748742a0d0047456f"},{"name":"document.comment","type":"string","default":"","desc":"The new comment.","required":false,"in":"body","ref":"","_id":"5628d5d748742a0d0047456e"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  document : {\n    id: 999,\n    name: \"the new name\",\n    responsible: \"John Doe\",\n    status: \"unknown\",\n    date: \"2015-10-25\",\n    comment: \"The best document!\"\n  }\n}","name":""},{"status":204,"language":"text","code":""},{"code":"{\n  error: {\n    message: \"Date is not valid\"\n  }\n}","status":422,"language":"text"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Update a document","type":"endpoint","slug":"update-a-document","excerpt":"","body":"","updates":[],"order":19,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5628d5d748742a0d0047456d","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54870ea57810260b001c36af","5487116f7810260b001c36b5","548711797810260b001c36b6","548711807810260b001c36b7","548713127810260b001c36bd","548713247810260b001c36be","548713aa7810260b001c36c0","548713c2f907080b00fc49d5","548713eef907080b00fc49d9","54871a0db3441a1f00f20d78","54871b15b3441a1f00f20d7e","54871cbeb3441a1f00f20d87","548817fac178b40b00aa2eec","558a6dd975eaf50d004e4bf5","558a6e37dbe5b63700f8d1fe","56795d8c07bf6a0d0083ee9e","583e9d764ced340f00b05a5c","5d1f3f70b4648901728803b7","5d22f7db4c9e14005111e34f","5d22fa62a541770012a07464"],"_id":"54870ea57810260b001c36ae","createdAt":"2014-12-09T15:00:53.237Z","project":"54870ea47810260b001c36ab","releaseDate":"2014-12-09T15:00:53.237Z","__v":20},"parentDoc":null,"editedParams":true,"project":"54870ea47810260b001c36ab","category":{"sync":{"isSync":false,"url":""},"pages":["558a6e098d30cb2300873e1a","558a6e88dbe5b63700f8d201","558a6e9275eaf50d004e4bfa","558a6e9a8d30cb2300873e1c","558a79f2dbe5b63700f8d23f","5592abfb6bf22f170075b823","55a65e4580c8a30d00b32618","55ba22f804775a2f006280aa","55ba2648b3612925009d66f0","56045138e416560d00fa6484","560452e4e5102a0d0070f965","560455090c78b00d0039b18b","56176873a410c90d00c612aa","56176a014d9e4a17002a0e05","5628d38e0653060d00a2f7d9","5628d5d748742a0d0047456d","56a669cffb12a40d006c4826"],"title":"API","slug":"api","order":5,"from_sync":false,"reference":true,"_id":"558a6dd975eaf50d004e4bf5","version":"54870ea57810260b001c36ae","__v":17,"createdAt":"2015-06-24T08:44:09.019Z","project":"54870ea47810260b001c36ab"},"createdAt":"2015-10-22T12:25:59.380Z","githubsync":"","user":"54870d54f907080b00fc49cd","__v":2,"editedParams2":true,"updatedAt":"2019-07-08T08:09:00.208Z"}

putUpdate a document


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
required
integer
Your project id or your own client_internal_unique_id. The site will be search first by client_internal_unique_id and if not found will be search by id.
id:
required
integer
The id of the current document to update.

Body Params

auth_token:
required
string
Your authentication token.
document.name:
string
The new name for the document.
document.responsible:
string
The new responsible for the document.
document.status:
string
The new status of the document, possible values: [received, to_receive, unknown]
document.date:
yyyy-mm-dd
The new date for your document.
document.comment:
string
The new comment.

Result Format


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}