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

crm.contact.add

Создать новый контакт

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

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

Описание

Метод crm.contact.add создает новый контакт.

Параметры

fields object необязательный

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

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

где:
- field_n — название поля
- value_n — значение поля

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

Некорректное поле в 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 — нет

По умолчанию Y. Значение по умолчанию может быть изменено в настройках CRM

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

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

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

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 необязательный

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

TRACE string необязательный

Информация для сквозной аналитики

PHONE crm_multifield[] необязательный

Телефон

EMAIL crm_multifield[] необязательный

E-mail

WEB crm_multifield[] необязательный

Сайт

IM crm_multifield[] необязательный

Мессенджер

LINK crm_multifield[] необязательный

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

UF_... необязательный

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

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

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

PARENT_ID_... необязательный

Поля связей.

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

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

Параметр params

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

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

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

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

Включен ли режим импорта. Возможные значения:
- Y — да

Чтобы передать значение Нет, необходимо либо вообще не передавать параметр, либо передать значение 0, ''

По умолчанию Нет

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FIELDS":{"HONORIFIC":"HNR_RU_1","NAME":"Иван","SECOND_NAME":"Иванович","LAST_NAME":"Иванов","PHOTO":{"fileData":"**put_photo_data_here**"},"BIRTHDATE":"11.11.2001","TYPE_ID":"PARTNER","SOURCE_ID":"WEB","SOURCE_DESCRIPTION":"*Дополнительно об источнике*","POST":"Администратор","COMMENTS":"**put_comment_here**","OPENED":"Y","EXPORT":"N","ASSIGNED_BY_ID":6,"COMPANY_ID":12,"COMPANY_IDS":[12,13,15],"UTM_SOURCE":"yandex","UTM_MEDIUM":"CPC","UTM_CAMPAIGN":"summer_sale","UTM_CONTENT":"header_banner","UTM_TERM":"discount","PHONE":[{"VALUE":"+7333333555","VALUE_TYPE":"WORK"},{"VALUE":"+35599888666","VALUE_TYPE":"HOME"}],"EMAIL":[{"VALUE":"ivanov@example.mailing","VALUE_TYPE":"MAILING"},{"VALUE":"ivanov@example.work","VALUE_TYPE":"WORK"}],"UF_CRM_1720697698689":"Пример значения пользовательского поля с типом \"Строка\"","PARENT_ID_1224":12}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FIELDS":{"HONORIFIC":"HNR_RU_1","NAME":"Иван","SECOND_NAME":"Иванович","LAST_NAME":"Иванов","PHOTO":{"fileData":"**put_photo_data_here**"},"BIRTHDATE":"11.11.2001","TYPE_ID":"PARTNER","SOURCE_ID":"WEB","SOURCE_DESCRIPTION":"*Дополнительно об источнике*","POST":"Администратор","COMMENTS":"**put_comment_here**","OPENED":"Y","EXPORT":"N","ASSIGNED_BY_ID":6,"COMPANY_ID":12,"COMPANY_IDS":[12,13,15],"UTM_SOURCE":"yandex","UTM_MEDIUM":"CPC","UTM_CAMPAIGN":"summer_sale","UTM_CONTENT":"header_banner","UTM_TERM":"discount","PHONE":[{"VALUE":"+7333333555","VALUE_TYPE":"WORK"},{"VALUE":"+35599888666","VALUE_TYPE":"HOME"}],"EMAIL":[{"VALUE":"ivanov@example.mailing","VALUE_TYPE":"MAILING"},{"VALUE":"ivanov@example.work","VALUE_TYPE":"WORK"}],"UF_CRM_1720697698689":"Пример значения пользовательского поля с типом \"Строка\"","PARENT_ID_1224":12},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.contact.add

