# catalog.userfield.document.update

URL: https://chugunov.pro/api-bitrix24/catalog/userfield-document/catalog-userfield-document-update/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Изменить значения пользовательских полей документов складского учета
Scope: `catalog`
Кто может выполнять метод: пользователь с правом «Создание и редактирование» на нужный тип документа

## Описание

Метод `catalog.userfield.document.update` обновляет значения пользовательских полей документа складского учета.

## Параметры

- `documentId` `catalog_document.id` — обязательный. Идентификатор документа складского учета. Идентификатор можно получить методом [catalog.document.list](https://chugunov.pro/api-bitrix24/catalog/document/catalog-document-list/)
- `fields` `object` — обязательный. Поля для обновления ([подробное описание](#fields))

### Параметр fields

- `documentType` `string` — обязательный. Тип документа складского учета.
  Допустимые значения: [типы документов складского учета](https://chugunov.pro/api-bitrix24/catalog/enum/catalog-enum-get-store-document-types/)
- `fieldN` `any` — необязательный. Значение пользовательского поля, где `N` — идентификатор пользовательского поля, например `field287`.
  Идентификаторы и настройки пользовательских полей можно получить методом [userfieldconfig.list](https://chugunov.pro/api-bitrix24/crm/universal/userfieldconfig/userfieldconfig-list/)

## Ответ

```json
{
    "result": {
        "document": {
            "documentId": 81,
            "documentType": "A",
            "field7097": "Тестовое поле"
        }
    },
    "time": {
        "start": 1774341924,
        "finish": 1774341924.459929,
        "duration": 0.4599289894104004,
        "processing": 0,
        "date_start": "2026-03-24T11:45:24+03:00",
        "date_finish": "2026-03-24T11:45:24+03:00",
        "operating_reset_at": 1774342524,
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `object`. Корневой элемент ответа
- `document` `catalog_userfield_document`. Объект с обновленными значениями пользовательских полей документа
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

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

- `0` — The specified document does not exist. Документ с указанным `documentId` не найден
- `0` — Access Denied. Недостаточно прав для изменения документа выбранного типа

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":81,"fields":{"documentType":"A","field7097":"Тестовое поле"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.userfield.document.update
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":81,"fields":{"documentType":"A","field7097":"Тестовое поле"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.userfield.document.update
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.userfield.document.update(
        document_id=81,
        fields={
            "field7097": "Новое значение",
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.userfield.document.update',
            [
                'documentId' => 81,
                'fields' => [
                    'documentType' => 'A',
                    'field7097' => 'Тестовое поле',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result['document']);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating document user fields: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'catalog.userfield.document.update',
    {
        documentId: 81,
        fields: {
            documentType: 'A',
            field7097: 'Тестовое поле'
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'catalog.userfield.document.update',
    [
        'documentId' => 81,
        'fields' => [
            'documentType' => 'A',
            'field7097' => 'Тестовое поле',
        ],
    ]
);

echo '<PRE>';
print_r($result['result']['document']);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.userfield.document.update", b24.Params{
	"documentId": 81,
	"fields": b24.Params{
		"documentType": "A",
		"field7097":    "Тестовое поле",
	},
})
if err != nil {
	return fmt.Errorf("catalog.userfield.document.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "document".
raw, ok := b24.Unwrap(res.Result, "document")
if !ok {
	return fmt.Errorf("в ответе нет ключа document")
}

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("разбор ответа: %w", err)
}
fmt.Println(item.DocumentID, item.DocumentType)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/catalog/userfield-document/catalog-userfield-document-update.html