Изменить элемент CRM v 3.0 crm.<тип>.update

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом на изменение элементов этого типа объекта CRM. Для моей компании — администратор CRM

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.<тип>.update изменяет поля существующего элемента CRM. Тип объекта задает сегмент <тип> в имени метода.

Имя метода для типа объекта

Тип объекта	Метод	Поля
Сделка	`crm.deal.update`	Поля сделки
Лид	`crm.lead.update`	Поля лида
Контакт	`crm.contact.update`	Поля контакта
Компания	`crm.company.update`	Поля компании
Предложение	`crm.quote.update`	Поля предложения
Счет	`crm.smartinvoice.update`	Поля счета
Моя компания	`crm.mycompany.update`	Поля моей компании
Смарт-процесс	`crm.smartprocess<entityTypeId>.update`, например `crm.smartprocess1038.update`	Поля смарт-процесса

Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId.

Имя метода пишется в нижнем регистре: crm.smartinvoice.update, а не crm.smartInvoice.update. На имя в другом регистре метод отвечает ошибкой «Метод не найден».

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор элемента, который нужно изменить.

Идентификатор возвращает метод crm.<тип>.add при создании элемента. Идентификаторы существующих элементов можно получить методом crm.<тип>.list

fields*
object

Объект с новыми значениями полей в формате {"поле": "значение"}. Описание параметра

Параметр fields

Передавайте только поля, которые нужно изменить. Поля, которых нет в fields, сохраняют текущие значения.

Имена полей пишутся в camelCase: title, assignedById, stageId. Состав полей у каждого типа объекта свой, описания полей — на страницах:

Изменять можно не все поля. Список полей с признаком, можно ли поле изменять, возвращает метод crm.<тип>.field.list.

Пользовательские поля передаются по имени, например UF_CRM_1687529546. Их список возвращает метод crm.<тип>.field.custom.list.

Значение stageId должно быть стадией из воронки элемента, а categoryId — существующей воронкой этого типа объекта. Стадии и воронки можно получить методами crm.<тип>.category.stage.list и crm.<тип>.category.list.

Если fields — пустой объект или все значения в нем совпадают с текущими, метод отвечает true и не записывает элемент: время изменения updatedTime остается прежним.

Значение null для строкового поля метод не принимает и возвращает ошибку типа данных. Пустая строка обрабатывается по-разному в зависимости от типа объекта — смотрите отличия типов объектов.

Отличия типов объектов

Тип объекта	Пустое значение в fields
Лид, компания	Пустой `title` не записывается: метод отвечает `true`, название элемента не меняется
Контакт	Метод не принимает пустые `name` и `lastName` одновременно и возвращает ошибку. Одно из двух полей должно остаться заполненным
Смарт-процесс	Пустой `title` заменяется названием по умолчанию: название типа смарт-процесса и номер элемента, например `Без полей #25`

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.update

Примеры меняют название и сумму элемента смарт-процесса с идентификатором типа 1038. Для другого типа объекта замените имя метода по таблице выше.

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":"Заявка на закупку оборудования","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":"Заявка на закупку оборудования","opportunity":180000},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.update

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $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: 'Заявка на закупку оборудования',
        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 пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $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: 'Заявка на закупку оборудования',
            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>

У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с 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": "Заявка на закупку оборудования",
                "opportunity": 180000,
            },
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.smartprocess1038.update',
            [
                'id' => 15,
                'fields' => [
                    'title' => 'Заявка на закупку оборудования',
                    'opportunity' => 180000,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.smartprocess1038.update',
    {
        id: 15,
        fields: {
            title: 'Заявка на закупку оборудования',
            opportunity: 180000,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.smartprocess1038.update',
    [
        'id' => 15,
        'fields' => [
            'title' => 'Заявка на закупку оборудования',
            'opportunity' => 180000,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.update", b24.Params{
	"id": 15,
	"fields": b24.Params{
		"title":       "Заявка на закупку оборудования",
		"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("разбор ответа: %w", err)
}
fmt.Println(updated.Result)

Обработка ответа

HTTP-статус: 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
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Объект с данными ответа
result.result `boolean`	`true`, если запрос выполнен. Метод отвечает `true` и тогда, когда записывать нечего — смотрите описание параметра fields. Новые значения полей можно получить методом crm.<тип>.get
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле `fields` не указано",
                "field": "fields"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Элемент не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Запись с ID = `#ID#` не найдена	Проверьте идентификатор элемента. Элемента с таким `id` нет у этого типа объекта или он удален

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Обязательное поле `id` не указано	Передайте `id` элемента
`id`	Значение поля должно быть не меньше, чем 1	Передайте положительный идентификатор
`fields`	Обязательное поле `fields` не указано	Передайте объект `fields`
`assignedById`	В поле `assignedById` требуется тип данных `int` для такого запроса	Передайте значение того типа, который указан в описании поля. Ошибку вызывает и `null` в строковом поле
`CRM_FIELD_ERROR_REQUIRED`	Поля "Имя" и "Фамилия" не могут быть пустыми одновременно. Пожалуйста, заполните как минимум одно из них	Оставьте заполненным `name` или `lastName`. Правило действует для контакта

В этот же код метод оборачивает ошибки, которые Битрикс24 вернул при записи элемента. Тогда в field приходит имя поля или код ошибки записи, как в примере с контактом.

Ошибки валидации объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Поле "id" не доступно к заполнению	Передайте идентификатор параметром `id`, а не в `fields`
`createdTime`	Поле "createdTime" не доступно к заполнению	Уберите из `fields` поля, которые нельзя изменять. Признак изменяемости возвращает crm.<тип>.field.list
`stageId`	Значение поля не содержится в списке допустимых значений: `#STAGES#`	Передайте стадию из воронки элемента. В тексте ошибки перечислены допустимые стадии
`categoryId`	Значение поля не содержится в списке допустимых значений	Передайте идентификатор существующей воронки этого типа объекта
`assignedById`	Значение поля не содержится в списке допустимых значений	Передайте идентификатор существующего пользователя

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Неизвестное поле `#FIELD#` для сущности `#DTO#`	Проверьте имя поля по странице полей типа объекта. Ошибку с именем поля `0` вызывает `fields`, переданный строкой или массивом вместо объекта

Метод не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Метод `#METHOD#` не найден	Проверьте имя метода: оно пишется в нижнем регистре, например `crm.deal.update`. Для смарт-процесса проверьте `entityTypeId` методом crm.type.list

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Создать элемент

Получить элемент по идентификатору

Изменить элемент CRM v 3.0 crm.<тип>.update

Имя метода для типа объектаИмя метода для типа объекта

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Отличия типов объектовОтличия типов объектов

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Элемент не найденЭлемент не найден

Ошибки валидации запросаОшибки валидации запроса

Ошибки валидации объектаОшибки валидации объекта

Ошибка неизвестного поляОшибка неизвестного поля

Метод не найденМетод не найден

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Имя метода для типа объекта

Параметры метода

Параметр fields

Отличия типов объектов

Примеры кода

Обработка ответа

Возвращаемые данные

Обработка ошибок

Возможные коды ошибок

Элемент не найден

Ошибки валидации запроса

Ошибки валидации объекта

Ошибка неизвестного поля

Метод не найден

Статусы и коды системных ошибок

Продолжите изучение