Изменить контакт crm.contact.update

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

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

Scope: crm

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

DEPRECATED

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

Метод crm.contact.update обновляет существующий контакт.

Рекомендуем при обновлении адреса передавать полный набор полей адреса в метод обновления.

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

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

Название
тип

Описание

id*
integer

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

Идентификатор можно получить методами crm.сontact.list или crm.contact.add

fields*
object

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

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

где:

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

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

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

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

params
object

Объект, содержащий набор дополнительных параметров.

Структура и возможные значения описаны ниже

Параметр fields

Название
тип

Описание

HONORIFIC
crm_status

Обращение.

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

NAME
string

Имя

SECOND_NAME
string

Отчество

LAST_NAME
string

Фамилия

PHOTO
file

Фотография

BIRTHDATE
date

Дата рождения

TYPE_ID
crm_status

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

SOURCE_ID
crm_status

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

SOURCE_DESCRIPTION
string

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

POST
string

Должность

COMMENTS
string

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

OPENED
boolean

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

  • Y — да
  • N — нет

EXPORT
boolean

Участвует ли контакт в экспорте. Возможные значения:

  • Y — да
  • N — нет

ASSIGNED_BY_ID
user

Идентификатор пользователя, ответственного за элемент

COMPANY_ID
crm_company

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

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

COMPANY_IDS
crm_company[]

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

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

UTM_SOURCE
string

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

UTM_MEDIUM
string

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

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

UTM_CAMPAIGN
string

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

UTM_CONTENT
string

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

UTM_TERM
string

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

PHONE
crm_multifield[]

Телефон

EMAIL
crm_multifield[]

E-mail

WEB
crm_multifield[]

Сайт

IM
crm_multifield[]

Мессенджер

LINK
crm_multifield[]

Ссылки. Служебное поле

UF_...

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

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

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

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

PARENT_ID_...

Поля связей.

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

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

Поля связи с внешними источниками данных

Если контакт создан внешней системой, то:

  • поле ORIGINATOR_ID хранит строковый идентификатор этой системы
  • поле ORIGIN_ID хранит строковый идентификатор контакта в этой внешней системе
  • поле ORIGIN_VERSION хранит версию данных контакта в этой внешней системе

Название
тип

Описание

ORIGINATOR_ID
string

Идентификатор внешней системы, являющейся источником данных об этом контакте

ORIGIN_ID
string

Версия данных о контакте во внешней системе. Используется для защиты данных от случайного перетирания внешней системой.

Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных

ORIGIN_VERSION
string

Версия оригинала

Устаревшие поля

Поля адреса в контакте являются устаревшими и используются только в режиме совместимости. Для работы с адресом используйте реквизиты.

Название
тип

Описание

ADDRESS
string

Адрес

ADDRESS_2
string

Вторая строка адреса

ADDRESS_CITY
string

Город

ADDRESS_POSTAL_CODE
string

Почтовый индекс

ADDRESS_REGION
string

Район

ADDRESS_PROVINCE
string

Область

ADDRESS_COUNTRY
string

Страна

ADDRESS_COUNTRY_CODE
string

Код страны

ADDRESS_LOC_ADDR_ID
integer

Идентификатор адреса местоположения

Параметр params

Название
тип

Описание

REGISTER_SONET_EVENT
boolean

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

  • Y — да
  • N — нет

По умолчанию N

REGISTER_HISTORY_EVENT
boolean

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

  • Y — да
  • N — нет

По умолчанию Y

Примеры кода

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

Изменить контакт 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
// 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.contact.update',
    params: {
      id: 43,
      fields: {
        NAME: 'Sergey',
        BIRTHDATE: '11.11.1999',
        TYPE_ID: 'RECOMMENDATION',
        SOURCE_ID: 'WEB',
        POST: 'Computer network administrator',
        COMMENTS: 'New comment',
        OPENED: 'N',
        EXPORT: 'Y',
        ASSIGNED_BY_ID: 1,
        COMPANY_ID: 12,
        COMPANY_IDS: [13, 15],
        UF_CRM_1720697698689: 'Example new value of a custom field of type "String"',
        PARENT_ID_1224: 14,
      },
      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('Contact 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 updateContact() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.contact.update',
        params: {
          id: 43,
          fields: {
            NAME: 'Sergey',
            BIRTHDATE: '11.11.1999',
            TYPE_ID: 'RECOMMENDATION',
            SOURCE_ID: 'WEB',
            POST: 'Computer network administrator',
            COMMENTS: 'New comment',
            OPENED: 'N',
            EXPORT: 'Y',
            ASSIGNED_BY_ID: 1,
            COMPANY_ID: 12,
            COMPANY_IDS: [13, 15],
            UF_CRM_1720697698689: 'Example new value of a custom field of type "String"',
            PARENT_ID_1224: 14,
          },
          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('Contact updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateContact)
</script>
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.contact.update", b24.Params{
	"id": 43,
	"fields": b24.Params{
		"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":          []int{13, 15},
		"UF_CRM_1720697698689": "Пример нового значения пользовательского поля с типом \"Строка\"",
		"PARENT_ID_1224":       14,
	},
	"params": b24.Params{
		"REGISTER_SONET_EVENT":   "N",
		"REGISTER_HISTORY_EVENT": "N",
	},
})
if err != nil {
	return fmt.Errorf("crm.contact.update: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

Работа с множественными полями

Изменить множественное поле

Для перезаписи существующего значения множественного поля передайте 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
boolean

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

time
time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Contact is not found"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

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

Parameter 'fields' must be array

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

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

Parameter 'params' must be array

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

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

Access denied

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

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

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

ERROR_CORE

Поле Рабочий e-mail содержит некорректный адрес

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

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

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

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