Переименовать список

Метод lists/rename меняет название обычного списка, как переименование в интерфейсе. Параметры list_id и name, ответ и пример запроса.

Обновлено

Меняет название обычного списка — как переименование списка в интерфейсе.

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

Параметры

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

ID списка — id из ответа lists/get.

Пример: 65a6e5f4c0e8f20012d3a111

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

Новое название списка, до 120 символов.

Пример: Постоянные клиенты

Результат

Возвращает список с новым названием — как элемент lists/get.

{
  "status": "ok",
  "response": {
    "id": "65a6e5f4c0e8f20012d3a111",
    "name": "Постоянные клиенты",
    "count_users": 250
  }
}

Коды ошибок

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

Код

Когда

7

«Список не найден»: списка с таким list_id нет, он из чужого сообщества или это чёрный список. Та же ошибка, если list_id не передан или записан неверно.

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

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

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

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

curl
PHP
Python
JavaScript
curl -X POST https://bot-api.targethunter.ru/external-api/v2/lists/rename \
  -H "Authorization: Bearer <ваш_токен>" \
  -H "Content-Type: application/json" \
  -d '{"list_id": "65a6e5f4c0e8f20012d3a111", "name": "Постоянные клиенты"}'
$token = '<ваш_токен>';
$url = 'https://bot-api.targethunter.ru/external-api/v2/lists/rename';
$params = [
    'list_id' => '65a6e5f4c0e8f20012d3a111',
    '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/rename'
params = {
    'list_id': '65a6e5f4c0e8f20012d3a111',
    'name': 'Постоянные клиенты',
}

response = requests.post(url, json=params, headers={'Authorization': f'Bearer {token}'})
print(response.json())
const token = '<ваш_токен>';
const params = {
  "list_id": "65a6e5f4c0e8f20012d3a111",
  "name": "Постоянные клиенты"
};

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