Copy File to Specified Folder disk.file.copyto
Scope:
diskWho can execute the method: a user with "Read" permission for the file and "Add" permission for the folder
The method disk.file.copyto copies a file to the specified folder.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the file |
|
targetFolderId* |
Identifier of the folder to which the file is copied |
File and folder identifiers can be obtained using the methods disk.storage.getchildren and disk.folder.getchildren
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":9035,"targetFolderId":8930}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.file.copyto
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":9035,"targetFolderId":8930,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/disk.file.copyto
try
{
const response = await $b24.callMethod(
'disk.file.copyto',
{
id: 9035,
targetFolderId: 8930,
}
);
const result = response.getData().result;
console.log('Copied file with ID:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'disk.file.copyto',
[
'id' => 9035,
'targetFolderId' => 8930
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error copying file: ' . $e->getMessage();
}
BX24.callMethod(
"disk.file.copyto",
{
id: 9035,
targetFolderId: 8930
},
function (result)
{
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'disk.file.copyto',
[
'id' => 9035,
'targetFolderId' => 8930
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"ID": 9037,
"NAME": "picture.png",
"CODE": null,
"STORAGE_ID": "1357",
"TYPE": "file",
"PARENT_ID": "8930",
"DELETED_TYPE": 0,
"GLOBAL_CONTENT_VERSION": 1,
"FILE_ID": 32933,
"SIZE": "1679",
"CREATE_TIME": "2026-02-09T11:35:49+02:00",
"UPDATE_TIME": "2026-02-09T11:35:49+02:00",
"DELETE_TIME": null,
"CREATED_BY": "1269",
"UPDATED_BY": "1269",
"DELETED_BY": null,
"DOWNLOAD_URL": "https://test.bitrix24.com/rest/download.json?auth=effc89690000071b006e2cf2000004f50000077d3d5d904ee6ccfc65bf287ca71f1fd6&token=disk%7CaWQ9OTAzNyZfPVhsRFgwaWJ2RTdLMXJlV1dhaEFPMEtoTjhVQ0s0MWNx%7CImRvd25sb2FkfGRpc2t8YVdROU9UQXpOeVpmUFZoc1JGZ3dhV0oyUlRkTE1YSmxWMWRoYUVGUE1FdG9UamhWUTBzME1XTnh8ZWZmYzg5NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDc3ZDNkNWQ5MDRlZTZjY2ZjNjViZjI4N2NhNzFmMWZkNiI%3D.fY5cpLbXwIiIO8X3NoiCzsMVAl2i6zegF4%2Bn86l0khg%3D",
"DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/file/Folder/Folder in folder/picture.png"
},
"time": {
"start": 1770647749,
"finish": 1770647749.342314,
"duration": 0.3423140048980713,
"processing": 0,
"date_start": "2026-02-09T11:35:49+02:00",
"date_finish": "2026-02-09T11:35:49+02:00",
"operating_reset_at": 1770648349,
"operating": 0.1015939712524414
}
}
Returned Data
|
Name |
Description |
|
result |
Array with file fields |
|
ID |
Identifier of the file |
|
NAME |
Name of the file |
|
CODE |
Symbolic code of the file |
|
STORAGE_ID |
Identifier of the storage where the file is located |
|
TYPE |
Type of the object |
|
PARENT_ID |
Identifier of the parent folder |
|
DELETED_TYPE |
Deletion status of the object. Possible values:
|
|
GLOBAL_CONTENT_VERSION |
Incremental version counter of the file |
|
FILE_ID |
Internal value of the file identifier |
|
SIZE |
Size of the file in bytes |
|
CREATE_TIME |
Date and time of file creation |
|
UPDATE_TIME |
Date and time of the last update of the file |
|
DELETE_TIME |
Date and time the file was moved to the trash |
|
CREATED_BY |
Identifier of the user who created the file |
|
UPDATED_BY |
Identifier of the user who made the last change |
|
DELETED_BY |
Identifier of the user who deleted the file |
|
DOWNLOAD_URL |
Link to download the file |
|
DETAIL_URL |
Link to open the file in the interface |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error":"ERROR_ARGUMENT",
"error_description":"Invalid value of parameter {Parameter #0}"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
Value |
|
|
Invalid value of parameter |
Required parameter |
|
|
A file with this name already exists |
A file with this name already exists |
|
|
Could not copy file |
Error creating a copy of the file in the database |
|
|
Could not find entity with id |
File with the specified |
|
|
Access denied |
Insufficient permissions to copy the file |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Permanently Delete File disk.file.delete
- Get Public Link for File disk.file.getExternalLink
- Get Description of File Fields for disk.file.getfields
- List of File Versions for disk.file.getVersions
- Get File Parameters disk.file.get
- Move File to Trash disk.file.markdeleted
- Move File to Specified Folder disk.file.moveto
- Rename File disk.file.rename
- Restore a File from a Specific Version disk.file.restoreFromVersion
- Restore File from Trash disk.file.restore
- Upload a New Version of a File `disk.file.uploadversion`