Добавить значение списка в пользовательское поле forum.message.field.custom.enum.add

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

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

Scope: forum

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

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

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

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

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

Название
тип

Описание

fields*
object

Объект с полями нового значения списка. Описание полей

Параметр fields

Название
тип

Описание

fieldId*
integer

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

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

value*
string

Текст значения, который видит пользователь.

Передавайте непустую строку. При пустой строке значение не создается, но метод отвечает успешно и возвращает другое значение этого поля — последнее по идентификатору

sort
integer

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

По умолчанию: 500

xmlId
string

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

Если код не передан, Битрикс24 генерирует его автоматически — 32-символьную строку, например cd9b47f0dad282fb4332d61d14a31222

isDefault
boolean

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

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

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

Метод не снимает признак с других значений поля. Если значение по умолчанию уже есть, после добавления их станет несколько, даже у поля с одиночным выбором. Чтобы снять признак, передайте false нужному значению методом forum.message.field.custom.enum.update.

По умолчанию: false

Примеры кода

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"fieldId":6008093,"value":"Высокий","sort":10,"xmlId":"HIGH"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/forum.message.field.custom.enum.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"fieldId":6008093,"value":"Высокий","sort":10,"xmlId":"HIGH"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.enum.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

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

try {
  const response = await $b24.actions.v3.call.make<EnumValueAddResult>({
    method: 'forum.message.field.custom.enum.add',
    params: {
      fields: {
        fieldId: 6008093,
        value: 'Высокий',
        sort: 10,
        xmlId: 'HIGH',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

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

      const response = await $b24.actions.v3.call.make({
        method: 'forum.message.field.custom.enum.add',
        params: {
          fields: {
            fieldId: 6008093,
            value: 'Высокий',
            sort: 10,
            xmlId: 'HIGH',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

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

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

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

try:
    bitrix_response = client.forum.message.field.custom.enum.add(
        fields={
            "fieldId": 6008093,
            "value": "Высокий",
            "sort": 10,
            "xmlId": "HIGH",
        },
    ).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.add',
            [
                'fields' => [
                    'fieldId' => 6008093,
                    'value' => 'Высокий',
                    'sort' => 10,
                    'xmlId' => 'HIGH',
                ],
            ]
        );

    $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.add',
    {
        fields: {
            fieldId: 6008093,
            value: 'Высокий',
            sort: 10,
            xmlId: 'HIGH',
        },
    },
    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.add',
    [
        'fields' => [
            'fieldId' => 6008093,
            'value' => 'Высокий',
            'sort' => 10,
            'xmlId' => 'HIGH',
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "forum.message.field.custom.enum.add", b24.Params{
	"fields": b24.Params{
		"fieldId": 6008093,
		"value":   "Высокий",
		"sort":    10,
		"xmlId":   "HIGH",
	},
})
if err != nil {
	return fmt.Errorf("forum.message.field.custom.enum.add: %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.XMLID)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 4077,
            "fieldId": 6008093,
            "value": "Высокий",
            "isDefault": false,
            "sort": 10,
            "xmlId": "HIGH"
        }
    },
    "time": {
        "start": 1792670734,
        "finish": 1792670734.756363,
        "duration": 0.7563629150390625,
        "processing": 0,
        "date_start": "2026-10-22T15:05:34+03:00",
        "date_finish": "2026-10-22T15:05:34+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, 404, 500

{
    "error": {
        "code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION",
        "message": "Поле `999999999` не найдено"
    }
}

Название
тип

Описание

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_DTOVALIDATIONEXCEPTION

Поле

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

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

fieldId

Не заполнено обязательное поле "fieldId"

Добавьте fieldId в fields

value

Не заполнено обязательное поле "value"

Добавьте value в fields

Поле не найдено

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

HTTP-статус: 404

Поле

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

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

-

Поле #FIELD_ID# не найдено

Пользовательского поля с таким fieldId нет у сообщений форума или его тип не enumeration. Проверьте идентификатор и тип поля методом forum.message.field.custom.list

Внутренняя ошибка

HTTP-статус: 500

{
    "error": "INTERNAL_SERVER_ERROR",
    "error_description": "Internal server error"
}

Причина

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

В поле уже есть значение с таким xmlId

Передайте уникальный xmlId или не передавайте его, чтобы код сгенерировался автоматически

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

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

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

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