Для AI-агентов: markdown этой страницы — /docs-content/polls/stop.md индекс документации — /llms.txt

Остановить опрос

POST /v1/polls/:pollId/stop

Завершает опрос. Право управления проверяет Битрикс24: для чата — автор сообщения, для Ленты — права управления постом.

Скоуп: vote. Ограничения ключей — Опросы.

Параметры

Параметр Тип Обяз. По умолч. Описание
ПараметрpollId (path) Типnumber Обяз.да По умолч.— ОписаниеПоложительный ID прикрепления: поле id из поиска опросов, не voteId

Тело запроса не требуется.

Запись выполняется один раз, без автоматического повтора. После неизвестного исхода прочитайте опрос и решите, нужна ли повторная запись.

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/polls/25/stop" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/polls/25/stop" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/polls/25/stop', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const result = await res.json()

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/polls/25/stop', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе

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

JSON 
{
  "success": true
}

Пример ответа при ошибке

404 — опроса с таким pollId нет или он недоступен ключу:

JSON 
{
  "success": false,
  "error": {
    "code": "POLL_NOT_FOUND",
    "message": "Poll not found or not accessible with this key."
  }
}

Ошибки

HTTP Код Причина и действие
HTTP400 КодINVALID_PARAMS Причина и действиеpollId не положительное целое число
HTTP401 КодTOKEN_MISSING Причина и действиеНет пользовательской сессии Битрикс24
HTTP403 КодSCOPE_DENIED Причина и действиеНет скоупа vote
HTTP403 КодCOWORK_READONLY Причина и действиеОперация запрещена для ключа Коворка «портал только для чтения»
HTTP403 КодWRITE_BLOCKED_READONLY_KEY Причина и действиеКлюч разрешает только чтение
HTTP404 КодPOLL_NOT_FOUND Причина и действиеОпрос не найден или недоступен
HTTP403 КодPOLL_ACCESS_DENIED Причина и действиеБитрикс24 запретил операцию
HTTP422 КодBITRIX_ERROR Причина и действиеБитрикс24 отклонил запрос, например метод недоступен в этой версии
HTTP502 КодPOLL_STOP_OUTCOME_UNKNOWN Причина и действиеЗапрос ушёл в Битрикс24, а исход не подтверждён: таймаут, обрыв соединения или ответ «Internal server error.». Прочитайте опрос и сверьте status, прежде чем повторять

Другие отказы авторизации, лимиты и общие ошибки — Ошибки.

Известные особенности

  • Повторная остановка уже остановленного опроса отвечает 200, состояние опроса не меняется.

Смотрите также