Create a chat from e-mail mail.message.createchat

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: mail

Who can execute the method: a user with access to the mailbox where the e-mail is located

The mail.message.createchat method creates a chat from an e-mail.

Method Parameters

Required parameters are marked with *

Name
type

Description

messageId*
integer

E-mail identifier.

The identifier can be obtained using the mail.message.list method.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ parameter to the request:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/mail.message.createchat

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"messageId":15}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/mail.message.createchat

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"messageId":15,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/mail.message.createchat

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl, fetch.

try
        {
            const response = await $b24.callMethod(
                'mail.message.createchat',
                {
                    messageId: 15
                }
            );
        
            const result = response.getData().result;
            console.log('Chat create:', result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl, fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'mail.message.createchat',
                    [
                        'messageId' => 15
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl, fetch.

BX24.callMethod(
            'mail.message.createchat',
            {
                messageId: 15
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl, fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'mail.message.createchat',
            [
                'messageId' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "success": true,
                "chatId": 100,
                "messageId": 15,
                "existing": false
            },
            "time": {
                "start": 1779819678,
                "finish": 1779819678.84803,
                "duration": 0.8480300903320312,
                "processing": 0,
                "date_start": "2026-05-26T21:21:18+03:00",
                "date_finish": "2026-05-26T21:21:18+03:00",
                "operating_reset_at": 1779820278,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with the operation result
success `boolean`	Indicator of successful operation execution
chatId `integer`	Created chat identifier
messageId `integer`	Original e-mail identifier
existing `boolean`	Indicator that the chat already existed
time `time`	Request execution time information

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object",
                "validation": [
                    {
                        "message": "Required field `messageId` is missing",
                        "field": "messageId"
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to fix
`messageId`	Mandatory field `messageId` is not specified or an incorrect value was passed	Pass `messageId` as a positive integer greater than `0`
`-`	Modules im/intranet are not installed	Install and configure the im and intranet modules
`messageId`	Message was deleted or moved to another folder	Check that the e-mail exists and is accessible to the current user
`-`	Failed to acquire lock for chat creation	Retry the request later
`-`	Failed to create chat	Check permissions and retry the request

Access Errors

Error code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field	Error description	How to fix
`-`	Access denied	Check user permissions and `mail` scope

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Create Calendar Event from E-mail

Create News Feed Message from E-mail

Create a chat from e-mail mail.message.createchat

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Access ErrorsAccess Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Access Errors

Statuses and System Error Codes

Continue Learning