Изменить значение списка пользовательского поля forum.message.field.custom.enum.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: forum

Кто может выполнять метод: любой пользователь

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод forum.message.field.custom.enum.update изменяет значение пользовательского поля типа «Список» сообщений форума и возвращает его данные.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор значения списка, которое нужно изменить.

Идентификатор можно получить методом forum.message.field.custom.enum.list

fields*
object

Объект с полями значения, которые нужно изменить. Передавайте только изменяемые поля. Описание полей

Если передать пустой объект {}, метод вернет значение без изменений

Параметр fields

Название
тип

Описание

value
string

Новый текст значения. Пустая строка удаляет значение из списка

sort
integer

Порядок сортировки значения в списке

xmlId
string

Внешний код значения. Должен быть уникальным в пределах поля

isDefault
boolean

Признак значения по умолчанию.

Возможные значения:

  • true — значение выбирается по умолчанию
  • false — обычное значение

Метод не снимает признак с других значений поля. Чтобы по умолчанию было одно значение, передайте false остальным значениям

Значение нельзя перенести в другое поле: fieldId в fields метод игнорирует без ошибки.

Если передать value пустой строкой, метод удалит значение из списка. Ответ при этом будет успешным и вернет значение с "value": "", но методы forum.message.field.custom.enum.get и forum.message.field.custom.enum.list его уже не найдут. Чтобы удалить значение, используйте метод forum.message.field.custom.enum.delete.

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/forum.message.field.custom.enum.update

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":4077,"fields":{"value":"Срочный","sort":5}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/forum.message.field.custom.enum.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":4077,"fields":{"value":"Срочный","sort":5},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.enum.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type EnumValueUpdateResult = {
  item: {
    id: number
    fieldId: number
    value: string
    isDefault: boolean
    sort: number
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<EnumValueUpdateResult>({
    method: 'forum.message.field.custom.enum.update',
    params: {
      id: 4077,
      fields: {
        value: 'Срочный',
        sort: 5,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Enum value updated:', result.item.value)
  }
} 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 updateEnumValue() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'forum.message.field.custom.enum.update',
        params: {
          id: 4077,
          fields: {
            value: 'Срочный',
            sort: 5,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Enum value updated:', result.item.value)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateEnumValue)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.forum.message.field.custom.enum.update(
        id=4077,
        fields={
            "value": "Срочный",
            "sort": 5,
        },
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'forum.message.field.custom.enum.update',
            [
                'id' => 4077,
                'fields' => [
                    'value' => 'Срочный',
                    'sort' => 5,
                ],
            ]
        );

    $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();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'forum.message.field.custom.enum.update',
    {
        id: 4077,
        fields: {
            value: 'Срочный',
            sort: 5,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'forum.message.field.custom.enum.update',
    [
        'id' => 4077,
        'fields' => [
            'value' => 'Срочный',
            'sort' => 5,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "forum.message.field.custom.enum.update", b24.Params{
	"id": 4077,
	"fields": b24.Params{
		"value": "Срочный",
		"sort":  5,
	},
})
if err != nil {
	return fmt.Errorf("forum.message.field.custom.enum.update: %w", err)
}

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

var item struct {
	ID        int    `json:"id"`
	FieldID   int    `json:"fieldId"`
	Value     string `json:"value"`
	IsDefault bool   `json:"isDefault"`
	Sort      int    `json:"sort"`
	XMLID     string `json:"xmlId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Value, item.Sort)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 4077,
            "fieldId": 6008093,
            "value": "Срочный",
            "isDefault": false,
            "sort": 5,
            "xmlId": "HIGH"
        }
    },
    "time": {
        "start": 1792670749,
        "finish": 1792670749.13941,
        "duration": 0.13941001892089844,
        "processing": 0,
        "date_start": "2026-10-22T15:05:49+03:00",
        "date_finish": "2026-10-22T15:05:49+03:00",
        "operating_reset_at": 1792671300,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Значение списка после изменения. Описание полей

time
time

Информация о времени выполнения запроса

Объект item

Название
тип

Описание

id
integer

Идентификатор значения списка

fieldId
integer

Идентификатор пользовательского поля, к которому относится значение

value
string

Текст значения

isDefault
boolean

true — значение по умолчанию, false — обычное значение

sort
integer

Порядок сортировки

xmlId
string

Внешний код значения

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
        "message": "Запись с ID = `99999999` не найдена"
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

-

Не заполнено значение хотя бы одного обязательного поля: id, filter

Передайте id значения списка

-

Должно быть передано только одно из значений: id, filter

Передайте id значения списка

Значение не найдено

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Запись с ID = #ID# не найдена

Значения с таким id нет или оно относится к полю другого объекта. Получите идентификатор методом forum.message.field.custom.enum.list

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение