Add an Option to a List Field v 3.0 crm.[type].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: crm

Who can execute the method: a user with the "Edit CRM preferences" permission in CRM

This 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 crm.<type>.field.custom.enum.add method adds an option to a custom list field and returns the option description. The object type is set by the <type> segment of the method name.

A list field stores a set of options from which the user selects a value, for example, the priorities "High", "Medium", and "Low". Such a field cannot be created with the crm.<type>.field.custom.add method: it does not accept the enumeration type. The field can be created in the Bitrix24 interface or in another way, and its options can be handled with the crm.<type>.field.custom.enum.* methods. List fields are present in the response of the crm.<type>.field.custom.list method: their userTypeId is enumeration.

Method Name for the Object Type

Object type

Method

Fields

Deal

crm.deal.field.custom.enum.add

Deal fields

Lead

crm.lead.field.custom.enum.add

Lead fields

Contact

crm.contact.field.custom.enum.add

Contact fields

Company

crm.company.field.custom.enum.add

Company fields

Estimate

crm.quote.field.custom.enum.add

Estimate fields

Invoice

crm.smartinvoice.field.custom.enum.add

Invoice fields

SPA

crm.smartprocess<entityTypeId>.field.custom.enum.add, for example, crm.smartprocess1038.field.custom.enum.add

SPA fields

For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field. SPAs have list field option methods regardless of the type settings. My company does not have these methods: for crm.mycompany.field.custom.enum.add, Bitrix24 returns the "Method Not Found" error.

The method name is written in lowercase: crm.smartinvoice.field.custom.enum.add, not crm.smartInvoice.field.custom.enum.add. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the option data in the format {"parameter": "value"}. The required fields are fieldId and value. Parameter description

The fields Parameter

Required parameters are marked with *

Name
type

Description

fieldId*
integer | string

List field ID or name, for example, 6008205 or "UF_CRM_19_PRIORITY". The field ID and name are returned by the crm.<type>.field.custom.list method

value*
string

Option text that the user sees, for example, Urgent. The method does not accept an empty string

isDefault
boolean

Whether the option is selected by default for new items.

Possible values:

  • true — the option is selected by default
  • false — not selected

Default: false.

If the field already has a default option, the method does not clear its flag: both options are selected by default

sort
integer

Option position in the list.

Default: 500

xmlId
string

Option external code, unique within the field. If the code is not passed, Bitrix24 generates it, for example, crm_rest_enum_geu7u4uivzmoxv0ytjmransvcbi44rxq

The method does not accept the id field: Bitrix24 assigns the option ID itself.

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}/crm.smartprocess1038.field.custom.enum.add

The examples add the "Urgent" option to the "Priority" field of an SPA with the type ID 1038. For a different object type, replace the method name according to the table above.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"fieldId":6008205,"value":"Urgent","sort":5,"xmlId":"URGENT"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.custom.enum.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"fieldId":6008205,"value":"Urgent","sort":5,"xmlId":"URGENT"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.custom.enum.add
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type EnumAddResult = {
          item: {
            id: number
            fieldId: number
            value: string
            isDefault: boolean
            sort: number
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<EnumAddResult>(
            'crm.smartprocess1038.field.custom.enum.add',
            {
              fields: {
                fieldId: 6008205,
                value: 'Urgent',
                sort: 5,
                xmlId: 'URGENT',
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Value added:', result.item.id, result.item.value)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<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.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.field.custom.enum.add',
                {
                  fields: {
                    fieldId: 6008205,
                    value: 'Urgent',
                    sort: 5,
                    xmlId: 'URGENT',
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Value added:', result.item.id, result.item.value)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addEnumValue)
        </script>
        

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.smartprocess1038.field.custom.enum.add"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "fields": {
                        "fieldId": 6008205,
                        "value": "Urgent",
                        "sort": 5,
                        "xmlId": "URGENT",
                    },
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result["item"]["id"], result["item"]["value"])
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.smartprocess1038.field.custom.enum.add',
                    [
                        'fields' => [
                            'fieldId' => 6008205,
                            'value' => 'Urgent',
                            'sort' => 5,
                            'xmlId' => 'URGENT',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        

The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.

BX24.callMethod(
            'crm.smartprocess1038.field.custom.enum.add',
            {
                fields: {
                    fieldId: 6008205,
                    value: 'Urgent',
                    sort: 5,
                    xmlId: 'URGENT',
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

The SDK does not yet support calls to the /rest/api/ address. Use a direct HTTP request, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.smartprocess1038.field.custom.enum.add',
            [
                'fields' => [
                    'fieldId' => 6008205,
                    'value' => 'Urgent',
                    'sort' => 5,
                    'xmlId' => 'URGENT',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.smartprocess1038.field.custom.enum.add", b24.Params{
        	"fields": b24.Params{
        		"fieldId": 6008205,
        		"value":   "Urgent",
        		"sort":    5,
        		"xmlId":   "URGENT",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.field.custom.enum.add: %w", err)
        }
        
        var out struct {
        	Item struct {
        		ID    int    `json:"id"`
        		Value string `json:"value"`
        	} `json:"item"`
        }
        if err := json.Unmarshal(res.Result, &out); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(out.Item.ID, out.Item.Value)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 4135,
                    "fieldId": 6008205,
                    "value": "Urgent",
                    "isDefault": false,
                    "sort": 5,
                    "xmlId": "URGENT"
                }
            },
            "time": {
                "start": 1793714980,
                "finish": 1793714981.218989,
                "duration": 1.2189888954162598,
                "processing": 1,
                "date_start": "2026-11-03T17:09:40+03:00",
                "date_finish": "2026-11-03T17:09:41+03:00",
                "operating_reset_at": 1793715540,
                "operating": 0.5316870212554932
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.item
object

Option description. Option fields

time
time

Information about the request execution time

Option Fields

Name
type

Description

id
integer

Option ID

fieldId
integer

List field ID

value
string

Option text

isDefault
boolean

Whether the option is selected by default

sort
integer

Option position in the list

xmlId
string

Option external code

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "List element with XML_ID=URGENT already exists.",
                        "field": "fields.xmlId"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object

fields.value

This request requires data type non-empty string in field fields.value

Pass non-empty option text

fields.xmlId

List element with XML_ID=#XML_ID# already exists

Pass a different xmlId: the external code is unique within the field

isDefault

This request requires data type bool in field isDefault

Pass true or false

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

fieldId

Required field fieldId is empty

Pass fieldId in fields

value

Required field value is empty

Pass value in fields

id

Field id is read-only

Remove id from fields: Bitrix24 assigns the option ID itself

Field Not Found

Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Field #ID# was not found

Check the field ID with the crm.<type>.field.custom.list method. The same error occurs if the field belongs to a different object type or is not a list field

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity EnumDto

Check the parameter name against the fields parameter table

Access Denied

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP status: 403

Field

Error description

How to Fix

-

Access denied

Call the method on behalf of a user with the "Edit CRM preferences" permission in CRM

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.smartinvoice.field.custom.enum.add. For an SPA, check entityTypeId with the crm.type.list method. My company does not have these methods

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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