Clear records in the offline event queue event.offline.clear

Who can execute the method: any user

The method event.offline.clear clears records in the offline event queue. The availability of offline events can be checked through the method feature.get.

The method works only in the context of application authorization application.

Method parameters

Required parameters are marked with *

Name `type`	Description
process_id* `string`	Identifier of the process that handles the records
id `array`	Array of identifiers of the records to be cleared. By default, all records marked with the provided `process_id` will be cleared
message_id `array`	Array of values of the `MESSAGE_ID` field of the records to be cleared. Ignored if the `id` parameter is specified. By default, all records marked with the provided `process_id` will be cleared

Code examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
            "id": [2],
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/event.offline.clear

try
        {
        	const response = await $b24.callMethod(
        		'event.offline.clear',
        		{
        			'process_id': 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
        			'id': [2]
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'event.offline.clear',
                    [
                        'process_id' => 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
                        'id'        => [2],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error clearing offline event: ' . $e->getMessage();
        }

BX24.callMethod(
            "event.offline.clear",
            {
                "process_id": "yh3gu929sf0d32lsfysqas2y1hlpp09q",
                "id": [2]
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'event.offline.clear',
            [
                'process_id' => 'yh3gu929sf0d32lsfysqas2y1hlpp09q',
                'id' => [2]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1721300421.210707,
                "finish": 1721300421.331026,
                "duration": 0.12031912803649902,
                "processing": 0.0022459030151367188,
                "date_start": "2024-07-18T13:00:21+02:00",
                "date_finish": "2024-07-18T13:00:21+02:00",
                "operating": 0
            }
        }

Returned data

Name `type`	Description
result `boolean`	Success of execution
time `time`	Information about the execution time of the request

Error handling

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

Get a List of Offline Events with "Cleanup"

Clear records in the offline event queue event.offline.clear

Method parametersMethod parameters

Code examplesCode examples

Response handlingResponse handling

Returned dataReturned data

Error handlingError handling

Statuses and System Error CodesStatuses and System Error Codes

Continue learningContinue learning