Update User Field Values for Inventory Accounting Documents catalog.userfield.document.update

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

Who can execute the method: a user with "Create and Edit" access permission for the required document type

The method catalog.userfield.document.update updates the values of user fields in inventory accounting documents.

Method Parameters

Required parameters are marked with *

Name
type

Description

documentId*
catalog_document.id

Identifier of the inventory accounting document. The identifier can be obtained using the catalog.document.list method

fields*
object

Fields to be updated (detailed description)

Parameter fields

Required parameters are marked with *

Name
type

Description

documentType*
string

Type of the inventory accounting document.

Allowed values: types of inventory accounting documents

fieldN
mixed

Value of the user field, where N is the identifier of the user field, for example field287.

Identifiers and settings for user fields can be obtained using the userfieldconfig.list method

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"documentId":81,"fields":{"documentType":"A","field7097":"Test Field"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.userfield.document.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"documentId":81,"fields":{"documentType":"A","field7097":"Test Field"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.userfield.document.update
        
// 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 UpdateUserfieldDocumentResult = {
          document: {
            documentId: number
            documentType: string
            [field: string]: unknown
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<UpdateUserfieldDocumentResult>({
            method: 'catalog.userfield.document.update',
            params: {
              documentId: 81,
              fields: {
                documentType: 'A',
                field7097: 'Test field value',
              },
            },
            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.document)
          }
        } 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 updateUserfieldDocument() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.userfield.document.update',
                params: {
                  documentId: 81,
                  fields: {
                    documentType: 'A',
                    field7097: 'Test field value',
                  },
                },
                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.document)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateUserfieldDocument)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.userfield.document.update',
                    [
                        'documentId' => 81,
                        'fields' => [
                            'documentType' => 'A',
                            'field7097' => 'Test Field',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result['document']);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating document user fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.userfield.document.update',
            {
                documentId: 81,
                fields: {
                    documentType: 'A',
                    field7097: 'Test Field'
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.userfield.document.update',
            [
                'documentId' => 81,
                'fields' => [
                    'documentType' => 'A',
                    'field7097' => 'Test Field',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result['result']['document']);
        echo '</PRE>';
        

Response Handling

HTTP Code: 200

{
            "result": {
                "document": {
                    "documentId": 81,
                    "documentType": "A",
                    "field7097": "Test Field"
                }
            },
            "time": {
                "start": 1774341924,
                "finish": 1774341924.459929,
                "duration": 0.4599289894104004,
                "processing": 0,
                "date_start": "2026-03-24T11:45:24+01:00",
                "date_finish": "2026-03-24T11:45:24+01:00",
                "operating_reset_at": 1774342524,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response

document
catalog_userfield_document

Object with updated values of the document's user fields

time
time

Information about the request execution time

Error Handling

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

HTTP Code: 400

{
            "error": "0",
            "error_description": "The specified document does not exist"
        }
        

Possible Error Codes

Code

Description

Value

0

The specified document does not exist

Document with the specified documentId not found

0

Access Denied

Insufficient rights to modify the document of the selected type

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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