{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users","auth":"required","method":"put","examples":{"codes":[{"language":"json","code":"{\t\n\"first_name\"\t:\t\"Test\",\t\t\n\"last_name\"\t:\t\"Signup\",\t\t\n\"username\"\t:\t\"testsignup-1\",\t\t\n\"about\"\t:\t\"This\tis\tabout\tme\",\t\t\n \"user_category\"\t:\t\"teacher\",\t\n\"country\"\t:\t\"United\tStates\tof\tAmerica\",\t\t\n\"country_id\"\t:\t\"4ee8c715-60cb-42d2-8387-fa425a4f708a\",\t\t\n\"state\"\t:\t\"California\",\t\t\n\"state_id\"\t:\t\"4ee8c715-60cb-42d2-8387-fa425a4f708a\"\t\n}"}]},"results":{"codes":[]},"settings":"","params":[{"name":"first_name","type":"string","default":"","desc":"First\tname of the user. If\tpresent, should be not null. Max 20","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f95"},{"name":"last_name","type":"string","default":"","desc":"If present,should be not null. Last name\t of the user. Max 20","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f94"},{"name":"username","type":"string","default":"","desc":"Username. Should\tbe not null Min: 4,  Max:\t20","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f93"},{"name":"about","type":"string","default":"","desc":"Biography of the user.","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f92"},{"name":"user_category","type":"string","default":"","desc":"Whether the user teacher or student.","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f91"},{"name":"country","type":"string","default":"","desc":"Country of the user.","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f90"},{"name":"country_id","type":"string","default":"UUID","desc":"Country id of the user.","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f8f"},{"name":"state","type":"string","default":"","desc":"State to which user belongs.","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f8e"},{"name":"state_id","type":"string","default":"UUID","desc":"Stateid to which user belongs.","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f8d"},{"name":"thumbnail","type":"string","default":"","desc":"Thumbnail of the user.","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f8c"},{"name":"school_district_id","type":"string","default":"UUID","desc":"School District Id","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f8b"},{"name":"school_district","type":"string","default":"","desc":"School District","required":false,"in":"body","ref":"","_id":"5d42a44d681a0b00731a5f8a"}]},"next":{"description":"","pages":[]},"title":"Update User","type":"endpoint","slug":"update-user","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Authorization\",\n    \"0-1\": \"Token {{user token}}\",\n    \"1-0\": \"Content-Type\",\n    \"1-1\": \"application/json\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5d42a074f095260179f3bd1f","project":"56439dfe9eebf70d00490d54","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f","5dc4f96dbb5da3006c8f5660"],"_id":"5864d2df79ce642d00f0fec7","createdAt":"2016-12-29T09:09:51.074Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2016-12-29T09:09:51.074Z","__v":18},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"User Api's","slug":"user-apis","order":27,"from_sync":false,"reference":false,"_id":"5d429c616863d5003af785a7","project":"56439dfe9eebf70d00490d54","version":"5864d2df79ce642d00f0fec7","createdAt":"2019-08-01T08:01:37.088Z","__v":0},"user":"5d411a29005b9600113731fd","createdAt":"2019-08-01T08:19:00.009Z","__v":1,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

first_name:
string
First name of the user. If present, should be not null. Max 20
last_name:
string
If present,should be not null. Last name of the user. Max 20
username:
string
Username. Should be not null Min: 4, Max: 20
about:
string
Biography of the user.
user_category:
string
Whether the user teacher or student.
country:
string
Country of the user.
country_id:
stringUUID
Country id of the user.
state:
string
State to which user belongs.
state_id:
stringUUID
Stateid to which user belongs.
thumbnail:
string
Thumbnail of the user.
school_district_id:
stringUUID
School District Id
school_district:
string
School District

Examples


Documentation

[block:parameters] { "data": { "h-0": "Header Name", "h-1": "Value", "0-0": "Authorization", "0-1": "Token {{user token}}", "1-0": "Content-Type", "1-1": "application/json" }, "cols": 2, "rows": 2 } [/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 }}