Add a CRM Directory Value v 3.0 crm.dictionary.[directory].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 CRM administrator

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.dictionary.<directory>.add method adds a value to a CRM directory and returns the whole value. The directory is set by the <directory> segment of the method name.

Method Name for the Directory

The method is available only for CRM value directories.

Directory

Method

Deal types

crm.dictionary.dealtype.add

Contact types

crm.dictionary.contacttype.add

Company types

crm.dictionary.companytype.add

Salutations

crm.dictionary.honorific.add

Number of employees

crm.dictionary.employees.add

Industries

crm.dictionary.industry.add

Sources

crm.dictionary.source.add

The method name is written in lowercase: crm.dictionary.dealtype.add, not crm.dictionary.dealType.add. If the name is written in a different case or contains a directory whose values cannot be changed, for example, crm.dictionary.entitytype.add, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the fields of the new value in the format {"field": "value"}. Parameter description

Required field — name

The fields Parameter

Required parameters are marked with *

Name
type

Description

id
string

Value ID, for example, SUBSCRIPTION. It cannot be changed after the value is created.

Up to 50 characters, without a colon, not 0, and not whitespace only. If the field is not passed or an empty string is passed, Bitrix24 generates an ID such as UC_1Z8DXI

name*
string

Value name, up to 100 characters. Bitrix24 removes leading and trailing spaces

sort
integer

Sort order. Bitrix24 replaces zero and negative values with 10.

Default: 10

The isSystem field is read-only: the method does not accept it in fields.

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.dictionary.dealtype.add

The examples add the "Subscription" deal type with the ID SUBSCRIPTION. For a different directory, replace the method name according to the table above.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"id":"SUBSCRIPTION","name":"Subscription","sort":60}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.dictionary.dealtype.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"id":"SUBSCRIPTION","name":"Subscription","sort":60},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.dictionary.dealtype.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 DictionaryAddResult = {
          item: {
            id: string
            name: string
            sort: number
            isSystem: boolean
          }
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<DictionaryAddResult>(
            'crm.dictionary.dealtype.add',
            {
              fields: {
                id: 'SUBSCRIPTION',
                name: 'Subscription',
                sort: 60,
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Deal type created:', result.item.id)
          }
        } 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 addDealType() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.dictionary.dealtype.add',
                {
                  fields: {
                    id: 'SUBSCRIPTION',
                    name: 'Subscription',
                    sort: 60,
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Deal type created:', result.item.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addDealType)
        </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.dictionary.dealtype.add"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "fields": {
                        "id": "SUBSCRIPTION",
                        "name": "Subscription",
                        "sort": 60,
                    },
                },
                prefer_version=3,
            )
            item = response["result"]["item"]
            print(item["id"], item["name"])
        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}")
        

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(
                    'crm.dictionary.dealtype.add',
                    [
                        'fields' => [
                            'id' => 'SUBSCRIPTION',
                            'name' => 'Subscription',
                            'sort' => 60,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $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(
            'crm.dictionary.dealtype.add',
            {
                fields: {
                    id: 'SUBSCRIPTION',
                    name: 'Subscription',
                    sort: 60,
                },
            },
            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(
            'crm.dictionary.dealtype.add',
            [
                'fields' => [
                    'id' => 'SUBSCRIPTION',
                    'name' => 'Subscription',
                    'sort' => 60,
                ],
            ]
        );
        
        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.dictionary.dealtype.add", b24.Params{
        	"fields": b24.Params{
        		"id":   "SUBSCRIPTION",
        		"name": "Subscription",
        		"sort": 60,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.dictionary.dealtype.add: %w", err)
        }
        
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("response has no item key")
        }
        
        var item struct {
        	ID   string `json:"id"`
        	Name string `json:"name"`
        	Sort int    `json:"sort"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": "SUBSCRIPTION",
                    "name": "Subscription",
                    "sort": 60,
                    "isSystem": false
                }
            },
            "time": {
                "start": 1793715698,
                "finish": 1793715698.298801,
                "duration": 0.2988009452819824,
                "processing": 0,
                "date_start": "2026-11-03T17:21:38+03:00",
                "date_finish": "2026-11-03T17:21:38+03:00",
                "operating_reset_at": 1793716260,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.item
object

The created value with all fields: id, name, sort, isSystem. If id or sort was not passed, the response contains the values assigned by Bitrix24. Pass the id in a CRM item field, for example, in the typeId field of a deal. Field descriptions

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "This ID is already in use. Try a different one.",
                        "field": "id"
                    }
                ]
            }
        }
        

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

id

This ID is already in use. Try a different one

Pass a different id, or do not pass it so that Bitrix24 generates an ID

id

The ID must not exceed 50 characters. Colon characters are not allowed. It must not resolve to 0

Pass an ID of up to 50 characters without a colon and other than 0

name

Invalid field value. Check the value type and length

Pass a non-empty name of up to 100 characters

sort

This request requires data type int in field sort

Pass a value of the type specified in the field description

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

name

Required field name is empty

Pass name in fields

isSystem

Field isSystem is read-only

Remove isSystem from fields

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity DictionaryValueDto

Pass only id, name, and sort in fields. An error with the field 0 means that fields was passed as a string rather than an object

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 CRM administrator

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.dictionary.dealtype.add. You can add values only to the directories from the table at the beginning of the page

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