Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can edit profiles of the users belonging to the departments they manage and their sub-departments.
|credentials (required)||credentials||Read the description of the Credentials object.|
|userId (required)||string||The ID of the user whose profile you want to update.|
|email (optional)||string||The email of the user.|
|password (optional)||string||The password of the user.|
|login (required)||string||The login of the user.|
|departmentId (required)||string||The department ID the user belongs to.|
If you assign one of the standard roles to the user (apart from Account Owner and Publisher), set one of the following values to the role parameter:
If you assign one of the custom roles to the users, set the custom value to the role parameter.
|roleId (required if the user role isPublisheror a custom role)||string||The roleId parameter is used, if you assign one of the custom roles or the Publisher role to the user.|
|manageableDepartmentIds (required if the user's role is Department Administrator,Publisher,or a custom role)||string|
An array with the IDs of the departments the user will manage.
|groups (optional)||string||Array of IDs of the groups the user will be added to.|
All required fields of the user profile must be included in the request (excluding the Country field type).
After the request has been completed, the system returns an object with the following properties:
|success||bool||True if the user's profile has been updated.|
|Unknown user||The user with the specified ID was not found.|
|Permission denied||The user has no permissions to update info of the specified user.|
|Wrong Parameters||One of the specified parameters is incorrect.|
|Invalid value <field_value>. Field <field_name> must be unique.||An error occurs if the Login and Email 'user_fields' have been changed. They should be unique.|