Update User Field Values for Inventory Accounting Documents catalog.userfield.document.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:
catalogWho can execute the method: a user with the "View" and "Create and edit" permissions for documents of this type, as well as the "View product catalog" and "View Inventory Management area" permissions
The method catalog.userfield.document.update updates the values of user fields in inventory accounting documents.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
documentId* |
Identifier of the inventory accounting document. The identifier can be obtained using the catalog.document.list method |
|
fields* |
Fields to be updated (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
documentType* |
Inventory accounting document type. It must match the type of the Allowed values: types of inventory accounting documents |
|
fieldN |
Value of the user field, where You can retrieve custom field identifiers and settings using the userfieldconfig.list method. The catalog.userfield.document.list method also returns the To clear a value, pass an empty string or |
The method changes only the custom fields that are passed. The method skips keys in another format, for example UF_* codes, and fields that documents of this type do not have, without an error. Values can also be changed in a posted document.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":351,"fields":{"documentType":"A","field7097":"Delivery under contract No. 15"}}' \
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":351,"fields":{"documentType":"A","field7097":"Delivery under contract No. 15"},"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: 351,
fields: {
documentType: 'A',
field7097: 'Delivery under contract No. 15',
},
},
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: 351,
fields: {
documentType: 'A',
field7097: 'Delivery under contract No. 15',
},
},
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.userfield.document.update(
document_id=351,
fields={
"documentType": "A",
"field7097": "Delivery under contract No. 15",
},
).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.userfield.document.update',
[
'documentId' => 351,
'fields' => [
'documentType' => 'A',
'field7097' => 'Delivery under contract No. 15',
],
]
);
$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: 351,
fields: {
documentType: 'A',
field7097: 'Delivery under contract No. 15'
}
},
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' => 351,
'fields' => [
'documentType' => 'A',
'field7097' => 'Delivery under contract No. 15',
],
]
);
echo '<PRE>';
print_r($result['result']['document']);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.userfield.document.update", b24.Params{
"documentId": 351,
"fields": b24.Params{
"documentType": "A",
"field7097": "Delivery under contract No. 15",
},
})
if err != nil {
return fmt.Errorf("catalog.userfield.document.update: %w", err)
}
// The method wraps the response in an object with the "document" key.
raw, ok := b24.Unwrap(res.Result, "document")
if !ok {
return fmt.Errorf("no document key in the response")
}
var item struct {
DocumentID b24.ID `json:"documentId"`
DocumentType string `json:"documentType"`
Field7097 *string `json:"field7097"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.DocumentID, item.DocumentType)
Response Handling
HTTP status: 200
{
"result": {
"document": {
"documentId": 351,
"documentType": "A",
"field7097": "Delivery under contract No. 15"
}
},
"time": {
"start": 1793875710,
"finish": 1793875710.096168,
"duration": 0.09616804122924805,
"processing": 0,
"date_start": "2026-11-05T13:48:30+03:00",
"date_finish": "2026-11-05T13:48:30+03:00",
"operating_reset_at": 1793876280,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.document |
Object with updated values of the document's user fields |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "The specified document does not exist"
}
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Access Denied |
The user lacks the "Create and edit" or "View" permission for documents of this type, or the "View product catalog" or "View Inventory Management area" permission |
|
|
|
The specified document does not exist |
The document with the specified |
|
|
|
Could not find value for parameter |
The |
|
|
|
Could not find value for parameter |
The |
|
|
|
Required fields: documentType |
|
|
|
|
The DOC_TYPE field does not match the document |
The |
|
|
|
Internal server error. |
An array is passed to a single-value custom field |
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 |