// 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<number>({
    method: 'crm.contact.add',
    params: {
      fields: {
        HONORIFIC: 'HNR_RU_1',
        NAME: 'Ivan',
        SECOND_NAME: 'Ivanovich',
        LAST_NAME: 'Ivanov',
        PHOTO: {
          fileData: document.getElementById('photo'),
        },
        BIRTHDATE: '11.11.2001',
        TYPE_ID: 'PARTNER',
        SOURCE_ID: 'WEB',
        SOURCE_DESCRIPTION: '*Additional source details*',
        POST: 'Administrator',
        COMMENTS: `
          Example comment inside the contact

          [B]Bold text[/B]
          [I]Italic[/I]
          [U]Underlined[/U]
          [S]Strikethrough[/S]
          [B][I][U][S]Mix[/S][/U][/I][/B]

          [LIST]
          [*]List item #1
          [*]List item #2
          [*]List item #3
          [/LIST]

          [LIST=1]
          [*]Numbered list item #1
          [*]Numbered list item #2
          [*]Numbered list item #3
          [/LIST]
        `,
        OPENED: 'Y',
        EXPORT: 'N',
        ASSIGNED_BY_ID: 6,
        COMPANY_ID: 12,
        COMPANY_IDS: [12, 13, 15],
        UTM_SOURCE: 'yandex',
        UTM_MEDIUM: 'CPC',
        UTM_CAMPAIGN: 'summer_sale',
        UTM_CONTENT: 'header_banner',
        UTM_TERM: 'discount',
        PHONE: [
          {
            VALUE: '+7333333555',
            VALUE_TYPE: 'WORK',
          },
          {
            VALUE: '+35599888666',
            VALUE_TYPE: 'HOME',
          },
        ],
        EMAIL: [
          {
            VALUE: 'ivanov@example.mailing',
            VALUE_TYPE: 'MAILING',
          },
          {
            VALUE: 'ivanov@example.work',
            VALUE_TYPE: 'WORK',
          },
        ],
        UF_CRM_1720697698689: 'Example value of a custom field of type "String"',
        PARENT_ID_1224: 12,
      },
    },
    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('Created contact id:', 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 addContact() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.contact.add',
        params: {
          fields: {
            HONORIFIC: 'HNR_RU_1',
            NAME: 'Ivan',
            SECOND_NAME: 'Ivanovich',
            LAST_NAME: 'Ivanov',
            PHOTO: {
              fileData: document.getElementById('photo'),
            },
            BIRTHDATE: '11.11.2001',
            TYPE_ID: 'PARTNER',
            SOURCE_ID: 'WEB',
            SOURCE_DESCRIPTION: '*Additional source details*',
            POST: 'Administrator',
            COMMENTS: `
              Example comment inside the contact

              [B]Bold text[/B]
              [I]Italic[/I]
              [U]Underlined[/U]
              [S]Strikethrough[/S]
              [B][I][U][S]Mix[/S][/U][/I][/B]

              [LIST]
              [*]List item #1
              [*]List item #2
              [*]List item #3
              [/LIST]

              [LIST=1]
              [*]Numbered list item #1
              [*]Numbered list item #2
              [*]Numbered list item #3
              [/LIST]
            `,
            OPENED: 'Y',
            EXPORT: 'N',
            ASSIGNED_BY_ID: 6,
            COMPANY_ID: 12,
            COMPANY_IDS: [12, 13, 15],
            UTM_SOURCE: 'yandex',
            UTM_MEDIUM: 'CPC',
            UTM_CAMPAIGN: 'summer_sale',
            UTM_CONTENT: 'header_banner',
            UTM_TERM: 'discount',
            PHONE: [
              {
                VALUE: '+7333333555',
                VALUE_TYPE: 'WORK',
              },
              {
                VALUE: '+35599888666',
                VALUE_TYPE: 'HOME',
              },
            ],
            EMAIL: [
              {
                VALUE: 'ivanov@example.mailing',
                VALUE_TYPE: 'MAILING',
              },
              {
                VALUE: 'ivanov@example.work',
                VALUE_TYPE: 'WORK',
              },
            ],
            UF_CRM_1720697698689: 'Example value of a custom field of type "String"',
            PARENT_ID_1224: 12,
          },
        },
        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('Created contact id:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addContact)
</script>

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.contact.add',
            [
                'fields' => [
                    'HONORIFIC' => 'HNR_RU_1',
                    'NAME' => 'Иван',
                    'SECOND_NAME' => 'Иванович',
                    'LAST_NAME' => 'Иванов',
                    'PHOTO' => [
                        'fileData' => document.getElementById('photo'),
                    ],
                    'BIRTHDATE' => '11.11.2001',
                    'TYPE_ID' => 'PARTNER',
                    'SOURCE_ID' => 'WEB',
                    'SOURCE_DESCRIPTION' => '*Дополнительно об источнике*',
                    'POST' => 'Администратор',
                    'COMMENTS' => '
                        Пример комментария внутри контакта

                        [B]Жирный текст[/B]
                        [I]Курсив[/I]
                        [U]Подчеркнутый[/U]
                        [S]Зачеркнутый[/S]
                        [B][I][U][S]Микс[/S][/U][/I][/B]

                        [LIST]
                        [*]Элемент списка #1
                        [*]Элемент списка #2
                        [*]Элемент списка #3
                        [/LIST]

                        [LIST=1]
                        [*]Нумерованный элемент списка #1
                        [*]Нумерованный элемент списка #2
                        [*]Нумерованный элемент списка #3
                        [/LIST]
                    ',
                    'OPENED' => 'Y',
                    'EXPORT' => 'N',
                    'ASSIGNED_BY_ID' => 6,
                    'COMPANY_ID' => 12,
                    'COMPANY_IDS' => [12, 13, 15],
                    'UTM_SOURCE' => 'yandex',
                    'UTM_MEDIUM' => 'CPC',
                    'UTM_CAMPAIGN' => 'summer_sale',
                    'UTM_CONTENT' => 'header_banner',
                    'UTM_TERM' => 'discount',
                    'PHONE' => [
                        [
                            'VALUE' => '+7333333555',
                            'VALUE_TYPE' => 'WORK',
                        ],
                        [
                            'VALUE' => '+35599888666',
                            'VALUE_TYPE' => 'HOME',
                        ]
                    ],
                    'EMAIL' => [
                        [
                            'VALUE' => 'ivanov@example.mailing',
                            'VALUE_TYPE' => 'MAILING',
                        ],
                        [
                            'VALUE' => 'ivanov@example.work',
                            'VALUE_TYPE' => 'WORK',
                        ]
                    ],
                    'UF_CRM_1720697698689' => 'Пример значения пользовательского поля с типом "Строка"',
                    'PARENT_ID_1224' => 12,
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding contact: ' . $e->getMessage();
}

BX24.callMethod(
    'crm.contact.add',
    {
        fields: {
            HONORIFIC: "HNR_RU_1",
            NAME: "Иван",
            SECOND_NAME: "Иванович",
            LAST_NAME: "Иванов",
            PHOTO: {
                fileData: document.getElementById('photo'),
            },
            BIRTHDATE: '11.11.2001',
            TYPE_ID: "PARTNER",
            SOURCE_ID: "WEB",
            SOURCE_DESCRIPTION: "*Дополнительно об источнике*",
            POST: "Администратор",
            COMMENTS: `
                Пример комментария внутри контакта

                [B]Жирный текст[/B]
                [I]Курсив[/I]
                [U]Подчеркнутый[/U]
                [S]Зачеркнутый[/S]
                [B][I][U][S]Микс[/S][/U][/I][/B]

                [LIST]
                [*]Элемент списка #1
                [*]Элемент списка #2
                [*]Элемент списка #3
                [/LIST]

                [LIST=1]
                [*]Нумерованный элемент списка #1
                [*]Нумерованный элемент списка #2
                [*]Нумерованный элемент списка #3
                [/LIST]
            `,
            OPENED: "Y",
            EXPORT: "N",
            ASSIGNED_BY_ID: 6,
            COMPANY_ID: 12,
            COMPANY_IDS: [12, 13, 15],
            UTM_SOURCE: "yandex",
            UTM_MEDIUM: "CPC",
            UTM_CAMPAIGN: "summer_sale",
            UTM_CONTENT: "header_banner",
            UTM_TERM: "discount",
            PHONE: [
                {
                    VALUE: "+7333333555",
                    VALUE_TYPE: "WORK",
                },
                {
                    VALUE: "+35599888666",
                    VALUE_TYPE: "HOME",
                }
            ],
            EMAIL: [
                {
                    VALUE: "ivanov@example.mailing",
                    VALUE_TYPE: "MAILING",
                },
                {
                    VALUE: "ivanov@example.work",
                    VALUE_TYPE: "WORK",
                }
            ],
            UF_CRM_1720697698689: "Пример значения пользовательского поля с типом \"Строка\"",
            PARENT_ID_1224: 12,
        },
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);

require_once('crest.php');

$result = CRest::call(
    'crm.contact.add',
    [
        'fields' => [
            'HONORIFIC' => 'HNR_RU_1',
            'NAME' => 'Иван',
            'SECOND_NAME' => 'Иванович',
            'LAST_NAME' => 'Иванов',
            'PHOTO' => [
                'fileData' => document.getElementById('photo'),
            ],
            'BIRTHDATE' => '11.11.2001',
            'TYPE_ID' => 'PARTNER',
            'SOURCE_ID' => 'WEB',
            'SOURCE_DESCRIPTION' => '*Дополнительно об источнике*',
            'POST' => 'Администратор',
            'COMMENTS' => '
                Пример комментария внутри контакта

                [B]Жирный текст[/B]
                [I]Курсив[/I]
                [U]Подчеркнутый[/U]
                [S]Зачеркнутый[/S]
                [B][I][U][S]Микс[/S][/U][/I][/B]

                [LIST]
                [*]Элемент списка #1
                [*]Элемент списка #2
                [*]Элемент списка #3
                [/LIST]

                [LIST=1]
                [*]Нумерованный элемент списка #1
                [*]Нумерованный элемент списка #2
                [*]Нумерованный элемент списка #3
                [/LIST]
            ',
            'OPENED' => 'Y',
            'EXPORT' => 'N',
            'ASSIGNED_BY_ID' => 6,
            'COMPANY_ID' => 12,
            'COMPANY_IDS' => [12, 13, 15],
            'UTM_SOURCE' => 'yandex',
            'UTM_MEDIUM' => 'CPC',
            'UTM_CAMPAIGN' => 'summer_sale',
            'UTM_CONTENT' => 'header_banner',
            'UTM_TERM' => 'discount',
            'PHONE' => [
                [
                    'VALUE' => '+7333333555',
                    'VALUE_TYPE' => 'WORK',
                ],
                [
                    'VALUE' => '+35599888666',
                    'VALUE_TYPE' => 'HOME',
                ]
            ],
            'EMAIL' => [
                [
                    'VALUE' => 'ivanov@example.mailing',
                    'VALUE_TYPE' => 'MAILING',
                ],
                [
                    'VALUE' => 'ivanov@example.work',
                    'VALUE_TYPE' => 'WORK',
                ]
            ],
            'UF_CRM_1720697698689' => 'Пример значения пользовательского поля с типом "Строка"',
            'PARENT_ID_1224' => 12,
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.contact.add", b24.Params{
	"fields": b24.Params{
		"HONORIFIC":   "HNR_RU_1",
		"NAME":        "Иван",
		"SECOND_NAME": "Иванович",
		"LAST_NAME":   "Иванов",
		"PHOTO": b24.Params{
			"fileData": "**put_photo_data_here**",
		},
		"BIRTHDATE":          "11.11.2001",
		"TYPE_ID":            "PARTNER",
		"SOURCE_ID":          "WEB",
		"SOURCE_DESCRIPTION": "*Дополнительно об источнике*",
		"POST":               "Администратор",
		"COMMENTS":           "**put_comment_here**",
		"OPENED":             "Y",
		"EXPORT":             "N",
		"ASSIGNED_BY_ID":     6,
		"COMPANY_ID":         12,
		"COMPANY_IDS":        []int{12, 13, 15},
		"UTM_SOURCE":         "yandex",
		"UTM_MEDIUM":         "CPC",
		"UTM_CAMPAIGN":       "summer_sale",
		"UTM_CONTENT":        "header_banner",
		"UTM_TERM":           "discount",
		"PHONE": []b24.Params{
			{
				"VALUE":      "+7333333555",
				"VALUE_TYPE": "WORK",
			},
			{
				"VALUE":      "+35599888666",
				"VALUE_TYPE": "HOME",
			},
		},
		"EMAIL": []b24.Params{
			{
				"VALUE":      "ivanov@example.mailing",
				"VALUE_TYPE": "MAILING",
			},
			{
				"VALUE":      "ivanov@example.work",
				"VALUE_TYPE": "WORK",
			},
		},
		"UF_CRM_1720697698689": "Пример значения пользовательского поля с типом \"Строка\"",
		"PARENT_ID_1224":       12,
	},
})
if err != nil {
	return fmt.Errorf("crm.contact.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

Ответ

HTTP-статус: 200

{
    "result": 46,
    "time": {
        "start": 1723713732.235658,
        "finish": 1723713733.742049,
        "duration": 1.5063910484313965,
        "processing": 1.1416668891906738,
        "date_start": "2024-08-15T11:22:12+02:00",
        "date_finish": "2024-08-15T11:22:13+02:00"
    }
}

Возвращаемые данные

result integer

Корневой элемент ответа, содержит идентификатор созданного контакта

time time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "Parameter 'fields' must be array."
}

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

Описание

Параметры

Параметр fields

Параметр params

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

Ответ

Возвращаемые данные

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

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