{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/classes/:class-id","auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"title\":\"My class 1\",\n  \"description\":\"Description of my class 1\",\n  \"greeting\":\"Greeting for my class 1\",\n  \"grade\":null,\n  \"class_sharing\":\"open\",\n  \"cover_image\":null,\n  \"min_score\":1,\n  \"collaborator\":null\n}"}]},"method":"put","params":[{"name":"class-id","type":"string","default":"","desc":"UUID","required":false,"in":"path","ref":"","_id":"569d640567331a0d002805b3"}],"results":{"codes":[{"name":"","status":204,"language":"json","code":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Update a Class","type":"endpoint","slug":"update-a-class","excerpt":"Update a Class using a JSON payload","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header name\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Authorization\",\n    \"0-1\": \"Token {{authorization access token}}\",\n    \"1-0\": \"Content-Type\",\n    \"1-1\": \"application/json\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The Class entity will be updated based on the JSON payload.  This payload can contain the title, grade, visibility.\",\n  \"title\": \"Note\"\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"569d66d671e3650d00acf01a","__v":0,"parentDoc":null,"user":"55dd6b48a649eb170083b97a","category":{"sync":{"isSync":false,"url":""},"pages":["569d80ae67331a0d002805d5","569d80ff5a2b060d00874219","569d81c315bb390d00db7101","569d82575a2b060d0087421c","569d82aeceb7510d00f2a693","569d833671e3650d00acf032","569d847915bb390d00db7104","569d84d50306a10d00ce99b7","569d85275a2b060d0087421f","569d85c6ceb7510d00f2a699"],"title":"Class/Teacher","slug":"taxonomy","order":4,"from_sync":false,"reference":false,"_id":"569d8006ec29360d00f667cb","createdAt":"2016-01-19T00:15:02.117Z","project":"56439dfe9eebf70d00490d54","version":"56439dff9eebf70d00490d57","__v":10},"editedParams":true,"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["56439dff9eebf70d00490d58","56439e17c92c470d002dec71","564ce88e802cd02100444274","564d07ff3657c43500bf1d33","564d0a312da1982d00b19b64","564d2aa92da1982d00b19b8c","564d30a8b88a37210082253e","564d362c2da1982d00b19ba0","569d664371e3650d00acf018","569d7eacec29360d00f667c9","569d8006ec29360d00f667cb","569d855e0306a10d00ce99b9","569d91d571e3650d00acf04c","569d91eeceb7510d00f2a6a3","569e8c262d320817003b806d","569e8f802d320817003b8072","56b038c914dfea0d0007cf05","5717b4f0681bb41900fc575a","5718e0a4cd483219007c2c9a","571924c8e967cb1700d078e9","571e2648edc4a92b00a4cc65","576a677a6f15260e001f899b","576c5eaf5738570e00ff070f","578d127ed9c55c2000d4f213","579f90927ebe9b0e00059c50","582c0af888708a0f00570a69"],"_id":"56439dff9eebf70d00490d57","createdAt":"2015-11-11T19:58:55.144Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2015-11-11T19:58:55.144Z","__v":26},"createdAt":"2016-01-18T22:27:34.169Z","editedParams2":true,"githubsync":"","project":"56439dfe9eebf70d00490d54"}

putUpdate a Class

Update a Class using a JSON payload

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

class-id:
string
UUID

Examples


Documentation

[block:parameters] { "data": { "h-0": "Header name", "h-1": "Value", "0-0": "Authorization", "0-1": "Token {{authorization access token}}", "1-0": "Content-Type", "1-1": "application/json" }, "cols": 2, "rows": 2 } [/block] [block:callout] { "type": "info", "body": "The Class entity will be updated based on the JSON payload. This payload can contain the title, grade, visibility.", "title": "Note" } [/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 }}