Обновление Пользователя
Метод Update the User by ID позволяет обновить информацию о Пользователе, используя ID данного пользователя.
PUT /api/vendor/v1/users/{id}.json?api_token={api_token}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
id | path | integer | Обязательный | ID пользователя |
api_token | query | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о Сотруднике в ActivePlatform. Руководство по Панели управления Оператора) |
first_name | form | string | Опциональный | Имя |
middle_name | form | string | Опциональный | Отчество |
last_name | form | string | Опциональный | Фамилия |
password | form | string | Опциональный | Пароль пользователя. Требования к паролю описаны в разделе Настройки пароля в ActivePlatform. Руководство по Панели управления Оператора |
custom_attributes[][key] | form | string | Опциональный | Дополнительные параметры позволяют добавлять в ActivePlatform дополнительную информацию (см.Настройка Дополнительных параметров в ActivePlatform. Руководство по Панели управления Оператора). Ключ, который используется для обозначения элемента в API (см. Создание Дополнительного параметра вActivePlatform. Руководство по Панели управления Оператора) |
custom_attributes[][value] | form | string | Опциональный | Значение дополнительного параметра |
Модель ответа
Название | Тип данных | Описание |
---|---|---|
id | integer | Уникальный идентификационный номер пользователя |
first_name | string | Имя пользователя |
middle_name | string | Отчество пользователя |
last_name | string | Фамилия пользователя |
string | Электронная почта пользователя, которая используется в качестве логина | |
status | string | Глобальный статус пользователя в ActivePlatform вне зависимости от статуса пользователя для конкретного клиента:
|
custom_attributes | array | Дополнительные параметры пользователя (см. Настройка дополнительных параметров в ActivePlatform. Руководство по Панели управления Оператора):
|
created_at | date | Дата и время создания пользователя. |
updated_at | date | Дата и время последнего изменения информации о пользователе. |
Пример запроса
PUT http://billing.activeplatform.com:80/api/vendor/v1/users/2002986.json?api_token=654321
{
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"password": "N;T@o;y!4TNqlV",
"custom_attributes": [
{
"key": "age",
"value": "21"
}
]
}
Пример ответа
{
"id": 2002986,
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"email": "john.dooe@activeplatfrom.com",
"status": "active",
"custom_attributes": [
{
"name": "Age",
"value": "21"
}
],
"created_at": "2016-10-03T10:06:38.740+03:00",
"updated_at": "2016-10-07T14:25:10.924+03:00"
}