{"_id":"5450c792a66f020800dba83e","version":{"_id":"543d1e5e5276641a00a593cf","forked_from":"543d1e263a300f20000d31fe","project":"543d1e263a300f20000d31fb","__v":16,"createdAt":"2014-10-14T13:00:14.946Z","releaseDate":"2014-10-14T13:00:14.946Z","categories":["543d1e5f5276641a00a593d0","543d1ee45276641a00a593da","5448e2cbc64edd1a00453c29","5449135acdc944220048845c","544a0a93778b3e08002b2289","544a0a9727b7fc140078da58","544a456f27b7fc140078daff","544e027cbd51b9080037f680","544e029ab80812080035bba6","544e3a2eb80812080035bd67","5450b7c5a66f020800dba7b3","5450c0e47abbbc0800a5e989","5450c0f97abbbc0800a5e98a","5450c103a66f020800dba819","54f99f588d09b7390007ea45","565c81dbf3e9360d00823e43"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams2":true,"parentDoc":null,"is_link":false,"user":"54352decadf50e0800b89024","editedParams":true,"project":"543d1e263a300f20000d31fb","__v":0,"category":{"_id":"5450c103a66f020800dba819","__v":5,"pages":["5450c240a66f020800dba827","5450c5c87abbbc0800a5e9a6","5450c792a66f020800dba83e","5450c8c67abbbc0800a5e9c0","5450cec17abbbc0800a5e9df"],"project":"543d1e263a300f20000d31fb","version":"543d1e5e5276641a00a593cf","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-29T10:27:15.385Z","from_sync":false,"order":9,"slug":"user","title":"User"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-29T10:55:14.350Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"put","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"id\": 1337,\n    \"ern\": \"ern:user:1337\",\n    \"gender\": \"male\",\n    \"birth_year\": 1989,\n    \"name\": \"Foo Bar\",\n    \"email\": \"foo:::at:::bar.com\",\n    \"permissions\": {\n        \"user\": [\"api.public\"],\n        \"foo@bar.com\": [\n          \"api.users.1337.read\",\n          \"api.users.1337.update\",\n          \"api.users.1337.delete\"\n       \t]\n    }\n}"},{"name":"","code":"{\n\t/* standard error response\n  \tPossible error codes in this response:\n   \t- 1411: \"current_password\" not set.\n    - 1201: \"current_password\" not the current password.\n    - 1400: Missing some required keys.\n    \t\t\t  Most likely the \"success_redirect\" or \"error_redirect.\n  */\n}","language":"json","status":400},{"code":"{\n\t/* User not found */\n}","language":"text","status":404}]},"try":true,"auth":"never","params":[{"_id":"5450c792a66f020800dba849","ref":"","in":"body","required":true,"desc":"Your API session token.","default":"","type":"string","name":"_token"},{"_id":"5450c792a66f020800dba848","ref":"","in":"body","required":false,"desc":"Your API session signature.","default":"","type":"string","name":"_signature"},{"_id":"5450c792a66f020800dba847","ref":"","in":"path","required":true,"desc":"The user id to update.","default":"","type":"string","name":"user_id"},{"_id":"5450c792a66f020800dba846","ref":"","in":"body","required":true,"desc":"Current user password. Needed to update user information.","default":"","type":"string","name":"current_password"},{"_id":"5450c792a66f020800dba845","ref":"","in":"body","required":false,"desc":"Real name of user","default":"","type":"string","name":"name"},{"_id":"5450c792a66f020800dba844","ref":"","in":"body","required":false,"desc":"new email to use (will trigger a new verify email)","default":"","type":"string","name":"email"},{"_id":"5450c792a66f020800dba843","ref":"","in":"body","required":false,"desc":"URL to redirect verify link to if success. (required if email is set)","default":"","type":"string","name":"success_redirect"},{"_id":"5450c792a66f020800dba842","ref":"","in":"body","required":false,"desc":"URL to redirect verify link to if error. (required if email is set)","default":"","type":"string","name":"error_redirect"},{"_id":"5450c792a66f020800dba841","ref":"","in":"body","required":false,"desc":"User's year of birth.","default":"","type":"int","name":"birth_year"},{"_id":"5450c792a66f020800dba840","ref":"","in":"body","required":false,"desc":"Users gender. Options are: \"male\" and \"female\".","default":"","type":"string","name":"gender"},{"_id":"5450c792a66f020800dba83f","ref":"","in":"body","required":false,"desc":"New user password.","default":"","type":"string","name":"password"}],"url":"/v2/users/:user_id"},"isReference":false,"order":2,"body":"Update user information.","excerpt":"","slug":"user-update","type":"endpoint","title":"User Update"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string
The user id to update.

Body Params

_token:
required
string
Your API session token.
_signature:
string
Your API session signature.
current_password:
required
string
Current user password. Needed to update user information.
name:
string
Real name of user
email:
string
new email to use (will trigger a new verify email)
success_redirect:
string
URL to redirect verify link to if success. (required if email is set)
error_redirect:
string
URL to redirect verify link to if error. (required if email is set)
birth_year:
integer
User's year of birth.
gender:
string
Users gender. Options are: "male" and "female".
password:
string
New user password.

Result Format


Documentation

Update user information.