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

`POST /v1/polls/:pollId/stop`

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

**Скоуп:** `vote`. Ограничения ключей — [Опросы](/docs/polls).

## Параметры

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

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

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

## Примеры

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

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

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

```bash
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 | Код | Причина и действие |
| --- | --- | --- |
| 400 | `INVALID_PARAMS` | `pollId` не положительное целое число |
| 401 | `TOKEN_MISSING` | Нет пользовательской сессии Битрикс24 |
| 403 | `SCOPE_DENIED` | Нет скоупа `vote` |
| 403 | `COWORK_READONLY` | Операция запрещена для ключа Коворка «портал только для чтения» |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ разрешает только чтение |
| 404 | `POLL_NOT_FOUND` | Опрос не найден или недоступен |
| 403 | `POLL_ACCESS_DENIED` | Битрикс24 запретил операцию |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил запрос, например метод недоступен в этой версии |
| 502 | `POLL_STOP_OUTCOME_UNKNOWN` | Запрос ушёл в Битрикс24, а исход не подтверждён: таймаут, обрыв соединения или ответ «Internal server error.». Прочитайте [опрос](/docs/polls/get) и сверьте `status`, прежде чем повторять |

Другие отказы авторизации, лимиты и общие ошибки — [Ошибки](/docs/errors).

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

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

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

- [Опросы](/docs/polls)
- [Возобновить опрос](/docs/polls/resume)
- [Получить опрос](/docs/polls/get)