Обновление записей в черном списке

Метод blacklist-update предназначен для обновления записей в черном списке.

Параметры запроса

Параметр	Тип	Обязательный	Описание
id	string	Да	Идентификатор записи
category	string	Да	Категория черного списка. Допустимые значения: sms_promo sms_service viber *
phone	string	Да	Номер телефона в международном формате
comment	string	Нет	Комментарий

Пример запроса

{
    "api_key": "541eab8c-3e2f-5c47-3278-37206b391dd0",
    "action": "blacklist-update",
    "data": {
        "category": "*",
        "phone": "+79401234567",
        "comment": "Клиент отказался от получения всех типов сообщений"
    }
}

Параметры ответа

Параметр	Тип	Описание
id	string	Идентификатор записи
created	datetime	Дата и время создания в формате ISO 8601
updated	datetime	Дата и время обновления в формате ISO 8601
category	string	Категория
phone	integer	Номер телефона
comment	integer	Комментарий. Параметр передается только если был указан при добавлении записи

Пример ответа

{
    "success": true,
    "data": {
        "id": "5d59b4c6-19b6-47b4-ba19-0a25ab599f80",
        "created": "2024-01-31T15:10:04+03:00",
        "updated": "2024-02-10T18:43:02+03:00",
        "category": "*",
        "phone": "+79401234567",
        "comment": "Клиент отказался от получения всех типов сообщений"
    }
}

Возможные ошибки

Ошибка	Описание
BLACKLIST-UPDATE-ID-REQUIRED	Не указан параметр id
BLACKLIST-UPDATE-ID-INVALID-TYPE	Параметр id имеет недопустимый тип
BLACKLIST-UPDATE-ID-INVALID-FORMAT	Параметр id не соответствует формату
BLACKLIST-UPDATE-ID-NOT-FOUND	Запись не найдена
BLACKLIST-UPDATE-CATEGORY-REQUIRED	Не указан параметр category
BLACKLIST-UPDATE-CATEGORY-INVALID-TYPE	Параметр category имеет недопустимый тип
BLACKLIST-UPDATE-CATEGORY-NOT-SUPPORTED	Параметр category имеет недопустимое значение
BLACKLIST-UPDATE-PHONE-REQUIRED	Не указан параметр phone
BLACKLIST-UPDATE-PHONE-INVALID-TYPE	Параметр phone имеет недопустимый тип
BLACKLIST-UPDATE-PHONE-INVALID-FORMAT	Параметр phone не соответствует формату
BLACKLIST-UPDATE-PHONE-DUPLICATE	Номер телефона уже существует в данной категории
BLACKLIST-UPDATE-COMMENT-INVALID-TYPE	Параметр comment имеет недопустимый тип
BLACKLIST-UPDATE-COMMENT-INVALID-FORMAT	Параметр comment не соответствует формату