Изменить сделку crm.deal.update

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: crm

Кто может выполнять метод: любой пользователь с правом «изменения» сделок

DEPRECATED

Развитие метода остановлено. Используйте crm.item.update.

Метод crm.deal.update обновляет существующую сделку.

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

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

Название
тип

Описание

id*
integer

Идентификатор сделки.

Идентификатор можно получить с помощью методов crm.deal.list или crm.deal.add

fields
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

где:

  • field_n — название поля
  • value_n — новое значение поля

Список доступных полей описан ниже.

Некорректное поле в fields будет проигнорировано.

В fields нужно передавать только те поля, которые требуется изменить

params
object

Набор дополнительных параметров (подробное описание)

Параметр fields

Название
тип

Описание

TITLE
string

Название сделки

TYPE_ID
crm_status

Строковый идентификатор типа сделки.

Список доступных типов сделки можно узнать с помощью метода crm.status.list, применив фильтр { ENTITY_ID: 'DEAL_TYPE' }

STAGE_ID
crm_status

Стадия сделки.

Список доступных стадий можно узнать с помощью метода crm.status.list, применив фильтр:

  • { ENTITY_ID: "DEAL_STAGE" } — если сделка находится в общей воронке (направлении)
  • { ENTITY_ID: "DEAL_STAGE_{categoryId}" } — если сделка находится не в общей воронке, где categoryId — это идентификатор воронки и равен CATEGORY_ID сделки.

Если необходимо сменить воронку сделки, используйте метод crm.item.update, entityTypeId сделки — 2

IS_RECURRING
char

Является ли сделка шаблоном регулярной сделки. Возможные значения:

  • Y — да
  • N — нет

IS_RETURN_CUSTOMER
char

Является ли сделка повторной. Возможные значения:

  • Y — да
  • N — нет

IS_REPEATED_APPROACH
char

Является ли сделка повторным обращением. Возможные значения:

  • Y — да
  • N — нет

PROBABILITY
integer

Вероятность, %

CURRENCY_ID
crm_currency

Валюта.

Список доступных валют можно узнать с помощью метода crm.currency.list

OPPORTUNITY
double

Сумма

IS_MANUAL_OPPORTUNITY
char

Включен ли режим ручного подсчета суммы. Возможные значения:

  • Y — да
  • N — нет

TAX_VALUE
double

Сумма налога

COMPANY_ID
crm_company

Идентификатор компании, привязанной к сделке.

Список компаний можно узнать с помощью метода crm.item.list, передав entityTypeId = 4

CONTACT_ID
crm_contact

Контакт. Устаревшее

CONTACT_IDS
crm_contact[]

Список привязанных к сделке контактов. Поле изменяется полностью.

Чтобы изменить отдельные связанные контакты, используйте методы crm.deal.contact.items.*.

BEGINDATE
date

Дата начала

CLOSEDATE
date

Дата завершения

OPENED
char

Доступна ли сделка для всех. Возможные значения:

  • Y — да
  • N — нет

CLOSED
char

Является ли сделка закрытой. Возможные значения:

  • Y — да
  • N — нет

COMMENTS
string

Комментарий. Поддерживает bb-коды

ASSIGNED_BY_ID
user

Ответственный

SOURCE_ID
crm_status

Строковый идентификатор типа источника.

Список доступных источников можно узнать с помощью метода crm.status.list, применив фильтр { ENTITY_ID: "SOURCE" }

SOURCE_DESCRIPTION
string

Дополнительно об источнике

ADDITIONAL_INFO
string

Дополнительная информация

LOCATION_ID
location

Местоположение клиента. Служебное поле

ORIGINATOR_ID
string

Идентификатор источника данных.

Используется только для привязки к внешнему источнику

ORIGIN_ID
string

Идентификатор элемента в источнике данных.

Используется только для привязки к внешнему источнику

UTM_SOURCE
string

Рекламная система (Google-Adwords и другие)

UTM_MEDIUM
string

Тип трафика. Возможные значения:

  • CPC — объявления
  • CPM — баннеры

UTM_CAMPAIGN
string

Обозначение рекламной кампании

UTM_CONTENT
string

Содержание кампании. Например, для контекстных объявлений

UTM_TERM
string

Условие поиска кампании. Например, ключевые слова контекстной рекламы

UF_CRM_...

Пользовательские поля. Например, UF_CRM_25534736.

В зависимости от настроек портала у сделок может быть набор пользовательских полей определенных типов.

Значения множественных полей передаются в виде массива.

Для изменения файловых полей рекомендуется использовать метод crm.item.update.

Добавить пользовательское поле в сделку можно с помощью метода crm.deal.userfield.add

PARENT_ID_...
crm_entity

Поля связей.

Если на портале есть смарт-процессы, связанные со сделками, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и сделкой. Само поле хранит идентификатор элемента такого смарт-процесса.

Например, поле PARENT_ID_153 — связь со смарт-процессом entityTypeId=153, хранит идентификатор элемента этого смарт-процесса, связанного с текущей сделкой

Параметр params

Название
тип

Описание

REGISTER_SONET_EVENT
boolean

Зарегистрировать ли событие изменения сделки в живой ленте. Возможные значения:

  • Y — да
  • N — нет

REGISTER_HISTORY_EVENT
boolean

Создать ли запись в истории. Возможные значения:

  • Y — да
  • N — нет

Связанные методы и темы

