Save File to Your Drive im.disk.file.save

Scope: im

Who can execute the method: chat participant

The method im.disk.file.save saves a file from the chat to the user's personal Drive.

The file is saved in the Saved Files folder. If the folder does not exist, the system will create it automatically.

Method Parameters

Required parameters are marked with *

Name `type`	Description
FILE_ID* `integer`	File identifier

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 '{"FILE_ID":5155}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.disk.file.save

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"FILE_ID":5155,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.disk.file.save

try
        {
            const response = await $b24.callMethod(
                'im.disk.file.save',
                {
                    FILE_ID: 5155
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.disk.file.save',
                    [
                        'FILE_ID' => 5155,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.disk.file.save',
            {
                FILE_ID: 5155
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.disk.file.save',
            [
                'FILE_ID' => 5155,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "folder": {
                    "id": 4821,
                    "name": "Saved Files"
                },
                "file": {
                    "id": 5159,
                    "name": "image.jpg"
                }
            },
            "time": {
                "start": 1772193101,
                "finish": 1772193101.625023,
                "duration": 0.6250228881835938,
                "processing": 0,
                "date_start": "2026-02-27T14:51:41+01:00",
                "date_finish": "2026-02-27T14:51:41+01:00",
                "operating_reset_at": 1772193701,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
result.folder `object`	The Saved Files folder on the personal Drive (detailed description)
result.file `object`	The saved file (detailed description)
time `time`	Information about the request execution time

Folder Object

Name `type`	Description
id `integer`	Folder identifier
name `string`	Folder name — Saved Files

File Object

Name `type`	Description
id `integer`	Identifier of the saved file
name `string`	Name of the saved file

Error Handling

HTTP Status: 400

{
            "error": "FILE_ID_EMPTY",
            "error_description": "File ID can't be empty"
        }

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

Status

Code

Description

Value

400

FILE_ID_EMPTY

File ID can't be empty

The required parameter FILE_ID is missing or empty

400

FILE_SAVE_ERROR

File ID can't be saved

Possible reasons:

The user does not have access to the chat from which the file needs to be saved
The specified file was not found
Drive is disabled
Failed to save the file in the Saved Files folder, for example, due to lack of space
Failed to create the Saved Files folder

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

Add a file to the chat

Delete a file from the chat folder

Save File to Your Drive im.disk.file.save

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Folder ObjectFolder Object

File ObjectFile Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning