Update a CRM Item v 3.0 crm.[type].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: 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>.update method updates the fields of an existing CRM item. The object type is set by the <type> segment of the method name.

Method Name for the Object Type

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

Description

id*
integer

ID of the item to update.

The ID is returned by the crm.<type>.add method when an item is created. IDs of existing items can be retrieved with the crm.<type>.list method

fields*
object

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

The fields Parameter

Pass only the fields you need to change. Fields that are not in fields retain their current values.

Field names are written in camelCase: title, assignedById, stageId. Each object type has its own set of fields, which are described on these pages:

Not all fields can be edited. The list of fields, with an indication of whether each field can be edited, is returned by the crm.<type>.field.list method.

Custom fields are passed by name, for example, UF_CRM_1687529546. Their list is returned by the crm.<type>.field.custom.list method.

The stageId value must be a stage of the item's pipeline, and categoryId must be an existing pipeline of this object type. Retrieve stages and pipelines with the crm.<type>.category.stage.list and crm.<type>.category.list methods.

If fields is an empty object or all its values match the current ones, the method returns true and does not write the item: the modification time updatedTime stays the same.

The method does not accept null for a string field and returns a data type error. An empty string is handled differently depending on the object type — see differences between object types.

Differences Between Object Types

Object type	Empty value in fields
Lead, company	An empty `title` is not written: the method returns `true`, and the item name does not change
Contact	The method does not accept empty `name` and `lastName` at the same time and returns an error. One of the two fields must remain filled in
SPA	An empty `title` is replaced with the default name: the SPA type name and the item number, for example, `No fields #25`

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

The examples change the name and amount of 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":15,"fields":{"title":"Equipment purchase request","opportunity":180000}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15,"fields":{"title":"Equipment purchase request","opportunity":180000},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.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 ItemUpdateResult = {
          result: boolean
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<ItemUpdateResult>(
            'crm.smartprocess1038.update',
            {
              id: 15,
              fields: {
                title: 'Equipment purchase request',
                opportunity: 180000,
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Item updated:', 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 updateItem() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.update',
                {
                  id: 15,
                  fields: {
                    title: 'Equipment purchase request',
                    opportunity: 180000,
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Item updated:', result.result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateItem)
        </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.update"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "id": 15,
                    "fields": {
                        "title": "Equipment purchase request",
                        "opportunity": 180000,
                    },
                },
                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.update',
                    [
                        'id' => 15,
                        'fields' => [
                            'title' => 'Equipment purchase request',
                            'opportunity' => 180000,
                        ],
                    ]
                );
        
            $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.update',
            {
                id: 15,
                fields: {
                    title: 'Equipment purchase request',
                    opportunity: 180000,
                },
            },
            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.update',
            [
                'id' => 15,
                'fields' => [
                    'title' => 'Equipment purchase request',
                    'opportunity' => 180000,
                ],
            ]
        );
        
        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.update", b24.Params{
        	"id": 15,
        	"fields": b24.Params{
        		"title":       "Equipment purchase request",
        		"opportunity": 180000,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.update: %w", err)
        }
        
        var updated struct {
        	Result bool `json:"result"`
        }
        if err := json.Unmarshal(res.Result, &updated); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(updated.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "result": true
            },
            "time": {
                "start": 1793706173,
                "finish": 1793706173.219349,
                "duration": 0.21934890747070312,
                "processing": 0,
                "date_start": "2026-11-03T14:42:53+03:00",
                "date_finish": "2026-11-03T14:42:53+03:00",
                "operating_reset_at": 1793706600,
                "operating": 0.33750319480895996
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
result.result `boolean`	`true` if the request was executed. The method also returns `true` when there is nothing to write — see the fields parameter description. The new field values 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": "Required field \"fields\" is missing.",
                        "field": "fields"
                    }
                ]
            }
        }

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. This object type has no item with this `id`, or the item has been deleted

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

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
`fields`	Required field `fields` is missing	Pass the `fields` object
`assignedById`	This request requires data type `int` in field `assignedById`	Pass a value of the type specified in the field description. `null` in a string field also causes this error
`CRM_FIELD_ERROR_REQUIRED`	Fields `#NAME#` and `#LAST_NAME#` cannot be both empty. Please complete at least one of them	Keep `name` or `lastName` filled in. The rule applies to contacts

The method also wraps errors that Bitrix24 returned while writing the item into this code. In this case, field contains the field name or the write error code, as in the contact example.

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field	Error description	How to Fix
`id`	Field `id` is read-only	Pass the ID in the `id` parameter, not in `fields`
`createdTime`	Field `createdTime` is read-only	Remove fields that cannot be edited from `fields`. Whether a field can be edited is returned by crm.<type>.field.list
`stageId`	Field value is not one of the possible values: `#STAGES#`	Pass a stage from the item's pipeline. The error message lists the allowed stages
`categoryId`	Field value is not one of the possible values	Pass the ID of an existing pipeline of this object type
`assignedById`	Field value is not one of the possible values	Pass the ID of an existing user

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `#DTO#`	Check the field name on the fields page of the object type. An error with the field name `0` occurs when `fields` is passed as a string or an array instead of an object

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.update`. 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?

Create an Item

Get an Item by ID

Update a CRM Item v 3.0 crm.[type].update

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

The fields ParameterThe fields Parameter

Differences Between Object TypesDifferences Between Object Types

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

Object Validation ErrorsObject Validation Errors

Unknown Field ErrorUnknown Field Error

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

Method Parameters

The fields Parameter

Differences Between Object Types

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Item Not Found

Request Validation Errors

Object Validation Errors

Unknown Field Error

Method Not Found

Statuses and System Error Codes

Continue Learning