Upload and Attach an Image to the Block landing.block.uploadfile
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:
landingWho can execute the method: a user with "edit" access permission for the site
The method landing.block.uploadfile uploads an image and attaches it to the specified block.
In response, the method returns the file identifier and a link to it in the src field. The method does not insert the image into the block itself. This means that after uploading, the file exists, but it is not yet displayed in the block's content. Typically, after landing.block.uploadfile, the landing.block.updatenodes method is called.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
scope |
Internal scope of landings. It is not related to the REST scope The value of |
|
block* |
Identifier of the block to which the image needs to be attached. The method accepts the identifier of any existing block. The block identifier can be obtained using the landing.block.getlist method. If the image needs to be added to a draft of a published page, use the block identifier from the draft. Typically, this is done by calling landing.block.getlist with the parameter |
|
Image to upload. The method only accepts images. Two formats are supported:
For the array, the file name must include the extension. In the second element of the array, provide only the Base64 content without the prefix When saving, the file name may change. Cyrillic letters are transliterated by the method, and spaces and parentheses are replaced with More about preparing Base64: How to upload files |
|
|
ext |
File extension for uploading via URL, if it cannot be accurately determined from the address. This parameter is only considered for If the parameter is not provided, the extension is determined automatically. For the |
|
params |
Additional parameters for image processing (detailed description). If the parameter is not provided, the image is saved without resizing |
|
If the value is cast to Default is |
Parameter params
|
Name |
Description |
|
width |
Target width of the image in pixels. Resizing is performed only if |
|
height |
Target height of the image in pixels. Resizing is performed only if |
|
resize_type |
Resizing mode. Possible values: Default is |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"block": 39556,
"picture": ["banner.png", "**base64_image_content**"],
"params": {
"width": 1200,
"height": 675
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.uploadfile.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"block": 39556,
"picture": ["banner.png", "**base64_image_content**"],
"params": {
"width": 1200,
"height": 675
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.block.uploadfile.json"
try
{
const response = await $b24.callMethod(
'landing.block.uploadfile',
{
block: 39556,
picture: ['banner.png', '**base64_image_content**'],
params: {
width: 1200,
height: 675
}
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.block.uploadfile',
[
'block' => 39556,
'picture' => ['banner.png', '**base64_image_content**'],
'params' => [
'width' => 1200,
'height' => 675,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error uploading image: ' . $e->getMessage();
}
BX24.callMethod(
'landing.block.uploadfile',
{
block: 39556,
picture: ['banner.png', '**base64_image_content**'],
params: {
width: 1200,
height: 675
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.block.uploadfile',
[
'block' => 39556,
'picture' => ['banner.png', '**base64_image_content**'],
'params' => [
'width' => 1200,
'height' => 675,
],
]
);
echo '<pre>';
print_r($result);
echo '</pre>';
Response Handling
HTTP status: 200
{
"result": {
"id": 33873,
"src": "https://cdn-com.bitrix24.com/b13743910/landing/fda/fda6c41d4b2b4f4d672601bd48c6aff1/nature.jpg"
},
"time": {
"start": 1774523909,
"finish": 1774523910.101491,
"duration": 1.1014909744262695,
"processing": 1,
"date_start": "2026-03-26T14:18:29+01:00",
"date_finish": "2026-03-26T14:18:30+01:00",
"operating_reset_at": 1774524509,
"operating": 0.30655694007873535
}
}
Returned Data
|
Name |
Description |
|
result |
Data of the uploaded file (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
id |
Identifier of the saved file |
|
src |
Address of the uploaded file. Depending on the environment, either a relative path or a full URL may be returned |
Error Handling
HTTP status: 400
{
"error": "FILE_ERROR",
"error_description": "File upload error. The file may not be a graphic."
}
|
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 |
|
|
Required parameter |
|
|
Block with identifier |
|
|
Failed to upload the image. This error is returned if the file could not be downloaded from the URL, read from Base64, failed the image check, SVG is not allowed on the account, or the file could not be saved |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
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
- Get the List of Page Blocks `landing.block.getlist`
- Update Nodes of the Block landing.block.updatenodes
- Get Block by ID `landing.block.getbyid`
- Publish the landing.landing.publication page
- Save to the list of blocks landing.landing.favoriteBlock
- Remove Blocks and Clear Image File Bindings on Page landing.landing.removeEntities