Add a Value to a Multiple Field of a CRM Item v 3.0 crm.[type].addfieldvalue

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 permission to edit items of this CRM object type. For my company, 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.<type>.addfieldvalue method adds a single value to a multiple field of a CRM item and keeps the values already in the field. The object type is set by the <type> segment of the method name.

The crm.<type>.update method writes a multiple field as a whole: to add a value, you need to pass the entire new list. The addfieldvalue method adds a single value, and you do not need to read the field first.

Method Name for the Object Type

Object type	Method	Fields
Deal	`crm.deal.addfieldvalue`	Deal fields
Lead	`crm.lead.addfieldvalue`	Lead fields
Contact	`crm.contact.addfieldvalue`	Contact fields
Company	`crm.company.addfieldvalue`	Company fields
Estimate	`crm.quote.addfieldvalue`	Estimate fields
Invoice	`crm.smartinvoice.addfieldvalue`	Invoice fields
My company	`crm.mycompany.addfieldvalue`	My company fields
SPA	`crm.smartprocess<entityTypeId>.addfieldvalue`, for example, `crm.smartprocess1038.addfieldvalue`	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.

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

Supported Fields

The method works only with the multiple fields from the table. Other fields, for example, title or companyId, cause the CRM_FIELD_NOT_SUPPORTED error.

Field	What it adds	Object types
`phone`, `email`, `web`, `im`	A phone number, email, website, or messenger	Lead, contact, company, my company
`contactsId`	A contact link	Deal, lead, company, estimate, invoice, my company, SPA
`companiesId`	A company link	Contact
`observersId`	An observer	Deal, lead, contact, company, invoice, my company, SPA
Multiple custom field `UF_CRM_…`	A custom field value	All types from the table above

An SPA has the contactsId field if client linking is enabled for the type, and observersId if observers are enabled. For details, see the SPA fields page.

A single-value custom field causes the CRM_FIELD_NOT_MULTIPLE error. The method does not support a custom field of the "Yes/No" type, even if it is multiple. The multiple attribute of a field is returned by the crm.<type>.field.list method.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Item ID. Item IDs can be retrieved with the crm.<type>.list method
fieldName* `string`	Name of the field to add the value to. Supported fields are listed in the Supported Fields section
value* `any`	Value to add. The format depends on the field. Parameter description

The value Parameter

Field	Value format
`phone`, `email`, `web`, `im`	Object `{"valueTypeId": "WORK", "value": "+49300000000"}`. `valueTypeId` is the value type, for example, `WORK` or `MOBILE`. The types are returned by the `crm.dictionary.phonetype.list`, `crm.dictionary.emailtype.list`, `crm.dictionary.webtype.list`, and `crm.dictionary.imtype.list` methods — description of the reference list methods
`contactsId`	ID of an existing contact, a number. The string `"3213"` causes an error
`companiesId`	ID of an existing company, a number
`observersId`	ID of an existing user, a number
Custom field	A single value in the format of the field type. String — a non-empty string, list — an option ID, employee link — a user ID, number — a number, date — `2026-11-03`, date with time — `2026-11-03T14:00:00+03:00`

The method does not add a value that is already in the field and returns the CRM_FIELD_VALUE_DUPLICATE error. For a phone number, email, website, and messenger, a match means the same pair of valueTypeId and value.

If the item had no linked contacts, the first added contact becomes the primary one: its ID is returned in the contactId field. The primary contact is changed by the crm.<type>.setprimarycontact method.

Limits:

values in a single phone, email, web, or im field — up to 50
values in all phone, email, web, and im fields of an item combined — up to 100
company links of a contact — up to 50

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.addfieldvalue

