Метод используется для изменения параметров одной или сразу нескольких категорий уведомлений для аккаунта, к которому есть доступ у текущего пользователя. Метод возвращает пустой ответ. Код ответа 204 No content. Метод возвращает ответ с ошибкой, только если невалидные значения были указаны для всех изменяемых категорий уведомлений.
PATCH {reseller_domain}/internal_api/accounts/{account_id}/notification_categories
В этой статье:
Авторизация
Требуется авторизация с помощью access token пользователя.
Аргументы
|
Название |
Тип параметра |
Тип данных |
Обязательный/
|
Описание |
|---|---|---|---|---|
|
Content-Type |
header |
string |
Обязательный |
Тип данных, передаваемых в запросе. Укажите application/vnd.api+json |
|
Accept |
header |
string |
Обязательный |
Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json |
|
X-Api-Locale |
header |
string |
Опциональный |
Двухбуквенный код языка данных в ответе |
|
Authorization |
header |
string |
Обязательный |
Действующий access token пользователя. Формат: |
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
|
account_id |
path |
integer |
Обязательный |
ID аккаунта, для которого обновляется информация о категориях уведомлений |
|
notification_category_id |
form |
integer |
Обязательный |
ID категории уведомлений |
|
sms |
form |
bool |
Опциональный |
Целевое состояние признака получения sms-уведомлений для категории:
|
|
|
form |
bool |
Опциональный |
Целевое состояние признака получения email-уведомлений для категории:
|
|
balance_limit |
form |
string |
Опциональный |
Порог срабатывания события уведомлений Недостаточно средств на балансе для аккаунта. Можно указывать только для категорий уведомлений, у которых |
Пример запроса
curl --location --request PATCH 'https://test.activeplatform.com/internal_api/accounts/1938/notification_categories' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
"data": {
"attributes": [
{
"notification_category_id": 5,
"sms": false,
"email": true,
"balance_limit": "9.99"
},
{
"notification_category_id": 4,
"sms": false,
"email": true
}
]
}
}'