{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/api/page/:path","auth":"never","basic_auth":false,"method":"put","params":[{"name":"path","type":"string","default":"","desc":"Page you want to update","required":false,"in":"path","ref":"","_id":"54680ab898b6840800268a45"},{"name":"page[meta]","type":"string","default":"","desc":"Stringified JSON containing page metadata","required":false,"in":"body","ref":"","_id":"54680ab898b6840800268a44"},{"name":"page[content]","type":"string","default":"","desc":"Content of page in markdown","required":false,"in":"body","ref":"","_id":"54680ab898b6840800268a43"}],"results":{"codes":[{"language":"json","code":"{\n  \"page\":{\n    \"path\":\"/super-duper.md\",\n    \"metadata\":{\n      \"description\":\"bla bla bla\",\n      \"title\":\"Super Duper\"\n    },\n    \"content\":\"This is awesome\"\n  }\n}","name":"","status":200},{"code":"{\n  \"code\":400,\n  \"status\":\"Bad Request\",\n  \"message\":\"Malformed JSON\"\n}","status":400,"language":"json"},{"status":404,"language":"json","code":"{\n  \"code\":404,\n  \"status\":\"Not Found\",\n  \"message\":\"Page does not exist\"\n}"}]},"try":false},"next":{"description":"","pages":[]},"title":"Update Page","type":"endpoint","slug":"update-page","excerpt":"","body":"If the title is changed, the file will be renamed to match the new title.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.ajax({\\n\\ttype: 'PUT',\\n  url: '/api/page/foo.md',\\n  data: {\\n  \\tmeta: JSON.stringify({\\n      title: 'Rick and Morty'\\n    }),\\n    content: '# wubalubadubdub'\\n  }\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","updates":["57fc2cc34002550e004c0387"],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54680ab898b6840800268a42","project":"5467f78598b68408002689f4","user":"5467f76e016b480800bc7c7d","category":{"sync":{"isSync":false,"url":""},"pages":["5467f78698b68408002689fa","54680584016b480800bc7ca0","546806af016b480800bc7ca3","5468084998b6840800268a28","546808fe016b480800bc7ca6","546809b098b6840800268a32","54680ab898b6840800268a42","54680b5d016b480800bc7cc2","54680b9a016b480800bc7cc5","5468293298b6840800268a79","54682958016b480800bc7cf9","54682fbc016b480800bc7cfd","54f664fd542ade0d00f1c69b"],"title":"API Documentation","slug":"api-documentation","order":0,"from_sync":false,"reference":false,"_id":"5467f78698b68408002689f8","__v":13,"project":"5467f78598b68408002689f4","createdAt":"2014-11-16T01:01:58.022Z","version":"5467f78598b68408002689f7"},"editedParams2":true,"is_link":false,"createdAt":"2014-11-16T02:23:52.662Z","editedParams":true,"githubsync":"","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5467f78698b68408002689f8"],"_id":"5467f78598b68408002689f7","project":"5467f78598b68408002689f4","releaseDate":"2014-11-16T01:01:57.550Z","__v":1,"createdAt":"2014-11-16T01:01:57.550Z"},"__v":1}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

path:
string
Page you want to update

Body Params

page[meta]:
string
Stringified JSON containing page metadata
page[content]:
string
Content of page in markdown

Result Format


Documentation

If the title is changed, the file will be renamed to match the new title. [block:code] { "codes": [ { "code": "$.ajax({\n\ttype: 'PUT',\n url: '/api/page/foo.md',\n data: {\n \tmeta: JSON.stringify({\n title: 'Rick and Morty'\n }),\n content: '# wubalubadubdub'\n }\n});", "language": "javascript" } ] } [/block]

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 }}