Метод: updateUserProfile
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
userId (обязательный) | string | ID пользователя, чей профиль нужно обновить |
email (необязательный) | string | Email пользователя, профиль которого вы изменяете |
password (необязательный) | string | Пароль пользователя, профиль которого вы изменяете |
login (обязательный) | string | Логин нового пользователя |
departmentId (обязательный) | string | Подразделение, в которое будет перемещен пользователь |
role (необязательный) | string | Если вы назначаете пользователю одну из стандартных ролей (кроме Владельца аккаунта и Автора), присвойте параметру role одно из следующих значений:
Если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками, присвойте параметру role значение custom. Узнайте больше об использовании параметра role в разделе Важно |
roleId (обязательный, если в параметре role указано значение custom) | string | Параметр roleId используется, если вы назначаете пользователю роль Автора или одну из ролей с индивидуальными настройками. В этом случае присвойте параметру roleId ID нужной роли. Узнайте больше об использовании параметра roleId в разделе Важно |
manageableDepartmentIds (обязательный, если роль пользователя — department_administrator, publisher или роль с индивидуальными настройками) | string[] | Список ID подразделений, которыми будет управлять пользователь, если его роль — Администратор подразделения, Автор или роль с индивидуальными настройками |
groups (необязательный) | string[] | Список ID групп, в которые будет добавлен пользователь |
roles (необязательный) | string[] | Массив данных, с помощью которого вы можете назначить пользователю роли. Присвойте параметру roleId внутри массива ID нужной роли. Если вы назначаете две роли, одна из них — Сотрудник, а вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками). Узнайте больше об использовании параметра roles в разделе Важно |
about_me (необязательный) | string | Информация о пользователе в поле «О себе» |
Важно:
- Если в аккаунте есть обязательные поля пользовательского профиля (за исключением полей типа 'Cтрана'), их обязательно нужно указать в запросе.
- Роль для пользователя можно задать двумя способами:
- при помощи тегов role (если роль — Администратор аккаунта, Администратор подразделения или Сотрудник) и roleId (если роль — Автор или роль с индивидуальными настройками),
- при помощи массива данных roles.
- при помощи тегов role (если роль — Администратор аккаунта, Администратор подразделения или Сотрудник) и roleId (если роль — Автор или роль с индивидуальными настройками),
- Если для назначения роли пользователю вы используете массив данных roles, вы сможете выбрать две роли сразу.
Одна из ролей — Сотрудник, вторая — любая из административных ролей (Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками).
Если в массиве roles вы укажете две административные роли, пользователь не добавится. - Если вы указали роль для пользователя одновременно с помощью тегов role/roleId и массива данных roles, пользователю будет назначена роль или роли, указанные в массиве данных roles.
Значение, указанное в тегах role/roleId, в этом случае будет проигнорировано. - Если вы не указали роль пользователя ни с помощью тегов role/roleId, ни с помощью массива данных roles, у пользователя будет роль Сотрудник.
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут изменить профиль пользователя только своего подразделения и вложенных в него подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
success | bool | True, если профиль пользователя был обновлен. |
Возможные ошибки
Тип | Описание |
---|---|
Unknown User | Пользователь не найден. |
Permission denied | У пользователя недостаточно прав для обновления данных пользователя. |
Wrong Parameters | Один из указанных параметров задан неверно. |
Invalid value <field_value>. Field <field_name> must be unique. | Ошибка в случае редактирования user_field, которое должно быть уникальным (например, login/email). |
Пример запроса
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://new.webservice.namespace"> <SOAP-ENV:Body> <UpdateUserProfileRequest> <credentials> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials> <userId>string</userId> <fields> <field> <name>LOGIN</name> <value>eivanova@ispring.ru</value> </field> <field> <name>PASSWORD</name> <value>123456</value> </field> <field> <name>EMAIL</name> <value>eivanova@ispring.ru</value> </field> <field> <name>FIRST_NAME</name> <value>Екатерина</value> </field> <field> <name>LAST_NAME</name> <value>Иванова</value> </field> <field> <name>COUNTRY</name> <value>1</value> </field> </fields> <groups> <id>string</id> <id>string</id> </groups> <role>department_administrator</role> <departmentId>string</departmentId> <manageableDepartmentIds> <id>string</id> <id>string</id> </manageableDepartmentIds> <roles> <userRole> <roleId>eaf02558-2ae1-11e9-8b17-0242ac13000a</soap:roleId> </userRole> <userRole> <roleId>eaf01e14-2ae1-11e9-89a5-0242ac13000a</roleId> <manageableDepartmentIds> <id>8da0a5a4-b2a3-11e9-b20c-0a580af402f4</id> </manageableDepartmentIds> </userRole> </roles> <about_me>Помогаю новичкам стартовать в продажах и быстро входить в ритм.</about_me> </UpdateUserProfileRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://new.webservice.namespace"> <SOAP-ENV:Body> <UpdateUserProfileResult> <success>true</success> </UpdateUserProfileResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>