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

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

Permission to run the request: Account Owner, Administrator, Organization Administrator. 

Request Headers

ParameterTypeDescription
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.
organizationId (optional)intAn organization to which a user will be moved.
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:

ParameterTypeDescription
successboolTrue, if the user's profile has been updated.

Possible Errors

 

TypeDescription
Unknown userUser with the specified ID was not found.
Permission deniedYou have no permissions to update info of the specified user.
WrongParametersOne of the specified parameters is incorrect.
Invalid value <field_value>. Field <field_name> must be unique.Error appears if the 'user_fields' login and email have been changed. They should be unique.

Sample Call

Sample Response

  •