Update Inventory Document Custom Field Values v 3.0 catalog.document.userfield.update

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 "Create and edit" and "View" permissions for documents of this type and the "View product catalog" and "View Inventory Management area" permissions

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The method catalog.document.userfield.update updates the custom field values of an inventory document and returns them.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Inventory document identifier.

The identifier can be retrieved using the catalog.document.list method

fields*
object

Object with the document custom fields to update. Pass only the fields being changed. Field description

Parameter fields

Name
type

Description

docType*
string

Document type. Must match the type of the document id, otherwise the method returns an error

userFields
object

Custom field values. The key is FIELD_{id}, where {id} is the custom field identifier, or a field code of the form UF_*.

Custom field identifiers and codes can be retrieved using the userfieldconfig.list method.

Keys that documents of this type do not have are skipped by the method without an error

The method also updates the values of a processed document.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.document.userfield.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":325,"fields":{"docType":"A","userFields":{"FIELD_7097":"1"}}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.userfield.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":325,"fields":{"docType":"A","userFields":{"FIELD_7097":"1"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.document.userfield.update
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type DocumentUserfieldUpdateResult = {
          item: {
            id: number
            docType: string
            userFields: Record<string, unknown>
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<DocumentUserfieldUpdateResult>({
            method: 'catalog.document.userfield.update',
            params: {
              id: 325,
              fields: {
                docType: 'A',
                userFields: {
                  FIELD_7097: '1',
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('User fields:', result.item.userFields)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function documentUserfieldUpdate() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.document.userfield.update',
                params: {
                  id: 325,
                  fields: {
                    docType: 'A',
                    userFields: {
                      FIELD_7097: '1',
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('User fields:', result.item.userFields)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', documentUserfieldUpdate)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.document.userfield.update(
                bitrix_id=325,
                fields={
                    "docType": "A",
                    "userFields": {
                        "FIELD_7097": "1",
                    },
                },
            ).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}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.userfield.update',
                    [
                        'id' => 325,
                        'fields' => [
                            'docType' => 'A',
                            'userFields' => [
                                'FIELD_7097' => '1',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'catalog.document.userfield.update',
            {
                id: 325,
                fields: {
                    docType: 'A',
                    userFields: {
                        FIELD_7097: '1',
                    },
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.userfield.update',
            [
                'id' => 325,
                'fields' => [
                    'docType' => 'A',
                    'userFields' => [
                        'FIELD_7097' => '1',
                    ],
                ],
            ]
        );
        
        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.document.userfield.update", b24.Params{
        	"id":     325,
        	"fields": b24.Params{
        		"docType":    "A",
        		"userFields": b24.Params{
        			"FIELD_7097": "1",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.document.userfield.update: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        var item struct {
        	ID         int                        `json:"id"`
        	DocType    string                     `json:"docType"`
        	UserFields map[string]json.RawMessage `json:"userFields"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, len(item.UserFields))
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 325,
                    "docType": "A",
                    "userFields": {
                        "FIELD_7097": "1"
                    }
                }
            },
            "time": {
                "start": 1792665382,
                "finish": 1792665382.27269,
                "duration": 0.2726900577545166,
                "processing": 0,
                "date_start": "2026-10-22T13:36:22+02:00",
                "date_finish": "2026-10-22T13:36:22+02:00",
                "operating_reset_at": 1792665960,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.item
object

Custom field values of the document after the update. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Document identifier

docType
string

Document type

userFields
object

Values of all custom fields of the document. The keys are FIELD_{id}, not UF_* codes as in the catalog.document.userfield.list response

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "The docType field does not match the document"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

docType

Required field docType is empty

Pass docType in fields

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

-

At least one of the required fields must be not empty: id, filter

Pass the document id. This message comes together with a second one: "Only one of the following values must be provided: id, filter"

fields

Required field fields is missing

Pass the fields object

-

The docType field does not match the document

Pass the type of the document id in docType

userFields

This request requires data type array in field userFields

Pass userFields as an object

Filter Format Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error description

How to Fix

filter

Invalid filter filter

The method does not support filter. Pass the document id

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

id

Entity with ID #ID# was not found

There is no document with this identifier. Check the identifier using the catalog.document.list method

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity UserfieldDocumentDto

Pass only docType and userFields in fields

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Check the user's permissions for documents of this type and for the Inventory Management section

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