Изменить контакт crm.contact.update
Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.
Scope:
crmКто может выполнять метод: любой пользователь с правом «изменения» контактов
DEPRECATED
Развитие метода остановлено. Используйте crm.item.update.
Метод crm.contact.update обновляет существующий контакт.
Рекомендуем при обновлении адреса передавать полный набор полей адреса в метод обновления.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор контакта, который нужно изменить. Идентификатор можно получить методами |
|
fields* |
Объект формата:
где:
Список доступных полей описан ниже. Некорректное поле в В |
|
params |
Объект, содержащий набор дополнительных параметров. Структура и возможные значения описаны ниже |
Параметр fields
|
Название |
Описание |
|
HONORIFIC |
Обращение. Список доступных типов обращений можно узнать с помощью |
|
NAME |
Имя |
|
SECOND_NAME |
Отчество |
|
LAST_NAME |
Фамилия |
|
PHOTO |
Фотография |
|
BIRTHDATE |
Дата рождения |
|
TYPE_ID |
Тип контакта. |
|
SOURCE_ID |
Источник |
|
SOURCE_DESCRIPTION |
Дополнительно об источнике |
|
POST |
Должность |
|
COMMENTS |
Комментарий. Поддерживает bb-коды |
|
OPENED |
Доступен ли для всех. Возможные значения:
|
|
EXPORT |
Участвует ли контакт в экспорте. Возможные значения:
|
|
ASSIGNED_BY_ID |
Идентификатор пользователя, ответственного за элемент |
|
COMPANY_ID |
Идентификатор основной компании для контакта. Список компаний можно получить с помощью метода |
|
COMPANY_IDS |
Массив идентификаторов компаний, к которым привязан контакт. Список компаний можно получить с помощью метода |
|
UTM_SOURCE |
Рекламная система (Yandex-Direct, Google-Adwords и другие) |
|
UTM_MEDIUM |
Тип трафика. Возможные значения:
|
|
UTM_CAMPAIGN |
Обозначение рекламной кампании |
|
UTM_CONTENT |
Содержание кампании. Например, для контекстных объявлений |
|
UTM_TERM |
Условие поиска кампании. Например, ключевые слова контекстной рекламы |
|
PHONE |
Телефон |
|
EMAIL |
|
|
WEB |
Сайт |
|
Мессенджер |
|
|
LINK |
Ссылки. Служебное поле |
|
UF_... |
Пользовательские поля. Например, В зависимости от настроек портала у контактов может быть набор пользовательских полей определенных типов. Для изменения файловых полей рекомендуется использовать метод crm.item.update. Добавить пользовательское поле в контакт можно с помощью метода crm.contact.userfield.add |
|
PARENT_ID_... |
Поля связей. Если на портале есть смарт-процессы, связанные с контактами, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и контактом. Само поле хранит идентификатор элемента такого смарт-процесса. Например, поле |
Поля связи с внешними источниками данных
Если контакт создан внешней системой, то:
- поле
ORIGINATOR_IDхранит строковый идентификатор этой системы - поле
ORIGIN_IDхранит строковый идентификатор контакта в этой внешней системе - поле
ORIGIN_VERSIONхранит версию данных контакта в этой внешней системе
|
Название |
Описание |
|
ORIGINATOR_ID |
Идентификатор внешней системы, являющейся источником данных об этом контакте |
|
ORIGIN_ID |
Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных |
|
ORIGIN_VERSION |
Версия оригинала |
Устаревшие поля
Поля адреса в контакте являются устаревшими и используются только в режиме совместимости. Для работы с адресом используйте реквизиты.
|
Название |
Описание |
|
ADDRESS |
Адрес |
|
ADDRESS_2 |
Вторая строка адреса |
|
ADDRESS_CITY |
Город |
|
ADDRESS_POSTAL_CODE |
Почтовый индекс |
|
ADDRESS_REGION |
Район |
|
ADDRESS_PROVINCE |
Область |
|
ADDRESS_COUNTRY |
Страна |
|
ADDRESS_COUNTRY_CODE |
Код страны |
|
ADDRESS_LOC_ADDR_ID |
Идентификатор адреса местоположения |
Параметр params
|
Название |
Описание |
|
REGISTER_SONET_EVENT |
Производить ли регистрацию события обновления контакта в живой ленте. Возможные значения:
По умолчанию |
|
REGISTER_HISTORY_EVENT |
Производить ли регистрацию обновления контакта в истории. Возможные значения:
По умолчанию |
Примеры кода
Как использовать примеры в документации
Изменить контакт c id = 43
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":43,"FIELDS":{"NAME":"Сергей","BIRTHDATE":"11.11.1999","TYPE_ID":"RECOMMENDATION","SOURCE_ID":"WEB","POST":"Администратор компьютерных сетей","COMMENTS":"Новый комментарий","OPENED":"N","EXPORT":"Y","ASSIGNED_BY_ID":1,"COMPANY_ID":12,"COMPANY_IDS":[13,15],"UF_CRM_1720697698689":"Пример нового значения пользовательского поля с типом \"Строка\"","PARENT_ID_1224":14},"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.contact.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":43,"FIELDS":{"NAME":"Сергей","BIRTHDATE":"11.11.1999","TYPE_ID":"RECOMMENDATION","SOURCE_ID":"WEB","POST":"Администратор компьютерных сетей","COMMENTS":"Новый комментарий","OPENED":"N","EXPORT":"Y","ASSIGNED_BY_ID":1,"COMPANY_ID":12,"COMPANY_IDS":[13,15],"UF_CRM_1720697698689":"Пример нового значения пользовательского поля с типом \"Строка\"","PARENT_ID_1224":14},"PARAMS":{"REGISTER_SONET_EVENT":"N","REGISTER_HISTORY_EVENT":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.contact.update
try
{
const response = await $b24.callMethod(
'crm.contact.update',
{
id: 43,
fields: {
NAME: "Сергей",
BIRTHDATE: '11.11.1999',
TYPE_ID: "RECOMMENDATION",
SOURCE_ID: "WEB",
POST: "Администратор компьютерных сетей",
COMMENTS: "Новый комментарий",
OPENED: "N",
EXPORT: "Y",
ASSIGNED_BY_ID: 1,
COMPANY_ID: 12,
COMPANY_IDS: [13, 15],
UF_CRM_1720697698689: "Пример нового значения пользовательского поля с типом \"Строка\"",
PARENT_ID_1224: 14,
},
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 {
$contactId = 123; // Example contact ID
$fields = [
'NAME' => 'John',
'LAST_NAME' => 'Doe',
'BIRTHDATE' => (new DateTime('1990-01-01'))->format(DateTime::ATOM),
'PHONE' => '123456789',
'EMAIL' => 'john.doe@example.com',
'ADDRESS' => '123 Main St',
'ADDRESS_CITY' => 'Anytown',
'ADDRESS_COUNTRY' => 'USA',
];
$params = [
'REGISTER_SONET_EVENT' => 'Y',
];
$result = $serviceBuilder
->getCRMScope()
->contact()
->update($contactId, $fields, $params);
if ($result->isSuccess()) {
print($result->getCoreResponse()->getResponseData()->getResult()[0]);
} else {
print('Update failed.');
}
} catch (Throwable $e) {
print('Error: ' . $e->getMessage());
}
BX24.callMethod(
'crm.contact.update',
{
id: 43,
fields: {
NAME: "Сергей",
BIRTHDATE: '11.11.1999',
TYPE_ID: "RECOMMENDATION",
SOURCE_ID: "WEB",
POST: "Администратор компьютерных сетей",
COMMENTS: "Новый комментарий",
OPENED: "N",
EXPORT: "Y",
ASSIGNED_BY_ID: 1,
COMPANY_ID: 12,
COMPANY_IDS: [13, 15],
UF_CRM_1720697698689: "Пример нового значения пользовательского поля с типом \"Строка\"",
PARENT_ID_1224: 14,
},
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.contact.update',
[
'ID' => 43,
'FIELDS' => [
'NAME' => 'Сергей',
'BIRTHDATE' => '11.11.1999',
'TYPE_ID' => 'RECOMMENDATION',
'SOURCE_ID' => 'WEB',
'POST' => 'Администратор компьютерных сетей',
'COMMENTS' => 'Новый комментарий',
'OPENED' => 'N',
'EXPORT' => 'Y',
'ASSIGNED_BY_ID' => 1,
'COMPANY_ID' => 12,
'COMPANY_IDS' => [13, 15],
'UF_CRM_1720697698689' => 'Пример нового значения пользовательского поля с типом "Строка"',
'PARENT_ID_1224' => 14,
],
'PARAMS' => [
'REGISTER_SONET_EVENT' => 'N',
'REGISTER_HISTORY_EVENT' => 'N',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Работа с множественными полями
Изменить множественное поле
Для перезаписи существующего значения множественного поля передайте ID поля, которое вы хотите изменить, и его новое значение/тип.
Пусть есть следующие значение поля PHONE:
[
{
"ID": "222",
"VALUE_TYPE": "WORK",
"VALUE": "111111",
"TYPE_ID": "PHONE"
},
{
"ID": "223",
"VALUE_TYPE": "WORK",
"VALUE": "222222",
"TYPE_ID": "PHONE"
},
{
"ID": "224",
"VALUE_TYPE": "WORK",
"VALUE": "333333",
"TYPE_ID": "PHONE"
}
]
Чтобы изменить значения у телефона с ID = 223, передайте следующий параметр fields:
{
"fields": {
"PHONE": [
{
"ID": 223,
"VALUE": "444444",
"VALUE_TYPE": "MOBILE"
}
]
}
}
Удалить отдельное значение множественного поля
Чтобы удалить одно из значений множественного поля, передайте их идентификаторы и либо параметр DELETE = 'Y', либо пустой VALUE.
Пусть есть следующие значение поля PHONE:
[
{
"ID": "222",
"VALUE_TYPE": "WORK",
"VALUE": "111111",
"TYPE_ID": "PHONE"
},
{
"ID": "223",
"VALUE_TYPE": "WORK",
"VALUE": "222222",
"TYPE_ID": "PHONE"
},
{
"ID": "224",
"VALUE_TYPE": "WORK",
"VALUE": "333333",
"TYPE_ID": "PHONE"
},
{
"ID": "225",
"VALUE_TYPE": "WORK",
"VALUE": "44444",
"TYPE_ID": "PHONE"
}
]
Рассмотрим способы удаления всех значений кроме телефона с ID = 225:
{
"fields": {
"PHONE": [
{
"ID": 222,
"DELETE": "Y"
},
{
"ID": 223,
"VALUE": ""
},
{
"ID": 224
}
]
}
}
В результате останется:
[
{
"ID": "225",
"VALUE_TYPE": "WORK",
"VALUE": "44444",
"TYPE_ID": "PHONE"
}
]
Добавить новое значение для множественного поля
Чтобы добавить новое значение, достаточно его ввести. Уже существующие значения при этом изменены не будут.
Пример добавления нового значения 55555:
{
"fields": {
"PHONE": [
{
"VALUE": "55555",
"VALUE_TYPE": "WORK"
}
]
}
}
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1723820393.459406,
"finish": 1723820396.129949,
"duration": 2.6705431938171387,
"processing": 2.1193439960479736,
"date_start": "2024-08-16T16:59:53+02:00",
"date_finish": "2024-08-16T16:59:56+02:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Contact is not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
В параметр |
|
|
|
В параметр |
|
|
|
У пользователя нет прав на «Изменение» контактов |
|
|
Исчерпан выделенный дисковый ресурс |
|
|
|
Поле |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новый контакт crm.contact.add
- Получить контакт по Id crm.contact.get
- Получить список контактов crm.contact.list
- Удалить контакт crm.contact.delete
- Получить поля контакта crm.contact.fields
- Как изменить или удалить номера телефонов и email