Stop voting vote.AttachedVote.stop

Scope: vote

Who can execute the method: user with editing rights for the vote

The method vote.AttachedVote.stop halts an active vote, preventing further participation.

Method Parameters

There are three ways to call the method.

1. By the attached poll ID

Required parameters are marked with *

Name `type`	Description
attachId* `integer`	The ID of the attached vote, which can be obtained using the methods vote.AttachedVote.get or vote.AttachedVote.getMany

2. By the entity with the poll

Required parameters are marked with *

Name `type`	Description
moduleId* `string`	The module ID, possible values: `Im` for a poll in chat, `blog` for a poll in the feed
entityType* `string`	The object type, possible values: `Bitrix\\Vote\\Attachment\\ImMessageConnector` for a poll in chat, `Bitrix\\Vote\\Attachment\\BlogPostConnector` for a poll in the feed
entityId* `integer`	The ID of the entity, possible values: `id` of the chat message with the poll, which can be obtained using the method vote.Integration.Im.send, `id` of the post with the poll in the feed, which can be obtained using the method log.blogpost.get

3. By the signed ID

Required parameters are marked with *

Name `type`	Description
signedAttachId* `string`	The signed attachment ID, which can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"attachId":**put_attach_id**}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.AttachedVote.stop

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"attachId":**put_attach_id**,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/vote.AttachedVote.stop

try
        {
            const response = await $b24.callMethod(
                'vote.AttachedVote.stop',
                {
                    attachId: **put_attach_id**
                }
            );
            
            const result = response.getData().result;
            console.log('Stopped vote with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'vote.AttachedVote.stop',
                    [
                        'attachId' => **put_attach_id**
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error stopping attached vote: ' . $e->getMessage();
        }

BX24.callMethod(
            "vote.AttachedVote.stop",
            {
                "attachId": **put_attach_id**
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'vote.AttachedVote.stop',
            [
                'attachId' => **put_attach_id**
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [],
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00"
            }
        }

Returned Data

Name `type`	Description
result `array`	An empty array upon successful operation
time `time`	Information about the request execution time

Error Handling

HTTP status: 4xx

{
            "error": "ATTACH_NOT_FOUND",
            "error_description": "Attach not found"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`ATTACH_NOT_FOUND`	Vote not found
`ATTACH_READ_ACCESS_DENIED`	No permission to participate in the vote

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Resume Voting

Get Data of the Attached Vote

Stop voting vote.AttachedVote.stop

Method ParametersMethod Parameters

1. By the attached poll ID1. By the attached poll ID

2. By the entity with the poll2. By the entity with the poll

3. By the signed ID3. By the signed ID

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

1. By the attached poll ID

2. By the entity with the poll

3. By the signed ID

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning