Upload and Attach an Image to the Block landing.block.uploadfile
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to 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"
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type UploadFileResult = {
id: number
src: string
}
try {
const response = await $b24.actions.v2.call.make<UploadFileResult>({
method: 'landing.block.uploadfile',
params: {
block: 39556,
picture: ['banner.png', '**base64_image_content**'],
params: {
width: 1200,
height: 675,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.id, result.src)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function uploadFile() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.block.uploadfile',
params: {
block: 39556,
picture: ['banner.png', '**base64_image_content**'],
params: {
width: 1200,
height: 675,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.id, result.src)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', uploadFile)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.block.uploadfile(
block=39556,
picture=[
"banner.png",
"**base64_image_content**",
],
params={
"width": 1200,
"height": 675,
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.block.uploadfile", b24.Params{
"block": 39556,
"picture": []string{"banner.png", "**base64_image_content**"},
"params": b24.Params{
"width": 1200,
"height": 675,
},
})
if err != nil {
return fmt.Errorf("landing.block.uploadfile: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
Src string `json:"src"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Src)
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
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: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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