Add List Value to Custom Field forum.message.field.custom.enum.add
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:
forumWho can execute the method: any user
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The forum.message.field.custom.enum.add method adds a value to a forum message custom field of the List type and returns the value data.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with the fields of the new list value. Field description |
Parameter fields
|
Name |
Description |
|
fieldId* |
Identifier of the custom field to add the value to. The field must be of the The identifier can be retrieved using the forum.message.field.custom.list method or from the response of the forum.message.field.custom.add method |
|
value* |
Value text that the user sees. Pass a non-empty string. With an empty string, no value is created, but the method responds successfully and returns another value of this field — the one with the highest identifier |
|
sort |
Sort order of the value in the list. Default: |
|
xmlId |
External code of the value. It must be unique within the field: a duplicate code causes an internal error with HTTP status 500. If the code is not passed, Bitrix24 generates it automatically — a 32-character string, for example |
|
isDefault |
Default value flag. Possible values:
The method does not clear the flag on other values of the field. If a default value already exists, after adding there will be several of them, even for a single-choice field. To clear the flag, pass Default: |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/forum.message.field.custom.enum.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"fieldId":6008093,"value":"High","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":"High","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: 'High',
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: 'High',
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": "High",
"sort": 10,
"xmlId": "HIGH",
},
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'forum.message.field.custom.enum.add',
[
'fields' => [
'fieldId' => 6008093,
'value' => 'High',
'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();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'forum.message.field.custom.enum.add',
{
fields: {
fieldId: 6008093,
value: 'High',
sort: 10,
xmlId: 'HIGH',
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'forum.message.field.custom.enum.add',
[
'fields' => [
'fieldId' => 6008093,
'value' => 'High',
'sort' => 10,
'xmlId' => 'HIGH',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "forum.message.field.custom.enum.add", b24.Params{
"fields": b24.Params{
"fieldId": 6008093,
"value": "High",
"sort": 10,
"xmlId": "HIGH",
},
})
if err != nil {
return fmt.Errorf("forum.message.field.custom.enum.add: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
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("parse response: %w", err)
}
fmt.Println(item.ID, item.Value, item.XMLID)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 4077,
"fieldId": 6008093,
"value": "High",
"isDefault": false,
"sort": 10,
"xmlId": "HIGH"
}
},
"time": {
"start": 1792670734,
"finish": 1792670734.756363,
"duration": 0.7563629150390625,
"processing": 0,
"date_start": "2026-10-22T15:05:34+02:00",
"date_finish": "2026-10-22T15:05:34+02:00",
"operating_reset_at": 1792671300,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
result.item |
Created list value. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
List value identifier |
|
fieldId |
Identifier of the custom field the value belongs to |
|
value |
Value text |
|
isDefault |
|
|
sort |
Sort order |
|
xmlId |
External code of the value |
Error Handling
HTTP status: 400, 404, 500
{
"error": {
"code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION",
"message": "Field \"999999999\" was not found."
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Field Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Add |
|
|
Required field |
Add |
Field Not Found Error
Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION
HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Field |
Forum messages have no custom field with this |
Internal Error
HTTP status: 500
{
"error": "INTERNAL_SERVER_ERROR",
"error_description": "Internal server error"
}
|
Reason |
How to Fix |
|
The field already has a value with this |
Pass a unique |
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 |
Continue Learning
- Update Custom Field List Value forum.message.field.custom.enum.update
- Get Custom Field List Value forum.message.field.custom.enum.get
- Get Custom Field List Values forum.message.field.custom.enum.list
- Delete Custom Field List Value forum.message.field.custom.enum.delete
- Add Forum Message Custom Field forum.message.field.custom.add
- Get List of Forum Message Custom Fields forum.message.field.custom.list
- Forum Message Custom Fields: Overview of Methods