Изменить настройку шаблона регулярной сделки crm.deal.recurring.update

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":123,"FIELDS":{"TITLE":"Новое название сделки!","TYPE_ID":"GOODS","STAGE_ID":"WON","IS_RECCURING":"Y","IS_RETURN_CUSTOMER":"Y","OPPORTUNITY":9999.99,"IS_MANUAL_OPPORTUNITY":"Y","ASSIGNED_BY_ID":1,"UF_CRM_1725365197310":"Строка","PARENT_ID_1032":1},"PARAMS":{"REGISTER_SONET_EVENT":"N","REGISTER_HISTORY_EVENT":"N"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":123,"FIELDS":{"TITLE":"Новое название сделки!","TYPE_ID":"GOODS","STAGE_ID":"WON","IS_RECCURING":"Y","IS_RETURN_CUSTOMER":"Y","OPPORTUNITY":9999.99,"IS_MANUAL_OPPORTUNITY":"Y","ASSIGNED_BY_ID":1,"UF_CRM_1725365197310":"Строка","PARENT_ID_1032":1},"PARAMS":{"REGISTER_SONET_EVENT":"N","REGISTER_HISTORY_EVENT":"N"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.update
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.update',
        		{
        			id: 123,
        			fields: {
        				TITLE: "Новое название сделки!",
        				TYPE_ID: "GOODS",
        				STAGE_ID: "WON",
        				IS_RECCURING: "Y",
        				IS_RETURN_CUSTOMER: "Y",
        				OPPORTUNITY: 9999.99,
        				IS_MANUAL_OPPORTUNITY: "Y",
        				ASSIGNED_BY_ID: 1,
        				UF_CRM_1725365197310: "Строка",
        				PARENT_ID_1032: 1,
        			},
        			params: {
        				REGISTER_SONET_EVENT: "N",
        				REGISTER_HISTORY_EVENT: "N",
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error() ? console.error(result.error()) : console.info(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.update',
                    [
                        'id' => 123,
                        'fields' => [
                            'TITLE'              => "Новое название сделки!",
                            'TYPE_ID'            => "GOODS",
                            'STAGE_ID'           => "WON",
                            'IS_RECCURING'       => "Y",
                            'IS_RETURN_CUSTOMER' => "Y",
                            'OPPORTUNITY'        => 9999.99,
                            'IS_MANUAL_OPPORTUNITY' => "Y",
                            'ASSIGNED_BY_ID'     => 1,
                            'UF_CRM_1725365197310' => "Строка",
                            'PARENT_ID_1032'     => 1,
                        ],
                        'params' => [
                            'REGISTER_SONET_EVENT'   => "N",
                            'REGISTER_HISTORY_EVENT' => "N",
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($response->getError()) {
                echo 'Error: ' . $response->getError();
            } else {
                echo 'Success: ' . print_r($result, true);
                // Нужная вам логика обработки данных
                processData($result);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating deal: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.deal.update',
            {
                id: 123,
                fields: {
                    TITLE: "Новое название сделки!",
                    TYPE_ID: "GOODS",
                    STAGE_ID: "WON",
                    IS_RECCURING: "Y",
                    IS_RETURN_CUSTOMER: "Y",
                    OPPORTUNITY: 9999.99,
                    IS_MANUAL_OPPORTUNITY: "Y",
                    ASSIGNED_BY_ID: 1,
                    UF_CRM_1725365197310: "Строка",
                    PARENT_ID_1032: 1,
                },
                params: {
                    REGISTER_SONET_EVENT: "N",
                    REGISTER_HISTORY_EVENT: "N",
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.update',
            [
                'ID' => 123,
                'FIELDS' => [
                    'TITLE' => 'Новое название сделки!',
                    'TYPE_ID' => 'GOODS',
                    'STAGE_ID' => 'WON',
                    'IS_RECCURING' => 'Y',
                    'IS_RETURN_CUSTOMER' => 'Y',
                    'OPPORTUNITY' => 9999.99,
                    'IS_MANUAL_OPPORTUNITY' => 'Y',
                    'ASSIGNED_BY_ID' => 1,
                    'UF_CRM_1725365197310' => 'Строка',
                    'PARENT_ID_1032' => 1,
                ],
                'PARAMS' => [
                    'REGISTER_SONET_EVENT' => 'N',
                    'REGISTER_HISTORY_EVENT' => 'N',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Пояснения к методу

Для управления контактами сделки не рекомендуется использовать поля CONTACT_IDS и CONTACT_ID.

Используйте методы crm.deal.contact.* для работы с одним контактом, методы crm.deal.contact.items.* для работы с группой контактов сделки.

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1725365418.056843,
                "finish": 1725365419.671506,
                "duration": 1.6146628856658936,
                "processing": 1.3475170135498047,
                "date_start": "2024-09-03T14:10:18+02:00",
                "date_finish": "2024-09-03T14:10:19+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

Корневой элемент ответа, содержит true в случае успеха

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Parameter 'fields' must be array."
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

-

ID is not defined or invalid

В параметр id передано не целое число больше нуля

-

Not found

Сделка с переданным id не существует

-

Parameter 'fields' must be array

В параметр fields передан не объект

-

Parameter 'params' must be array

В параметр params передан не объект

-

Access denied

У пользователя нет прав на «изменение» сделок

-

Исчерпан выделенный дисковый ресурс

-

Неверное значение поля «Валюта»

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Создать новую сделку
Следующая
Получить сделку по Id