Создать список

Метод lists/create создаёт обычный список подписчиков, как кнопка «Создать список». Нужны group_id, channel и name; лимит 20 в минуту и 200 в сутки.

Обновлено

Создаёт в сообществе новый обычный список подписчиков — как кнопка «Создать список» в интерфейсе.

Нужен личный токен с продуктом BotHunter — как получить. Кому доступен: владельцу сообщества и сотрудникам с ролью «Админ (полный доступ)» или «Пользователи».

Лимит: не больше 20 созданий в минуту и 200 в сутки — вместе с vars/create и globalVars/create. Считается и попытка с ошибкой в параметрах, сутки начинаются в 03:00 по Москве. Сверх лимита — ошибка 5, ничего не создаётся.

Параметры

group_id
целое число
обязательный

Номер сообщества — group_id из ответа groups/get.

Пример: 123456

channel
строка
обязательный

Канал сообщества: VK, TG, OK, MAX, CHAT или AVITO — константы.

Пример: VK

name
строка
обязательный

Название списка, до 120 символов. Названия могут повторяться, как и в интерфейсе.

Пример: Клиенты

Результат

Возвращает созданный список — как элемент lists/get. Его id передавайте как list_id в остальные методы lists/*.

{
  "status": "ok",
  "response": {
    "id": "65a6e5f4c0e8f20012d3a111",
    "name": "Клиенты",
    "count_users": 0
  }
}

Коды ошибок

Общие ошибки — на странице API.

Код

Когда

5

«Слишком много созданий: не больше 20 в минуту и 200 в сутки. Повторите позже.»: лимит созданий исчерпан, ничего не создано.

7

Не передан group_id или channel, значение неверное или такого сообщества нет.

«Не указан обязательный параметр name»: name не передан или пустой.

«Поле "Название" должно принимать значение менее чем 120 символов.»: название длиннее 120 символов.

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

Подставьте свой токен вместо <ваш_токен>.

curl
PHP
Python
JavaScript
curl -X POST https://bot-api.targethunter.ru/external-api/v2/lists/create \
  -H "Authorization: Bearer <ваш_токен>" \
  -H "Content-Type: application/json" \
  -d '{"group_id": 123456, "channel": "VK", "name": "Клиенты"}'
$token = '<ваш_токен>';
$url = 'https://bot-api.targethunter.ru/external-api/v2/lists/create';
$params = [
    'group_id' => 123456,
    'channel' => 'VK',
    'name' => 'Клиенты',
];

$curl = curl_init($url);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($params),
]);

$response = json_decode(curl_exec($curl), true);
curl_close($curl);
import requests

token = '<ваш_токен>'
url = 'https://bot-api.targethunter.ru/external-api/v2/lists/create'
params = {
    'group_id': 123456,
    'channel': 'VK',
    'name': 'Клиенты',
}

response = requests.post(url, json=params, headers={'Authorization': f'Bearer {token}'})
print(response.json())
const token = '<ваш_токен>';
const params = {
  "group_id": 123456,
  "channel": "VK",
  "name": "Клиенты"
};

const response = await fetch('https://bot-api.targethunter.ru/external-api/v2/lists/create', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(params),
});
console.log(await response.json());