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

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

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

Примеры кода

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

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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'crm.deal.update',
    params: {
      id: 123,
      fields: {
        TITLE: 'New deal 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: 'String',
        PARENT_ID_1032: 1,
      },
      params: {
        REGISTER_SONET_EVENT: 'N',
        REGISTER_HISTORY_EVENT: 'N',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Deal updated:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateDeal() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.deal.update',
        params: {
          id: 123,
          fields: {
            TITLE: 'New deal 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: 'String',
            PARENT_ID_1032: 1,
          },
          params: {
            REGISTER_SONET_EVENT: 'N',
            REGISTER_HISTORY_EVENT: 'N',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Deal updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateDeal)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.deal.update(
        bitrix_id=123,
        fields={
            "TITLE": "Enterprise License Renewal - Negotiation",
            "STAGE_ID": "PREPARATION",
            "OPPORTUNITY": 28000,
            "COMMENTS": "Updated after discovery call",
            "ASSIGNED_BY_ID": 1,
        },
        params={"REGISTER_SONET_EVENT": "Y", "REGISTER_HISTORY_EVENT": "Y"},
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.deal.update", b24.Params{
	"id": 123,
	"fields": b24.Params{
		"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": b24.Params{
		"REGISTER_SONET_EVENT":   "N",
		"REGISTER_HISTORY_EVENT": "N",
	},
})
if err != nil {
	return fmt.Errorf("crm.deal.update: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

Для управления контактами сделки не рекомендуется использовать поля 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
string

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

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

Код

Описание

Значение

Пустое значение

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

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

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