crm.deal.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)
Ответ
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."
}
| Код | Описание | Значение |
|---|---|---|
| — | ID is not defined or invalid |
В параметр id передано не целое число больше нуля |
| — | Not found |
Сделка с переданным id не существует |
| — | Parameter 'fields' must be array |
В параметр fields передан не объект |
| — | Parameter 'params' must be array |
В параметр params передан не объект |
| — | Access denied |
У пользователя нет прав на «изменение» сделок |
| — | Исчерпан выделенный дисковый ресурс | |
| — | Неверное значение поля «Валюта» |