The examples add an observer to an SPA item with the type ID 1038. For a different object type, replace the method name according to the table above.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":27,"fieldName":"observersId","value":1}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.addfieldvalue

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":27,"fieldName":"observersId","value":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.addfieldvalue

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 AddFieldValueResult = {
          result: boolean
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<AddFieldValueResult>(
            'crm.smartprocess1038.addfieldvalue',
            {
              id: 27,
              fieldName: 'observersId',
              value: 1,
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Value added:', result.result)
          }
        } 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 addFieldValue() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.addfieldvalue',
                {
                  id: 27,
                  fieldName: 'observersId',
                  value: 1,
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Value added:', result.result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addFieldValue)
        </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.addfieldvalue"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "id": 27,
                    "fieldName": "observersId",
                    "value": 1,
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        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.smartprocess1038.addfieldvalue',
                    [
                        'id' => 27,
                        'fieldName' => 'observersId',
                        'value' => 1,
                    ]
                );
        
            $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.smartprocess1038.addfieldvalue',
            {
                id: 27,
                fieldName: 'observersId',
                value: 1,
            },
            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.smartprocess1038.addfieldvalue',
            [
                'id' => 27,
                'fieldName' => 'observersId',
                'value' => 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.addfieldvalue", b24.Params{
        	"id":        27,
        	"fieldName": "observersId",
        	"value":     1,
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.addfieldvalue: %w", err)
        }
        
        var added struct {
        	Result bool `json:"result"`
        }
        if err := json.Unmarshal(res.Result, &added); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(added.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "result": true
            },
            "time": {
                "start": 1793706539,
                "finish": 1793706539.293379,
                "duration": 0.2933790683746338,
                "processing": 0,
                "date_start": "2026-11-03T14:48:59+03:00",
                "date_finish": "2026-11-03T14:48:59+03:00",
                "operating_reset_at": 1793707080,
                "operating": 0.13451194763183594
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
result.result `boolean`	`true` if the value is added. The new field contents can be retrieved with the crm.<type>.get method
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": "The field value already exists.",
                        "field": "CRM_FIELD_VALUE_DUPLICATE"
                    }
                ]
            }
        }

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

Item Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`-`	Entity with ID #ID# was not found	Check the item ID. An item with this `id` does not exist for this object type or has been deleted

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Request parameter errors:

Field	Error description	How to Fix
`id`	Required field `id` is missing	Pass the item `id`
`id`	Field value must be 1 or greater	Pass a positive ID
`id`	This request requires data type `int` in field `id`	Pass the ID as a number
`fieldName`	Required field `fieldName` is missing	Pass the field name
`fieldName`	Field value must not be empty	Pass a non-empty field name
`value`	Required field `value` is missing	Pass the value. `null` also causes this error

Value errors. In these errors, the field field contains an error code instead of a field name:

Field	Error description	How to Fix
`CRM_FIELD_NOT_SUPPORTED`	The field is not supported	The method does not work with this field for this object type. Check the field against the Supported Fields section
`CRM_FIELD_NOT_MULTIPLE`	Only multiple fields are supported	The custom field is not multiple. Write its value with the crm.<type>.update method
`CRM_FIELD_VALUE_DUPLICATE`	The field value already exists	The value is already in the field, so there is no need to add it again
`CRM_FIELD_VALUE_INVALID`	The relation value does not exist	A contact, company, or user with this ID does not exist
`CRM_FIELD_VALUE_INVALID`	The custom field value is invalid	The value does not fit the custom field: wrong type or a nonexistent list option
`CRM_FIELD_VALUE_LIMIT_EXCEEDED`	Too many multifield values	The field already contains the maximum number of values
`CRM_FIELD_VALUE_LOCKED`	The field is being changed by another operation	Another request is changing this item field at the moment. Retry the call later
`-`	The field value is invalid	The value has the wrong format: a string instead of a number, a phone object without `valueTypeId`, an unknown value type, a string of spaces

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.deal.addfieldvalue`. For an SPA, check `entityTypeId` with the crm.type.list method

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

Was the article helpful?

Count Items

Remove a Value from a Multiple Field

Add a Value to a Multiple Field of a CRM Item v 3.0 crm.[type].addfieldvalue

Method Name for the Object TypeMethod Name for the Object Type

Supported FieldsSupported Fields

Method ParametersMethod Parameters

The value ParameterThe value Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Item Not FoundItem Not Found

Request Validation ErrorsRequest Validation Errors

Method Not FoundMethod Not Found

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Name for the Object Type

Supported Fields

Method Parameters

The value Parameter

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Item Not Found

Request Validation Errors

Method Not Found

Statuses and System Error Codes

Continue Learning