Удаление телефонного справочника

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

Удаляет собственный справочник с записями. Уже созданная рассылка содержит отдельные сообщения и продолжает существовать.

Запрос

Поле	Тип	Обязательно	Правило
id	string	Да	24 строчных шестнадцатеричных символа; документ должен быть доступен владельцу ключа.

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

{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "phonebook-remove",
  "data": {
    "id": "000000000000000000000003"
  }
}

Результат

После удаления возвращается только success; поля data нет.

{
  "success": true
}

Отказы

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

Код	Причина
PHONEBOOK-REMOVE-ID-INVALID-FORMAT	Идентификатор списка получателей имеет недопустимый формат
PHONEBOOK-REMOVE-ID-INVALID-TYPE	Идентификатор списка получателей имеет недопустимый тип значения
PHONEBOOK-REMOVE-ID-NOT-FOUND	Список получателей с таким идентификатором не найден
PHONEBOOK-REMOVE-ID-REQUIRED	Идентификатор списка получателей не указан