Page tree
Skip to end of metadata
Go to start of metadata

You can update a user's profile with the updateUserProfile method.

Request Headers

credentials (required)credentialsRead the description of the Credentials object.
userId (required)stringID of the user, which profile you want to update.
fields (required)arrayAn array of objects with the following properties: name, value.
groups (optional)string[]An array of group IDs, to which a user will be added.


Return Value

After the request has been completed, the system returns an object with the following properties:

successboolTrue, if the user's profile has been updated.
exceededGroupstring[]An array of group IDs, to which a user hasn't been added, because of the exceeded number of users this group can contain.


Sample Call

Sample Response