Изменить пользовательское поле сообщений форума forum.message.field.custom.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
forumКто может выполнять метод: любой пользователь
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод forum.message.field.custom.update изменяет пользовательское поле сообщений форума и возвращает его данные.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор пользовательского поля. Идентификатор можно получить методом forum.message.field.custom.list |
|
fields* |
Объект с полями пользовательского поля, которые нужно изменить. Передавайте только изменяемые поля. Описание полей Если передать пустой объект |
Если передать хотя бы одну подпись — editFormLabel, listColumnLabel, listFilterLabel, errorMessage или helpMessage, — все подписи, которых нет в запросе, очистятся. Чтобы изменить одну подпись, передайте вместе с ней текущие значения остальных.
Параметр fields
Код name и тип userTypeId изменить нельзя: если передать их в fields, метод их проигнорирует.
|
Название |
Описание |
|
xmlId |
Внешний код поля |
|
sort |
Порядок сортировки |
|
isMultiple |
Признак множественного поля. Возможные значения:
|
|
isMandatory |
Признак обязательного поля. Возможные значения:
|
|
showFilter |
Показ поля в фильтре списка. Возможные значения:
|
|
showInList |
Показывать ли поле в списке. Возможные значения:
|
|
editInList |
Разрешено ли редактировать значение поля. Возможные значения:
|
|
isSearchable |
Участвуют ли значения поля в поиске. Возможные значения:
|
|
settings |
Настройки типа поля. Битрикс24 не применяет переданные настройки: они остаются прежними |
|
editFormLabel |
Подпись поля в форме редактирования. Передавайте объектом, где ключ — код языка, значение — подпись, например |
|
listColumnLabel |
Заголовок колонки в списке. Формат такой же, как у |
|
listFilterLabel |
Подпись поля в фильтре. Формат такой же, как у |
|
errorMessage |
Текст ошибки при неверном значении поля. Формат такой же, как у |
|
helpMessage |
Текст подсказки к полю. Формат такой же, как у |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/forum.message.field.custom.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6008091,"fields":{"sort":150,"isMandatory":true,"editFormLabel":{"ru":"Код во внешней системе","en":"External system code"}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/forum.message.field.custom.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6008091,"fields":{"sort":150,"isMandatory":true,"editFormLabel":{"ru":"Код во внешней системе","en":"External system code"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CustomFieldUpdateResult = {
item: {
id: number
entityId: string
name: string
userTypeId: string
xmlId: string | null
sort: number
isMultiple: boolean
isMandatory: boolean
showFilter: string
showInList: boolean
editInList: boolean
isSearchable: boolean
settings: Record<string, unknown>
editFormLabel: string | null
listColumnLabel: string | null
listFilterLabel: string | null
errorMessage: string | null
helpMessage: string | null
}
}
try {
const response = await $b24.actions.v3.call.make<CustomFieldUpdateResult>({
method: 'forum.message.field.custom.update',
params: {
id: 6008091,
fields: {
sort: 150,
isMandatory: true,
editFormLabel: { ru: 'Код во внешней системе', en: 'External system code' },
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Custom field updated:', 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 updateCustomField() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'forum.message.field.custom.update',
params: {
id: 6008091,
fields: {
sort: 150,
isMandatory: true,
editFormLabel: { ru: 'Код во внешней системе', en: 'External system code' },
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Custom field updated:', result.item.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateCustomField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.forum.message.field.custom.update(
id=6008091,
fields={
"sort": 150,
"isMandatory": True,
"editFormLabel": {"ru": "Код во внешней системе", "en": "External system code"},
},
).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.update',
[
'id' => 6008091,
'fields' => [
'sort' => 150,
'isMandatory' => true,
'editFormLabel' => ['ru' => 'Код во внешней системе', 'en' => 'External system code'],
],
]
);
$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.update',
{
id: 6008091,
fields: {
sort: 150,
isMandatory: true,
editFormLabel: { ru: 'Код во внешней системе', en: 'External system code' },
},
},
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.update',
[
'id' => 6008091,
'fields' => [
'sort' => 150,
'isMandatory' => true,
'editFormLabel' => ['ru' => 'Код во внешней системе', 'en' => 'External system code'],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "forum.message.field.custom.update", b24.Params{
"id": 6008091,
"fields": b24.Params{
"sort": 150,
"isMandatory": true,
"editFormLabel": b24.Params{"ru": "Код во внешней системе", "en": "External system code"},
},
})
if err != nil {
return fmt.Errorf("forum.message.field.custom.update: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
ID int `json:"id"`
Sort int `json:"sort"`
IsMandatory bool `json:"isMandatory"`
EditFormLabel *string `json:"editFormLabel"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Sort, item.IsMandatory)
Обработка ответа
HTTP-статус: 200
В примере в запросе передана только подпись editFormLabel, поэтому подсказка helpMessage, заданная при создании поля, очистилась.
{
"result": {
"item": {
"id": 6008091,
"entityId": "FORUM_MESSAGE",
"name": "UF_EXTERNAL_ID",
"userTypeId": "string",
"xmlId": "EXTERNAL_ID",
"sort": 150,
"isMultiple": false,
"isMandatory": true,
"showFilter": "N",
"showInList": true,
"editInList": true,
"isSearchable": true,
"settings": {
"size": 20,
"rows": 1,
"regexp": "",
"minLength": 0,
"maxLength": 0,
"defaultValue": ""
},
"editFormLabel": "Код во внешней системе",
"listColumnLabel": null,
"listFilterLabel": null,
"errorMessage": null,
"helpMessage": null
}
},
"time": {
"start": 1792670693,
"finish": 1792670693.237927,
"duration": 0.23792695999145508,
"processing": 0,
"date_start": "2026-10-22T15:04:53+03:00",
"date_finish": "2026-10-22T15:04:53+03:00",
"operating_reset_at": 1792671240,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.item |
Пользовательское поле после изменения. Описание полей — в методе forum.message.field.custom.get |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Запись с ID = `999999999` не найдена"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено значение хотя бы одного обязательного поля: id, filter |
Передайте |
|
|
Должно быть передано только одно из значений: id, filter |
Передайте |
Ошибки валидации полей
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Значение поля не содержится в списке допустимых значений: N, I, E, S |
Передайте одно из значений |
Поле не найдено
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Пользовательского поля сообщений форума с таким |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить пользовательское поле сообщений форума forum.message.field.custom.add
- Получить пользовательское поле сообщений форума forum.message.field.custom.get
- Получить список пользовательских полей сообщений форума forum.message.field.custom.list
- Удалить пользовательское поле сообщений форума forum.message.field.custom.delete
- Сообщения форума: обзор методов
- Пользовательские поля сообщений форума: обзор методов