Update a List Field Option v 3.0 crm.[type].field.custom.enum.update
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:
crmWho 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.update method updates an option of a custom list field and returns the option description. The object type is set by the <type> segment of the method name.
Method Name for the Object Type
|
Object type |
Method |
Fields |
|
Deal |
|
|
|
Lead |
|
|
|
Contact |
|
|
|
Company |
|
|
|
Estimate |
|
|
|
Invoice |
|
|
|
SPA |
|
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.update, Bitrix24 returns the "Method Not Found" error.
The method name is written in lowercase: crm.smartinvoice.field.custom.enum.update, not crm.smartInvoice.field.custom.enum.update. 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 |
Description |
|
id* |
Option ID. Option IDs are returned by the crm.<type>.field.custom.enum.list method |
|
fields* |
Object with the new option data in the format |
The fields Parameter
Pass only the parameters you want to change.
|
Name |
Description |
|
value |
Option text that the user sees, for example, |
|
isDefault |
Whether the option is selected by default for new items. Possible values:
|
|
sort |
Option position in the list |
|
xmlId |
Option external code, unique within the field |
An option cannot be moved to another field: the method skips fieldId without an error. The method also accepts an empty fields object and returns the option unchanged.
The method does not clear the isDefault flag on other options. If the field already has a default option and you pass "isDefault": true for another one, both options are marked as default. To keep only one, pass "isDefault": false for the previous option.
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.update
The examples change the text and position of an option in 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 '{"id":4135,"fields":{"value":"Very urgent","sort":1}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.custom.enum.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":4135,"fields":{"value":"Very urgent","sort":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.custom.enum.update
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 EnumUpdateResult = {
item: {
id: number
fieldId: number
value: string
isDefault: boolean
sort: number
xmlId: string
}
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<EnumUpdateResult>(
'crm.smartprocess1038.field.custom.enum.update',
{
id: 4135,
fields: {
value: 'Very urgent',
sort: 1,
},
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Value updated:', 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 updateEnumValue() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.smartprocess1038.field.custom.enum.update',
{
id: 4135,
fields: {
value: 'Very urgent',
sort: 1,
},
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Value updated:', result.item.id, result.item.value)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateEnumValue)
</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.update"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"id": 4135,
"fields": {
"value": "Very urgent",
"sort": 1,
},
},
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.update',
[
'id' => 4135,
'fields' => [
'value' => 'Very urgent',
'sort' => 1,
],
]
);
$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.update',
{
id: 4135,
fields: {
value: 'Very urgent',
sort: 1,
},
},
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.update',
[
'id' => 4135,
'fields' => [
'value' => 'Very urgent',
'sort' => 1,
],
]
);
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.update", b24.Params{
"id": 4135,
"fields": b24.Params{
"value": "Very urgent",
"sort": 1,
},
})
if err != nil {
return fmt.Errorf("crm.smartprocess1038.field.custom.enum.update: %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": "Very urgent",
"isDefault": false,
"sort": 1,
"xmlId": "URGENT"
}
},
"time": {
"start": 1793714989,
"finish": 1793714989.621933,
"duration": 0.6219329833984375,
"processing": 0,
"date_start": "2026-11-03T17:09:49+03:00",
"date_finish": "2026-11-03T17:09:49+03:00",
"operating_reset_at": 1793715540,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
result.item |
Option description. Option fields |
|
time |
Information about the request execution time |
Option Fields
|
Name |
Description |
|
id |
Option ID |
|
fieldId |
List field ID |
|
value |
Option text |
|
isDefault |
Whether the option is selected by default |
|
sort |
Option position in the list |
|
xmlId |
Option external code |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Entity with ID 99999999 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
Option Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
Check the option ID with the crm.<type>.field.custom.enum.list method. If |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
At least one of the required fields must be not empty: id, filter |
Pass the option |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass non-empty option text |
|
|
List element with XML_ID= |
Pass a different |
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Field |
Remove |
Field Not Found
Error Code: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Field |
The option belongs to a field of a different object type. Make sure the object type in the method name matches the field type |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
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 |
Check the method name: it is written in lowercase, for example, |
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
- CRM Fields in REST 3.0: Overview of Methods
- Add an Option to a List Field v 3.0 crm.[type].field.custom.enum.add
- Get a List Field Option v 3.0 crm.[type].field.custom.enum.get
- Get List Field Options v 3.0 crm.[type].field.custom.enum.list
- Delete a List Field Option v 3.0 crm.[type].field.custom.enum.delete