Add Image to Product catalog.productImage.add

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: catalog

Who can execute the method: a user with the "View catalog products" permission and permission to edit the product

The method catalog.productImage.add adds an image to a product, parent product, variation, or service.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the fields of the new image (detailed description)

fileContent*
array

Array of two elements:

  • the first is the file name with an extension, for example photo.jpg
  • the second is the file content in Base64 encoding

The method checks the file type by the extension in the name: only image extensions are accepted

Parameter fields

Required parameters are marked with *

Name
type

Description

productId*
catalog_product.id|
catalog_product_sku.id|
catalog_product_offer.id|
catalog_product_service.id

Identifier of the product, parent product, variation, or service.

To obtain existing identifiers, use the following methods:

type
string

Image type:

  • DETAIL_PICTURE — detail image, the field is available in the old product card. Replaces the current detail image
  • PREVIEW_PICTURE — preview image, the field is available in the old product card. Replaces the current preview image
  • MORE_PHOTO — additional image. Added to the images already uploaded

Default: MORE_PHOTO. The method also saves any other value as MORE_PHOTO

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"productId":1,"type":"MORE_PHOTO"},"fileContent":["photo.png","iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg=="]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productImage.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"productId":1,"type":"MORE_PHOTO"},"fileContent":["photo.png","iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg=="],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.productImage.add
        
// 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type ProductImageAddResult = {
          productImage: {
            createTime: ISODate,
            detailUrl: string,
            downloadUrl: string,
            id: number,
            name: string,
            productId: number,
            type: 'DETAIL_PICTURE' | 'PREVIEW_PICTURE' | 'MORE_PHOTO',
          },
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ProductImageAddResult>({
            method: 'catalog.productImage.add',
            params: {
              fields: {
                productId: 1,
                type: 'MORE_PHOTO',
              },
              fileContent: [
                'photo.png',
                'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg==',
              ],
            },
            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.productImage.id, result.productImage.name, result.productImage.type)
          }
        } 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 addProductImage() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.productImage.add',
                params: {
                  fields: {
                    productId: 1,
                    type: 'MORE_PHOTO',
                  },
                  fileContent: [
                    'photo.png',
                    'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg==',
                  ],
                },
                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.productImage.id, result.productImage.name, result.productImage.type)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addProductImage)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product_image.add(
                fields={
                    "productId": 1,
                    "type": "MORE_PHOTO",
                },
                file_content=[
                    "photo.png",
                    "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg==",
                ],
            ).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(
                    'catalog.productImage.add',
                    [
                        'fields' => [
                            'productId' => 1,
                            'type' => 'MORE_PHOTO',
                        ],
                        'fileContent' => [
                            'photo.png',
                            'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg==',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding product image: ' . $e->getMessage();
        }
        
BX24.callMethod(
        'catalog.productImage.add',
        {
        'fields': {
        'productId': 1,
        'type': 'MORE_PHOTO'
        },
        'fileContent': [
        'photo.png',
        'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg=='
        ]
        },
        function(result) {
        if (result.error())
        console.error(result.error());
        else
        console.log(result.data());
        }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productImage.add',
            [
                'fields' => [
                    'productId' => 1,
                    'type' => 'MORE_PHOTO'
                ],
                'fileContent' => [
                    'photo.png',
                    'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg=='
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.productImage.add", b24.Params{
        	"fields": b24.Params{
        		"productId": 1,
        		"type":      "MORE_PHOTO",
        	},
        	"fileContent": []string{"photo.png", "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR4nGP4z8DwHwAFAAH/iZk9HQAAAABJRU5ErkJggg=="},
        })
        if err != nil {
        	return fmt.Errorf("catalog.productImage.add: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "productImage": {
                    "createTime": "2026-11-02T14:23:05+03:00",
                    "detailUrl": "https:\/\/cdn-com.bitrix24.com\/b1234567\/iblock\/26e\/26e2cde359418039bc36dc25c6c25c88\/photo.png",
                    "downloadUrl": "https:\/\/your-domain.bitrix24.com\/rest\/1\/xxxxxxxxxxxxxxxx\/download\/?token=catalog%7CaWQ9Mzk4NjcmXz1DV3JqWXptcVExY0JxaDVDQWJQa2ZoT29Bak9VSmRWZQ%3D%3D%7C...",
                    "id": 39867,
                    "name": "photo.png",
                    "productId": 533,
                    "type": "MORE_PHOTO"
                }
            },
            "time": {
                "start": 1793618585,
                "finish": 1793618585.566613,
                "duration": 0.566612958908081,
                "processing": 0,
                "date_start": "2026-11-02T14:23:05+03:00",
                "date_finish": "2026-11-02T14:23:05+03:00",
                "operating_reset_at": 1793619180,
                "operating": 0.4662008285522461
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response

result.productImage
catalog_product_image

Object with information about the added product image

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Product was not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

200040300020

Access Denied

The user does not have the "View catalog products" permission or permission to edit the product

400

100

Could not find value for parameter

The required parameter fields is not passed

400

100

Could not find value for parameter

The required parameter fileContent is not passed

400

0

Required fields: productId

The productId field is not passed in fields

400

0

Product was not found

The product with the specified productId was not found

400

0

Could not save image.

fileContent does not contain the file name or content

400

0

Invalid file type (txt)

The extension in the file name is not an image extension, or the name is empty. The passed extension is shown in parentheses

400

0

The filename contains invalid characters.

The file name contains invalid characters

400

0

Filename is too long.

The file name exceeds the allowed length

400

0

Maximum allowed size of the file to upload exceeded

The file size exceeds the Bitrix24 limit

400

0

Disk quota exceeded.

There is not enough space on the Bitrix24 disk

400

0

Image product property does not exists. Create MORE_PHOTO property

The catalog does not have a property with the MORE_PHOTO code for additional images

400

0

Image product property does not active. Activate MORE_PHOTO property

The MORE_PHOTO property is inactive

400

0

Image product property is of the wrong type

The MORE_PHOTO property is not a "File" property

400

0

Product image was not saved.

The preview image or detail image was not saved in the product, the changes were rolled back

400

0

Internal error adding product image. Try adding again.

Database error while saving. Repeat the request

400

0

Empty image.

After saving, no additional images were found for the product

File validation error messages are returned in the Bitrix24 interface language.

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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