Unbind Registered Event Handler event.unbind

Who can execute the method: administrator

The event.unbind method cancels a registered event handler.

This method works only in the context of application authorization and only when authorized under a user with administrative rights to the account.

Method Parameters

Required parameters are marked with *

Name
type

Description

event*
string

Event name

handler*
string

Link to the event handler

auth_type
integer

User identifier under which the event handler is authorized.

Note

If you need to remove event handlers set with an empty auth_type (authorized on behalf of the user who triggered the event), but keep the other handlers, specify auth_type=0 or an empty value for the parameter.

event_type
string

Values: online\|offline. By default, event_type=online, and the method's behavior remains unchanged. If event_type=offline is called, the method works with offline events

If any parameters are not specified, all event handlers that meet the other requirements will be removed.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "event": "ONCRMLEADADD",
            "handler": "https://www.my-domain.com/handler/",
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/event.unbind
        
BX24.callUnbind(
            'ONCRMLEADADD',
            'https://www.my-domain.com/handler/',
            15,
            (result) => console.log(result)
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'event.unbind',
            [
                'EVENT' => 'ONCRMLEADADD',
                'HANDLER' => 'https://www.my-domain.com/handler/',
                'AUTH_TYPE' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
try {
            $eventCode = 'your_event_code'; // Replace with your actual event code
            $handlerUrl = 'https://your.handler.url'; // Replace with your actual handler URL
            $userId = null; // Replace with your actual user ID or leave as null
            $result = $serviceBuilder
                ->getMainScope()
                ->event()
                ->unbind($eventCode, $handlerUrl, $userId);
            print($result->getUnbindedHandlersCount());
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }

Response Handling

HTTP status: 200

The method returns the number of event handlers removed upon invocation.

{
            "result": {
                "count": 1
            },
            "time": {
                "start": 1721298360.468008,
                "finish": 1721298360.553977,
                "duration": 0.0859689712524414,
                "processing": 0.0023431777954101562,
                "date_start": "2024-07-18T12:26:00+02:00",
                "date_finish": "2024-07-18T12:26:00+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response

time
time

Information about the request execution time

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

See Also

Continue Learning

Previous
Get a List of Handlers
Next
Security