For AI agents: markdown of this page — /docs-content-en/polls/stop.md documentation index — /llms.txt

Stop a poll

POST /v1/polls/:pollId/stop

Finishes the poll. Bitrix24 checks management rights: the message author for a chat poll, or post management rights for a Feed poll.

Scope: vote. Key restrictions: Polls.

Parameters

Parameter Type Required Default Description
ParameterpollId (path) Typenumber Requiredyes Default— DescriptionPositive attachment ID: the id field from poll discovery, rather than voteId

No request body is required.

The write is attempted once, without automatic replay. After an unknown outcome, read the poll and decide whether another write is needed.

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

JavaScript — OAuth application

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

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success

Response example

Illustrative response based on the normalizer and test fixtures; not a live Bitrix24 response.

JSON 
{
  "success": true
}

Errors

HTTP Code Cause and action
HTTP400 CodeINVALID_PARAMS Cause and actionInvalid ID or request parameter
HTTP401 CodeTOKEN_MISSING Cause and actionNo Bitrix24 user session
HTTP403 CodeSCOPE_DENIED Cause and actionRequired scope is missing
HTTP403 CodeCOWORK_READONLY Cause and actionOperation forbidden for a Cowork portal-readonly key
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY Cause and actionThe key permits reads only
HTTP404 CodePOLL_NOT_FOUND Cause and actionPoll missing or inaccessible
HTTP403 CodePOLL_ACCESS_DENIED Cause and actionBitrix24 denied the operation
HTTP422 CodeBITRIX_ERROR Cause and actionBitrix24 rejected the request, for example because the method is unavailable in this version
HTTP502 CodePOLL_STOP_OUTCOME_UNKNOWN Cause and actionOutcome unknown: read the poll first

Other authentication refusals, limits and shared errors: error codes.

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid poll parameters."
  }
}