метод REST scope: crm Устаревший

crm.contact.update

Изменить контакт

Устаревший метод. Развитие метода остановлено. Используйте 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. Оно хранит идентификатор элемента этого смарт-процесса, связанного с текущим контактом

Параметр params

REGISTER_SONET_EVENT boolean необязательный

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

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

REGISTER_HISTORY_EVENT boolean необязательный

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

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

Примеры запроса

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)

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

HTTP-статус: 400

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

Код	Описание	Значение
—	`Parameter 'fields' must be array`	В параметр `fields` передан не объект
—	`Parameter 'params' must be array`	В параметр `params` передан не объект
—	`Access denied`	У пользователя нет прав на «Изменение» контактов
—	Исчерпан выделенный дисковый ресурс
`ERROR_CORE`	Поле `Рабочий e-mail` содержит некорректный адрес

Описание

Параметры

Параметр fields

Параметр params

Примеры запроса

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

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