Обновление информации о клиенте
Метод Update account используется для обновления информации о клиенте текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
PATCH {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | ||||
---|---|---|---|---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | ||||
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json | ||||
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json | ||||
base_url | path | string | Обязательный | URL ActivePlatform | ||||
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) | ||||
account_id | path | integer | Обязательный | ID клиента | ||||
data | form | object | Обязательный | Информация об атрибутах операции | ||||
attributes | form | object | Обязательный | Атрибуты операции | ||||
account_type_id | form | integer | Опциональный | ID типа клиента (см. Просмотр списка типов клиентов) | ||||
primary_name | form | string | Опциональный | Основное имя клиента (например, название компании для юридического лица) Использование в | ||||
first_name | form | string | Опциональный | Имя лица, уполномоченного на заключение договора | ||||
middle_name | form | string | Опциональный | Отчество лица, уполномоченного на заключение договора | ||||
last_name | form | string | Опциональный | Фамилия лица, уполномоченного на заключение договора | ||||
form | string | Опциональный | Email лица, уполномоченного на заключение договора | |||||
manager_id | form | integer | Опциональный | ID менеджера (сотрудника реселлера), который будет прикреплен к клиенту Менеджер должен иметь роль Менеджер по продажам и статус Активный (см. Получение информации о менеджере) | ||||
account_class_key | form | string | Опциональный | Ключ правила обслуживания, по которому будет обслуживаться клиент (см. Правила обслуживания) | ||||
tech_user_id | form | integer | Опциональный | |||||
bill_user_id | form | integer | Опциональный | ID сотрудника реселлера, указанного в качестве финансового контакта | ||||
country | form | string | Опциональный | Контакты: Код страны ISO 3166-1 alpha-2 Реселлер может ограничить список стран, доступных при создании клиента. См. раздел Настройки региона в Задание общих системных настроек. | ||||
region | form | string | Опциональный | Контакты: Регион (Область) | ||||
city | form | string | Опциональный | Контакты: Город | ||||
street | form | string | Опциональный | Контакты: Улица | ||||
building | form | string | Опциональный | Контакты: Дом | ||||
office | form | string | Опциональный | Контакты: Номер офиса (Помещение) | ||||
zip | form | string | Опциональный | Контакты: Почтовый индекс | ||||
phone | form | string | Опциональный | Контакты: Телефон в международном формате:
| ||||
financial_blocking_threshold_use_system | form | bool | Опциональный | Использование значения порога срабатывания финансовой блокировки из правила обслуживания:
| ||||
financial_blocking_threshold | form | float | Опциональный | Значение порога срабатывания финансовой блокировки, переопределенное на уровне клиента. Указывается, если | ||||
subscription_credit_limit_use_system | form | bool | Опциональный | Использование значения кредитного лимита по подписке из правила обслуживания:
| ||||
subscription_credit_limit | form | float | Опциональный | Значение кредитного лимита по подписке, переопределенное на уровне клиента Указывается, если | ||||
account_product_managers | form | object | Опциональный | Ответственные сотрудники для Клиента (см. Управление ответственными сотрудниками) | ||||
data | form | array | Опциональный | Информация об ответственных сотрудниках для клиента | ||||
product_id | form | integer | Опциональный | ID Продукта | ||||
manager_product_role_id | form | integer | Опциональный | ID роли сотрудника в рамках продукта | ||||
responsible_product_manager_id | form | integer | Опциональный | ID ответственного сотрудника в рамках продукта | ||||
custom_attributes | form | object | Опциональный | Дополнительные параметры клиента (см. Настройка дополнительных параметров). | ||||
data | form | array | Опциональный | Информация о дополнительных параметрах клиента | ||||
key | form | string | Опциональный | Ключ дополнительного параметра клиента | ||||
value | form | string | Опциональный | Значение дополнительного параметра клиента. В зависимости от типа данных значение дополнительного параметра указывается в следующем формате:
|
Модель ответа
В случае отсутствия ошибок метод возвращает обновленные данные об указанном клиенте (см. Получение информации о клиенте).
Ошибки
Статус ошибки | Текст ошибки | Комментарий |
---|---|---|
422 | Менеджер аккаунта должен иметь роль 'менеджер по продажам' и находится в статусе 'активный' | Если требуется прикрепить менеджера к клиенту, необходимо указать ID менеджера (сотрудника реселлера), который имеет роль Менеджер по продажам и статус Активный (см. Получение информации о менеджере) |
Клиент не может быть создан с указанной страной. Доступные варианты: <перечень> | Реселлер ограничил список стран, доступных при создании клиента. См. раздел Настройки региона в Задание общих системных настроек | |
У клиента должна быть хотя бы одна подписка на указанный продукт, чтобы назначить ответственного менеджера по продукту | Если требуется задать ответственных сотрудников для клиента, необходимо следующие данные:
| |
Указанная роль не настроена в продукте | ||
Cотрудник id не является ответственным менеджером по продукту | ||
Ошибки валидации параметров клиента отображаются аналогично Панели управления Оператора (см. Просмотр и обновление информации о клиенте в ActivePlatform. Панель управления Оператора) |
Пример запроса
PATCH /api/v3/resellers/1/accounts/800
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
"data": {
"attributes": {
"phone": "+375290000000"
}
}
}
Пример ответа
{
"data": {
"id": "800",
"type": "accounts",
"attributes": {
"created_at": "2020-11-19T11:42:21.438+03:00",
"updated_at": "2020-11-19T11:52:01.470+03:00",
"reseller_id": 1,
"name": "Velma Hoppe",
"account_class_id": 2121,
"primary_name": "",
"first_name": "Velma",
"middle_name": "",
"last_name": "Hoppe",
"country": "BY",
"region": "Minsk",
"city": "Minsk",
"street": "Mira",
"building": "1",
"office": "2",
"zip": "220000",
"phone": "+375290000000",
"email": "Mikel.Koss@example.org",
"status": "active",
"balance": "0.0",
"usable_balance": "0.0",
"current_debt": 0,
"subscription_credit_limit": 10000,
"financial_blocking_threshold": 0,
"account_type_id": 1,
"manager_id": 261,
"owner_id": 992,
"tech_user_id": 992,
"bill_user_id": 992,
"custom_attributes": {
"signer_first_name": "Signer"
},
"manager": {
"created_at": "2019-12-30T14:41:54.938+03:00",
"updated_at": "2020-11-04T14:20:57.430+03:00",
"reseller_id": 1,
"id": 261,
"name": "Annamae Nicolas",
"status": "active",
"email": "sales@manager.com",
"role": "sales",
"phone": null,
"photo": null,
"manager_key": "test",
"custom_attributes": {
"test": "1"
}
},
"owner": {
"created_at": "2020-11-19T11:42:21.421+03:00",
"updated_at": "2020-11-19T11:42:21.421+03:00",
"email": "kristoffer.haag@example.com",
"account_status": "active",
"global_status": "active",
"first_name": "Carlo",
"middle_name": "",
"last_name": "Yundt"
},
"account_product_managers": [],
"self_registration": false,
"default_payment_model": "postpay",
"account_type": {
"id": 1,
"name": "Personal",
"created_at": "2016-08-25T09:26:12.658+03:00",
"updated_at": "2019-10-02T03:30:11.716+03:00",
"reseller_id": 1,
"name_pattern": "%first_name %middle_name %last_name",
"primary_name": "",
"key": "personalblr",
"default_payment_method_id": 2,
"ancestry": null,
"use_by_default": false
},
"account_class": {
"id": 2121,
"reseller_id": 1,
"name": "POSTPAY",
"created_at": "2019-12-20T08:52:04.909+03:00",
"updated_at": "2019-12-20T08:59:36.544+03:00",
"financial_blocking_threshold": "0.0",
"due_order_period": 15,
"subzero_period": 1,
"stop_subscription_type": "automatically",
"key": "postpaytest",
"color": "grey",
"guaranteed_payment_limit": 1000,
"guaranteed_payment_period": 7,
"delete_subscription_type": "automatically",
"denominated": false,
"buy_with_negative_balance": false,
"receipt_day": null,
"payment_model": "postpay",
"default": false,
"due_payment_period": 3,
"subscription_credit_limit": "10000.0"
}
},
"relationships": {
"subscriptions": {
"data": []
}
}
}
}