Update User
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
To save
customFields
you must first define thecustomFields
in admin panel (Accounts -> Registration -> Custom fields)To update the password for the user,
edit-other-user-password
permission must be set using an administrator account (Administration > Permissions).
Body Parameters
Argument | Example | Description |
---|---|---|
|
| The user ID to update. |
|
| The object that includes the user information to update with the following parameters. Note: If you provide an empty object, the user details are returned. |
|
| The email address for the user. |
|
| The display name of the user. |
|
| The password for the user. |
|
| The username for the user. |
|
| Whether the user is active, which determines if they can login or not. |
|
| The roles the user has been assigned. The default value is Note:
Refer to Roles for more information. |
|
| Whether the user should join the default channels. |
|
| Whether the user should be required to change their password when they login. |
|
| Whether the user should get a welcome email. |
|
| Whether the user's email address should be verified. |
|
| Any custom fields the user should have on their account. |
Example Call
Example Response
Change Log
Version | Description |
---|---|
0.48.0 | Renamed to |
0.35.0 | Added as |
Last updated