Изменение записи черного списка

blacklist-update · POST /api/json/2020-01-01 · Все действия

Заменяет категорию, номер и комментарий. Отсутствующий comment удаляет старый комментарий. Чужую или глобальную запись ключ пользователя изменить не может.

Запрос

Поле	Тип	Обязательно	Правило
id	string	Да	24 строчных шестнадцатеричных символа; документ должен быть доступен владельцу ключа.
category	string	Да	*, sms_promo, sms_service или viber.
phone	string	Да	Знак + и 9–15 цифр без разделителей.
comment	string	Нет	После trim от 1 до 50 символов; пустую строку не передавайте.

Иллюстративный запрос (ключ и ID замените собственными):

{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "blacklist-update",
  "data": {
    "id": "000000000000000000000001",
    "category": "*",
    "phone": "+79401234567"
  }
}

Результат

data — объект; поля описаны в общем контракте результатов.

{
  "success": true,
  "data": {
    "id": "000000000000000000000001",
    "created": "2026-10-11T12:00:00+00:00",
    "updated": "2026-10-11T12:00:00+00:00",
    "category": "*",
    "phone": "+79401234567",
    "comment": "Получатель отказался от рекламы"
  }
}

Отказы

Общие ошибки запроса и доступа применяются ко всем действиям. Неизвестные поля отклоняются; проверяйте success даже при HTTP 200.

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