Импортировать одну запись crm.item.import

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом на импорт элементов CRM

Метод crm.item.import импортирует один элемент в CRM.

При импорте действуют отдельные права, а автоматизация создания элемента не запускается. Подробнее об особенностях импорта читайте в обзоре методов.

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

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

Название
тип

Описание

entityTypeId*
integer

Идентификатор системного или пользовательского типа CRM, в который нужно импортировать элемент.

Числовые значения системных типов, например лид — 1, сделка — 2, контакт — 3, компания — 4, счет — 31, приведены в справочнике типов объектов CRM. Идентификатор смарт-процесса можно получить методом crm.type.list

fields*
object

Значения полей импортируемого элемента (подробное описание)

useOriginalUfNames
boolean

Параметр для управления форматом имен пользовательских полей в запросе.
Возможные значения:

  • Y — оригинальные имена пользовательских полей, например UF_CRM_2_1639669411830
  • N — имена пользовательских полей в camelCase, например ufCrm2_1639669411830

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

Параметр fields

Набор полей зависит от типа объекта CRM. Передавайте названия полей как ключи объекта, а значения полей — как значения этих ключей:

{
    field_1: value_1,
    field_2: value_2
}

Некорректное поле в fields будет проигнорировано. Получить актуальный набор полей можно универсальным методом crm.item.fields или методами crm.lead.fields, crm.deal.fields, crm.contact.fields, crm.company.fields, crm.quote.fields.

Мультиполя, например PHONE и EMAIL, передавайте в формате crm_multifield.

Идентификатор типа CRM entityTypeId: 1

Название
тип

Описание

title
string

Название элемента.

По умолчанию генерируется по шаблону {entityTypeName} #{id}, где

  • entityTypeName — название типа объекта
  • id — идентификатор элемента

Например, для лида с id = 13 — Лид #13

honorific
crm_status

Строковый идентификатор обращения лида (например HNR_RU_1 — «г-н»).

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

По умолчанию — null

name
string

Имя.

По умолчанию — null

secondName
string

Отчество.

По умолчанию — null

lastName
string

Фамилия.

По умолчанию — null

birthdate
date

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

По умолчанию — null

companyTitle
string

Название компании.

По умолчанию — null

sourceId
crm_status

Строковый идентификатор источника.

Например CALL — «Звонок».

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

По умолчанию — первый доступный источник

sourceDescription
text

Дополнительная информация об источнике.

По умолчанию — null

stageId
crm_status

Строковый идентификатор стадии элемента.

Например NEW — «Не обработан».

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

По умолчанию — первая доступная стадия

statusDescription
text

Дополнительно о стадии.

По умолчанию — null

post
string

Должность.

По умолчанию — null

currencyId
crm_currency

Идентификатор валюты элемента

По умолчанию — валюта по умолчанию

isManualOpportunity
boolean

Режим расчета суммы. Возможные значения:

  • Y — ручной
  • N — автоматический

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

opportunity
double

Сумма.

По умолчанию — null

opened
boolean

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

  • Y — да
  • N — нет

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

comments
text

Комментарий.

По умолчанию — null

assignedById
user

Идентификатор ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

companyId
crm_company

Идентификатор компании, привязанной к элементу.

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

По умолчанию — null

contactId
crm_contact

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

contactIds
crm_contact[]

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

originatorId
string

Внешний источник.

По умолчанию — null

originId
string

Идентификатор элемента во внешнем источнике.

По умолчанию — null

webformId
integer

Идентификатор CRM Формы.

По умолчанию — null

observers
user[]

Массив идентификаторов пользователей, которые будут наблюдателями элемента.

По умолчанию — null

utmSource
string

Рекламная система. Например: Yandex-Direct, Google-Adwords и другие.

По умолчанию — null

utmMedium
string

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

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

По умолчанию — null

utmCampaign
string

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

По умолчанию — null

utmContent
string

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

По умолчанию — null

utmTerm
string

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

По умолчанию — null

ufCrm...
crm_userfield

Пользовательское поле.

О пользовательских полях читайте раздел Пользовательские поля в CRM: обзор методов

Значения множественных полей передаются в виде массива.

Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла.

parentId...
crm_entity

Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу.

Каждое такое поле имеет код parentId + {parentEntityTypeId}

Идентификатор типа CRM entityTypeId: 2

Название
тип

Описание

title
string

Название элемента

По умолчанию генерируется по шаблону {entityTypeName} #{id}, где

  • entityTypeName — название типа объекта
  • id — идентификатор элемента
    Например, для сделки с id = 13 — Сделка #13

typeId
crm_status

Строковый идентификатор типа объекта.

Например, для сделки: SALE — «Продажа»

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

По умолчанию — первый доступный тип объекта

categoryId
integer

Идентификатор воронки сделки.

По умолчанию — 0 (общая воронка)

stageId
crm_status

Строковый идентификатор стадии элемента.

Например NEW — «Не обработан».

Список доступных стадий можно получить методом crm.status.list, передав фильтр:

  • если сделка находится в общей воронке — { ENTITY_ID: "DEAL_STAGE" }
  • если сделка находится не в общей воронке — { ENTITY_ID: "DEAL_STAGE_{categoryId}" }, где categoryId — идентификатор воронки сделки

По умолчанию — первая доступная стадия воронки

isRecurring
boolean

Является ли сделка регулярной. Возможные значения:

  • Y — да
  • N — нет

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

probability
integer

Вероятность успешного завершения сделки в процентах.

По умолчанию — null

currencyId
crm_currency

Идентификатор валюты элемента.

По умолчанию — валюта по умолчанию

isManualOpportunity
boolean

Режим расчета суммы. Возможные значения:

  • Y — ручной
  • N — автоматический

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

opportunity
double

Сумма.

По умолчанию — null

taxValue
double

Сумма налога.

По умолчанию — null

companyId
crm_company

Идентификатор компании, привязанной к элементу.

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

По умолчанию — null

contactId
crm_contact

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

contactIds
crm_contact[]

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

quoteId
crm_quote

Идентификатор предложения, который будет привязан к сделке

begindate
date

Дата начала элемента.

По умолчанию — дата создания

closedate
date

Дата окончания элемента.

По умолчанию — через семь дней после создания элемента

opened
boolean

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

  • Y — да
  • N — нет

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

comments
text

Комментарий.

По умолчанию — null

assignedById
user

Идентификатор ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

sourceId
crm_status

Строковый идентификатор источника.

Например CALL — «Звонок».

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

По умолчанию — первый доступный источник

sourceDescription
text

Дополнительная информация об источнике.

По умолчанию — null

leadId
crm_lead

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

По умолчанию — null

additionalInfo
string

Дополнительная информация.

По умолчанию — null

originatorId
string

Внешний источник.

По умолчанию — null

originId
string

Идентификатор элемента во внешнем источнике.

По умолчанию — null

observers
user[]

Массив идентификаторов пользователей, которые будут наблюдателями элемента.

По умолчанию — null

locationId
location

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

По умолчанию — null

utmSource
string

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

По умолчанию — null

utmMedium
string

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

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

По умолчанию — null

utmCampaign string

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

По умолчанию — null

utmContent
string

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

По умолчанию — null

utmTerm
string

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

По умолчанию — null

ufCrm...
crm_userfield

Пользовательское поле. Смотрите раздел Пользовательские поля в CRM: обзор методов

  • Значения множественных полей передаются в виде массива
  • Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла.

parentId...
crm_entity

Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу.

Каждое такое поле имеет код parentId + {parentEntityTypeId}

Идентификатор типа CRM entityTypeId: 3

Название
тип

Описание

honorific
crm_status

Строковый идентификатор обращения контакта.

Например HNR_RU_1 — «г-н».

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

По умолчанию — null

name
string

Имя.

По умолчанию — null

secondName
string

Отчество.

По умолчанию — null

lastName
string

Фамилия.

По умолчанию — null

photo
file

Фотография.

По умолчанию — null

birthdate
date

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

По умолчанию — null

typeId
crm_status

Строковый идентификатор типа объекта.

Например, для сделки: SALE — «Продажа».

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

По умолчанию — первый доступный тип объекта

sourceId
crm_status

Строковый идентификатор источника.

Например CALL — «Звонок».

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

По умолчанию — первый доступный источник

sourceDescription
text

Дополнительная информация об источнике.

По умолчанию — null

post
string

Должность.

По умолчанию — null

comments
text

Комментарий.

По умолчанию — null

opened
boolean

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

  • Y — да
  • N — нет

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

export
boolean

Участвует ли контакт в экспорте.

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

assignedById
user

Идентификатор ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

companyId
crm_company

Идентификатор компании, привязанной к элементу.

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

По умолчанию — null

companyIds
crm_company

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

leadId
crm_lead

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

По умолчанию — null

originatorId
string

Внешний источник.

По умолчанию — null

originId
string

Идентификатор элемента во внешнем источнике.

По умолчанию — null

originVersion
string

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

По умолчанию — null

observers
user[]

Массив идентификаторов пользователей, которые будут наблюдателями элемента.

По умолчанию — null

utmSource
string

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

По умолчанию — null

utmMedium
string

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

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

По умолчанию — null

utmCampaign
string

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

По умолчанию — null

utmContent
string

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

По умолчанию — null

utmTerm
string

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

По умолчанию — null

ufCrm...
crm_userfield

Пользовательское поле. Смотрите раздел Пользовательские поля в CRM: обзор методов

  • Значения множественных полей передаются в виде массива
  • Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла.

parentId...
crm_entity

Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу.

Каждое такое поле имеет код parentId + {parentEntityTypeId}

Идентификатор типа CRM entityTypeId: 4

Название
тип

Описание

title
string

Название элемента.

По умолчанию генерируется по шаблону {entityTypeName} #{id}, где

  • entityTypeName — название типа объекта
  • id — идентификатор элемента

Например, для компании с id = 13 — Компания #13

typeId
crm_status

Строковый идентификатор типа объекта.

Например, для сделки: SALE — «Продажа».

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

По умолчанию — первый доступный тип объекта

logo
file

Логотип.

По умолчанию — null

bankingDetails
string

Банковские реквизиты.

По умолчанию — null

industry
crm_status

Строковый идентификатор отрасли.

Например IT — «Информационные технологии».

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

По умолчанию — первая доступная отрасль

employees
crm_status

Строковый идентификатор диапазона количества сотрудников.

Значение берется из списка доступных, например EMPLOYEES_1 — «менее 50».

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

По умолчанию — первый доступный диапазон количества сотрудников

currencyId
crm_currency

Идентификатор валюты элемента.

По умолчанию — валюта по умолчанию

revenue
double

Годовой оборот.

По умолчанию — 0

opened
boolean

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

  • Y — да
  • N — нет

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

comments
text

Комментарий.

По умолчанию — null

isMyCompany
boolean

Является ли компания моей компанией.

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

assignedById
user

Идентификатор ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

contactIds
crm_contact[]

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

leadId
crm_lead

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

По умолчанию — null

originatorId
string

Внешний источник.

По умолчанию — null

originId
string

Идентификатор элемента во внешнем источнике.

По умолчанию — null

originVersion
string

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

По умолчанию — null

observers
user[]

Массив идентификаторов пользователей, которые будут наблюдателями элемента.

По умолчанию — null

utmSource
string

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

По умолчанию — null

utmMedium
string

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

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

По умолчанию — null

utmCampaign
string

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

По умолчанию — null

utmContent
string

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

По умолчанию — null

utmTerm
string

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

По умолчанию — null

ufCrm...
crm_userfield

Пользовательское поле. Смотрите раздел Пользовательские поля в CRM: обзор методов

  • Значения множественных полей передаются в виде массива
  • Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла

parentId...
crm_entity

Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу.

Каждое такое поле имеет код parentId + {parentEntityTypeId}

Идентификатор объекта CRM entityTypeId: 7

Название
тип

Описание

title
string

Название элемента.

По умолчанию генерируется по шаблону {entityTypeName} #{id}, где

  • entityTypeName — название типа объекта
  • id — идентификатор элемента

Например, для предложения с id = 13 — Предложение #13

assignedById
user

Идентификатор ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

opened
boolean

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

  • Y — да
  • N — нет

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

content
text

Содержание.

По умолчанию — null

terms
text

Условия.

По умолчанию — null

comments
text

Комментарий.

По умолчанию — null

dealId
crm_deal

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

По умолчанию — null

leadId
crm_lead

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

По умолчанию — null

storageTypeId
integer

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

  • 1 — файл
  • 2 — WebDAV
  • 3 — диск

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

  1. Если установлен модуль disk -> Диск
  2. Если установлен модуль webdav -> WebDAV
  3. Файл

storageElementIds
integer

Массив файлов.

По умолчанию — null

webformId
integer

Идентификатор CRM Формы.

По умолчанию — null

companyId
crm_company

Идентификатор компании, привязанной к элементу.

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

По умолчанию — null

contactId
crm_contact

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3

По умолчанию — null

contactIds
crm_contact[]

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

locationId
location

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

По умолчанию — null

currencyId
crm_currency

Идентификатор валюты элемента.

По умолчанию — валюта по умолчанию

isManualOpportunity
boolean

Режим расчета суммы.

  • Y — ручной
  • N — автоматический

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

opportunity
double

Сумма.

По умолчанию — null

taxValue
double

Сумма налога.

По умолчанию — null

stageId
crm_status

Строковый идентификатор стадии элемента.

Например DRAFT — «Новое».

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

По умолчанию — первая доступная стадия

begindate
date

Дата начала элемента.

По умолчанию — дата создания элемента

closedate
date

Дата окончания элемента.

По умолчанию — через семь дней после создания элемента

actualDate
date

Актуально до.

По умолчанию — через семь дней после создания элемента

mycompanyId
crm_company

Идентификатор моей компании.

По умолчанию — идентификатор первой доступной «моей» компании

utmSource
string

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

По умолчанию — null

utmMedium
string

Тип трафика.

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

По умолчанию — null

utmCampaign
string

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

По умолчанию — null

utmContent
string

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

По умолчанию — null

utmTerm
string

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

По умолчанию — null

ufCrm...
crm_userfield

Пользовательское поле. Смотрите раздел Пользовательские поля в CRM: обзор методов.

  • Значения множественных полей передаются в виде массива
  • Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла.

parentId...
crm_entity

Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу.

Каждое такое поле имеет код parentId + {parentEntityTypeId}

Идентификатор типа CRM entityTypeId: 31

Название
тип

Описание

title
string

Название элемента.

По умолчанию генерируется по шаблону {entityTypeName} #{id}, где

  • entityTypeName — название типа объекта
  • id — идентификатор элемента

Например, для счета с id = 13 — Счет #13

xmlId
string

Внешний код.

По умолчанию — null

assignedById
user

Идентификатор ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

opened
boolean

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

  • Y — да
  • N — нет

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

webformId
integer

Идентификатор CRM Формы.

По умолчанию — null

begindate
date

Дата начала элемента.

По умолчанию — дата создания элемента

closedate
date

Дата окончания элемента.

По умолчанию — через семь дней после создания элемента

companyId
crm_company

Идентификатор компании, привязанной к элементу.

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

По умолчанию — null

contactId
crm_contact

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

contactIds
crm_contact[]

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

По умолчанию — null

observers
user[]

Массив идентификаторов пользователей, которые будут наблюдателями элемента.

По умолчанию — null

stageId
crm_status

Строковый идентификатор стадии элемента.

Например DT31_13:N — «Новый».

Список доступных стадий можно получить методом crm.status.list, передав фильтр { ENTITY_ID: "SMART_INVOICE_STAGE_{categoryId}" }, где
categoryId — идентификатор воронки счетов по умолчанию. Его можно получить методом crm.category.list по entityTypeId = 31.

По умолчанию — первая доступная стадия

sourceId
crm_status

Строковый идентификатор источника.

Например CALL — «Звонок».

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

По умолчанию — первый доступный источник

sourceDescription
text

Дополнительная информация об источнике.

По умолчанию — null

currencyId
crm_currency

Идентификатор валюты элемента.

По умолчанию — валюта по умолчанию

isManualOpportunity
boolean

Режим расчета суммы. Возможные значения:

  • Y — ручной
  • N — автоматический

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

opportunity
double

Сумма.

По умолчанию — null

taxValue
double

Сумма налога.

По умолчанию — null

mycompanyId
crm_company

Идентификатор моей компании.

По умолчанию — идентификатор первой доступной «моей» компании

comments
text

Комментарий.

По умолчанию — null

locationId
location

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

По умолчанию — null

ufCrm...
crm_userfield

Пользовательское поле. Смотрите раздел Пользовательские поля в CRM: обзор методов.

  • Значения множественных полей передаются в виде массива
  • Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла.

parentId...
crm_entity

Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу.

Каждое такое поле имеет код parentId + {parentEntityTypeId}

Идентификатор типа CRM entityTypeId: можно получить методом crm.type.list или создать новый методом crm.type.add

Название
тип

Описание

title
string

Название элемента.

По умолчанию генерируется по шаблону {entityTypeName} #{id}, где

  • entityTypeName — название смарт-процесса
  • id — идентификатор элемента

Например, для элемента смарт-процесса HR с id = 13 — HR #13

xmlId
string

Внешний код.

По умолчанию — null

assignedById
user

Идентификатор ответственного за элемент.

По умолчанию — идентификатор пользователя, который вызывает метод

opened
boolean

Является ли элемент доступным для всех.

  • Y — да
  • N — нет

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

webformId
integer

Идентификатор CRM Формы.

По умолчанию — null

begindate
date

Дата начала элемента.

Доступно только при включенной настройке isBeginCloseDatesEnabled у соответствующего смарт-процесса.

По умолчанию — дата создания элемента

closedate
date

Дата окончания элемента.

Доступно только при включенной настройке isBeginCloseDatesEnabled у соответствующего смарт-процесса.

По умолчанию — через семь дней после создания элемента

companyId
crm_company

Идентификатор компании, привязанной к элементу.

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

Доступно только при включенной настройке isClientEnabled у соответствующего смарт-процесса.

По умолчанию — null

contactId
crm_contact

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

Доступно только при включенной настройке isClientEnabled у соответствующего смарт-процесса.

По умолчанию — null

contactIds
crm_contact[]

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

Список контактов можно получить методом crm.item.list по entityTypeId = 3.

Доступно только при включенной настройке isClientEnabled у соответствующего смарт-процесса.

По умолчанию — null

observers
user[]

Массив идентификаторов пользователей, которые будут наблюдателями элемента.

Доступно только при включенной настройке isObserversEnabled у соответствующего смарт-процесса.

По умолчанию — null

categoryId
crm_category

Идентификатор воронки элемента смарт-процесса.

Список доступных воронок можно получить методом crm.category.list, передав соответствующий entityTypeId

stageId
crm_status

Строковый идентификатор стадии элемента.

Например DT1220_30:NEW — «Начало».

Список доступных стадий можно получить методом crm.status.list, передав фильтр { ENTITY_ID: "DYNAMIC_{entityTypeId}_STAGE_{categoryId}" }, где

  • entityTypeId — идентификатор типа смарт-процесса
  • categoryId — идентификатор воронки элемента смарт-процесса

Подробнее о воронках.

Доступно только при включенной настройке isStagesEnabled у соответствующего смарт-процесса.

По умолчанию — первая доступная стадия воронки

sourceId
crm_status

Строковый идентификатор источника, например CALL — «Звонок»).

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

Доступно только при включенной настройке isSourceEnabled у соответствующего смарт-процесса.

По умолчанию — первый доступный источник

sourceDescription
text

Дополнительная информация об источнике.

Доступно только при включенной настройке isSourceEnabled у соответствующего смарт-процесса.

По умолчанию — null

currencyId
crm_currency

Идентификатор валюты элемента.

Доступно только при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса.

По умолчанию — валюта по умолчанию

isManualOpportunity
boolean

Режим расчета суммы. Возможные значения:

  • Y — ручной
  • N — автоматический

Доступно только при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса.

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

opportunity
double

Сумма.

Доступно только при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса.

По умолчанию — null

taxValue
double

Сумма налога.

Доступно только при включенной настройке isLinkWithProductsEnabled у соответствующего смарт-процесса.

По умолчанию — null

mycompanyId
crm_company

Идентификатор моей компании.

Доступно только при включенной настройке isMycompanyEnabled у соответствующего смарт-процесса.

По умолчанию — идентификатор первой доступной «моей» компании

ufCrm...
crm_userfield

Пользовательское поле. Смотрите раздел Пользовательские поля в CRM: обзор методов.

  • Значения множественных полей передаются в виде массива
  • Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла.

parentId...
crm_entity

Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу.

Каждое такое поле имеет код parentId + {parentEntityTypeId}

Подробнее об управлении настройками смарт-процессов читайте в статье Смарт-процессы: обзор методов и событий

Чтобы загрузить файл, в качестве значения пользовательского поля необходимо передать массив, где первый элемент — это имя файла, а второй — это закодированный в base64 контент файла.

Примеры кода

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

  1. Как импортировать сделку

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"fields":{"title":"Новая сделка","typeId":"SERVICE","isRecurring":"Y","opportunity":999.99,"currencyId":"RUB"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.import

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"fields":{"title":"Новая сделка","typeId":"SERVICE","isRecurring":"Y","opportunity":999.99,"currencyId":"RUB"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.import

    import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

const response = await $b24.actions.v2.call.make({
  method: 'crm.item.import',
  params: {
    entityTypeId: 2,
    fields: {
      title: 'Новая сделка',
      typeId: 'SERVICE',
      isRecurring: 'Y',
      opportunity: 999.99,
      currencyId: 'RUB',
    },
  },
  requestId: Text.getUuidRfc4122()
})

if (!response.isSuccess) {
  console.error(response.getErrorMessages().join('; '))
} else {
  console.info(response.getData()!.result)
}

    <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function importDeal() {
    const $b24 = await B24Js.initializeB24Frame()
    const response = await $b24.actions.v2.call.make({
      method: 'crm.item.import',
      params: {
        entityTypeId: 2,
        fields: {
          title: 'Новая сделка',
          typeId: 'SERVICE',
          isRecurring: 'Y',
          opportunity: 999.99,
          currencyId: 'RUB',
        },
      },
      requestId: B24Js.Text.getUuidRfc4122()
    })

    if (!response.isSuccess) {
      console.error(response.getErrorMessages().join('; '))
      return
    }
    console.info(response.getData().result)
  }

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

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.item.import_(
        entity_type_id=2,
        fields={
            "title": "Новая сделка",
            "typeId": "SERVICE",
            "isRecurring": "Y",
            "opportunity": 999.99,
            "currencyId": "RUB",
        },
    ).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.item.import',
        [
            'entityTypeId' => 2,
            'fields' => [
                'title' => 'Новая сделка',
                'typeId' => 'SERVICE',
                'isRecurring' => 'Y',
                'opportunity' => 999.99,
                'currencyId' => 'RUB',
            ],
        ]
    );

    $result = $response->getResponseData()->getResult();
    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error importing CRM item: ' . $e->getMessage();
}

    BX24.callMethod(
    'crm.item.import', 
    {
        entityTypeId: 2,
        fields: 
        {
            title: "Новая сделка",
            typeId: "SERVICE",
            isRecurring: "Y",
            opportunity: 999.99,
            currencyId: "RUB",
        },
    },
    (result) =>
    {
        result.error() 
            ? console.error(result.error()) 
            : console.info(result.data())
        ;
    }
);

    require_once('crest.php');

$result = CRest::call(
    'crm.item.import',
    [
        'entityTypeId' => 2,
        'fields' => [
            'title' => "Новая сделка",
            'typeId' => "SERVICE",
            'isRecurring' => "Y",
            'opportunity' => 999.99,
            'currencyId' => "RUB",
        ],
    ]
);

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

    // client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.import", b24.Params{
    "entityTypeId": 2,
    "fields": b24.Params{
        "title":       "Новая сделка",
        "typeId":      "SERVICE",
        "isRecurring": "Y",
        "opportunity": 999.99,
        "currencyId":  "RUB",
    },
})
if err != nil {
    return fmt.Errorf("crm.item.import: %w", err)
}

raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
    return fmt.Errorf("в ответе нет ключа item")
}
fmt.Printf("%s\n", raw)

  2. Как создать элемент смарт-процесса с набором пользовательских полей

    Пользовательские поля, участвующие в примере
        {
    "ufCrm44_1721812760630": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": true,
        "title": "Пользовательское поле (строка)",
        "listLabel": "Пользовательское поле (строка)",
        "formLabel": "Пользовательское поле (строка)",
        "filterLabel": "Пользовательское поле (строка)",
        "settings": {
        "SIZE": 20,
        "ROWS": 1,
        "REGEXP": "",
        "MIN_LENGTH": 0,
        "MAX_LENGTH": 0,
        "DEFAULT_VALUE": ""
        },
        "upperName": "UF_CRM_44_1721812760630"
    },
    "ufCrm44_1721812814433": {
        "type": "enumeration",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": true,
        "items": [
        {
            "ID": "79",
            "VALUE": "Элемент списка #1"
        },
        {
            "ID": "80",
            "VALUE": "Элемент списка #2"
        },
        {
            "ID": "81",
            "VALUE": "Элемент списка #3"
        },
        {
            "ID": "82",
            "VALUE": "Элемент списка #4"
        }
        ],
        "title": "Пользовательское поле (список)",
        "listLabel": "Пользовательское поле (список)",
        "formLabel": "Пользовательское поле (список)",
        "filterLabel": "Пользовательское поле (список)",
        "settings": {
        "DISPLAY": "LIST",
        "LIST_HEIGHT": 1,
        "CAPTION_NO_VALUE": "",
        "SHOW_NO_VALUE": "Y"
        },
        "upperName": "UF_CRM_44_1721812814433"
    },
    "ufCrm44_1721812853419": {
        "type": "date",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": true,
        "title": "Пользовательское поле (дата)",
        "listLabel": "Пользовательское поле (дата)",
        "formLabel": "Пользовательское поле (дата)",
        "filterLabel": "Пользовательское поле (дата)",
        "settings": {
        "DEFAULT_VALUE": {
            "TYPE": "NONE",
            "VALUE": ""
        }
        },
        "upperName": "UF_CRM_44_1721812853419"
    },
    "ufCrm44_1721812885588": {
        "type": "url",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": true,
        "isDynamic": true,
        "title": "Множественное пользовательское поле (ссылка)",
        "listLabel": "Множественное пользовательское поле (ссылка)",
        "formLabel": "Множественное пользовательское поле (ссылка)",
        "filterLabel": "Множественное пользовательское поле (ссылка)",
        "settings": {
        "POPUP": "Y",
        "SIZE": 20,
        "MIN_LENGTH": 0,
        "MAX_LENGTH": 0,
        "DEFAULT_VALUE": "",
        "ROWS": 1
        },
        "upperName": "UF_CRM_44_1721812885588"
    },
    "ufCrm44_1721812898903": {
        "type": "file",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": true,
        "title": "Пользовательское поле (файл)",
        "listLabel": "Пользовательское поле (файл)",
        "formLabel": "Пользовательское поле (файл)",
        "filterLabel": "Пользовательское поле (файл)",
        "settings": {
        "SIZE": 20,
        "LIST_WIDTH": 0,
        "LIST_HEIGHT": 0,
        "MAX_SHOW_SIZE": 0,
        "MAX_ALLOWED_SIZE": 0,
        "EXTENSIONS": [],
        "TARGET_BLANK": "Y"
        },
        "upperName": "UF_CRM_44_1721812898903"
    },
    "ufCrm44_1721812915476": {
        "type": "money",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": true,
        "title": "Пользовательское поле (деньги)",
        "listLabel": "Пользовательское поле (деньги)",
        "formLabel": "Пользовательское поле (деньги)",
        "filterLabel": "Пользовательское поле (деньги)",
        "settings": {
        "DEFAULT_VALUE": ""
        },
        "upperName": "UF_CRM_44_1721812915476"
    },
    "ufCrm44_1721812935209": {
        "type": "boolean",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": true,
        "title": "Пользовательское поле (Да/Нет)",
        "listLabel": "Пользовательское поле (Да/Нет)",
        "formLabel": "Пользовательское поле (Да/Нет)",
        "filterLabel": "Пользовательское поле (Да/Нет)",
        "settings": {
        "DEFAULT_VALUE": 0,
        "DISPLAY": "CHECKBOX",
        "LABEL": [
            "",
            ""
        ],
        "LABEL_CHECKBOX": {
            "en": "Пользовательское поле (Да/Нет)",
            "ru": "Пользовательское поле (Да/Нет)",
            "th": "Пользовательское поле (Да/Нет)",
            "la": "Пользовательское поле (Да/Нет)",
            "tc": "Пользовательское поле (Да/Нет)",
            "sc": "Пользовательское поле (Да/Нет)",
            "br": "Пользовательское поле (Да/Нет)",
            "ar": "Пользовательское поле (Да/Нет)",
            "fr": "Пользовательское поле (Да/Нет)",
            "vn": "Пользовательское поле (Да/Нет)",
            "pl": "Пользовательское поле (Да/Нет)",
            "tr": "Пользовательское поле (Да/Нет)",
            "ja": "Пользовательское поле (Да/Нет)",
            "it": "Пользовательское поле (Да/Нет)",
            "ms": "Пользовательское поле (Да/Нет)",
            "id": "Пользовательское поле (Да/Нет)"
        }
        },
        "upperName": "UF_CRM_44_1721812935209"
    },
    "ufCrm44_1721812948498": {
        "type": "double",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": true,
        "title": "Пользовательское поле (число)",
        "listLabel": "Пользовательское поле (число)",
        "formLabel": "Пользовательское поле (число)",
        "filterLabel": "Пользовательское поле (число)",
        "settings": {
        "PRECISION": 2,
        "SIZE": 20,
        "MIN_VALUE": 0,
        "MAX_VALUE": 0,
        "DEFAULT_VALUE": null
        },
        "upperName": "UF_CRM_44_1721812948498"
    }
}

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "entityTypeId": 1302,
    "fields": {
        "ufCrm44_1721812760630": "Строка для пользовательского поля типа Строка",
        "ufCrm44_1721812814433": 81,
        "ufCrm44_1721812853419": "2024-08-21",
        "ufCrm44_1721812885588": [
            "example.com",
            "second-example.com"
        ],
        "ufCrm44_1721812898903": [
            "green_pixel.png",
            "iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg=="
        ],
        "ufCrm44_1721812915476": "300|RUB",
        "ufCrm44_1721812935209": "Y",
        "ufCrm44_1721812948498": 9999.9
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.import

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "entityTypeId": 1302,
    "fields": {
        "ufCrm44_1721812760630": "Строка для пользовательского поля типа Строка",
        "ufCrm44_1721812814433": 81,
        "ufCrm44_1721812853419": "2024-08-21",
        "ufCrm44_1721812885588": [
            "example.com",
            "second-example.com"
        ],
        "ufCrm44_1721812898903": [
            "green_pixel.png",
            "iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg=="
        ],
        "ufCrm44_1721812915476": "300|RUB",
        "ufCrm44_1721812935209": "Y",
        "ufCrm44_1721812948498": 9999.9
    },
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/crm.item.import

    import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame

const response = await $b24.actions.v2.call.make({
  method: 'crm.item.import',
  params: {
    entityTypeId: 1302,
    fields: {
      ufCrm44_1721812760630: 'Строка для пользовательского поля типа Строка',
      ufCrm44_1721812814433: 81,
      ufCrm44_1721812853419: '2024-08-21',
      ufCrm44_1721812885588: ['example.com', 'second-example.com'],
      ufCrm44_1721812898903: ['green_pixel.png', 'iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg=='],
      ufCrm44_1721812915476: '300|RUB',
      ufCrm44_1721812935209: 'Y',
      ufCrm44_1721812948498: 9999.9,
    },
  },
  requestId: Text.getUuidRfc4122()
})
console.info(response.getData()?.result)

    <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function importSmartProcessItem() {
    const $b24 = await B24Js.initializeB24Frame()
    const response = await $b24.actions.v2.call.make({
      method: 'crm.item.import',
      params: {
        entityTypeId: 1302,
        fields: {
          ufCrm44_1721812760630: 'Строка для пользовательского поля типа Строка',
          ufCrm44_1721812814433: 81,
          ufCrm44_1721812853419: '2024-08-21',
          ufCrm44_1721812885588: ['example.com', 'second-example.com'],
          ufCrm44_1721812898903: ['green_pixel.png', 'iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg=='],
          ufCrm44_1721812915476: '300|RUB',
          ufCrm44_1721812935209: 'Y',
          ufCrm44_1721812948498: 9999.9,
        },
      },
      requestId: B24Js.Text.getUuidRfc4122()
    })
    console.info(response.getData()?.result)
  }
  document.addEventListener('DOMContentLoaded', importSmartProcessItem)
</script>

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.item.import_(
        entity_type_id=1302,
        fields={
            "ufCrm44_1721812760630": "Строка для пользовательского поля типа Строка",
            "ufCrm44_1721812814433": 81,
            "ufCrm44_1721812853419": "2024-08-21",
            "ufCrm44_1721812885588": [
                "example.com",
                "second-example.com",
            ],
            "ufCrm44_1721812898903": [
                "green_pixel.png",
                "iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg==",
            ],
            "ufCrm44_1721812915476": "300|RUB",
            "ufCrm44_1721812935209": "Y",
            "ufCrm44_1721812948498": 9999.9,
        },
    ).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.item.import',
        [
            'entityTypeId' => 1302,
            'fields' => [
                'ufCrm44_1721812760630' => 'Строка для пользовательского поля типа Строка',
                'ufCrm44_1721812814433' => 81,
                'ufCrm44_1721812853419' => '2024-08-21',
                'ufCrm44_1721812885588' => ['example.com', 'second-example.com'],
                'ufCrm44_1721812898903' => ['green_pixel.png', 'iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg=='],
                'ufCrm44_1721812915476' => '300|RUB',
                'ufCrm44_1721812935209' => 'Y',
                'ufCrm44_1721812948498' => 9999.9,
            ],
        ]
    );
    echo 'Success: ' . print_r($response->getResponseData()->getResult()->data(), true);
} catch (Throwable $e) {
    echo 'Error: ' . $e->getMessage();
}

    const greenPixelInBase64 = "iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg==";

BX24.callMethod(
    'crm.item.import',
    {
        entityTypeId: 1302,
        fields: {
            ufCrm44_1721812760630: "Строка для пользовательского поля типа Строка",
            ufCrm44_1721812814433: 81,
            ufCrm44_1721812853419: "2024-08-21",
            ufCrm44_1721812885588: [
                "example.com",
                "second-example.com",
            ],
            ufCrm44_1721812898903: [
                "green_pixel.png",
                greenPixelInBase64,
            ],
            ufCrm44_1721812915476: "300|RUB",
            ufCrm44_1721812935209: "Y",
            ufCrm44_1721812948498: 9999.9,
        },
    },
    (result) =>
    {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    }
);

    require_once('crest.php');

$result = CRest::call(
    'crm.item.import',
    [
        'entityTypeId' => 1302,
        'fields' => [
            'ufCrm44_1721812760630' => "Строка для пользовательского поля типа Строка",
            'ufCrm44_1721812814433' => 81,
            'ufCrm44_1721812853419' => '2024-08-21',
            'ufCrm44_1721812885588' => [
                "example.com",
                "second-example.com",
            ],
            'ufCrm44_1721812898903' => [
                "green_pixel.png",
                "iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg==",
            ],
            'ufCrm44_1721812915476' => "300|RUB",
            'ufCrm44_1721812935209' => "Y",
            'ufCrm44_1721812948498' => 9999.9,
        ],
    ]
);

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

    res, err := client.Core().Call(ctx, "crm.item.import", b24.Params{
    "entityTypeId": 1302,
    "fields": b24.Params{
        "ufCrm44_1721812760630": "Строка для пользовательского поля типа Строка",
        "ufCrm44_1721812814433": 81,
        "ufCrm44_1721812853419": "2024-08-21",
        "ufCrm44_1721812885588": []string{"example.com", "second-example.com"},
        "ufCrm44_1721812898903": []string{"green_pixel.png", "iVBORw0KGgoAAAANSUhEUgAAAIAAAAAMCAYAAACqTLVoAAAALklEQVR42u3SAQEAAAQDsEsuOj3YMqwy6fBWCSCAAAIgAAIgAAIgAAIgAAJw3QLOrRH1U/gU4gAAAABJRU5ErkJggg=="},
        "ufCrm44_1721812915476": "300|RUB",
        "ufCrm44_1721812935209": "Y",
        "ufCrm44_1721812948498": 9999.9,
    },
})
if err != nil {
    return fmt.Errorf("crm.item.import: %w", err)
}
fmt.Printf("%v\n", res.Result)

Обработка ответа

Метод возвращает объект item с идентификатором созданного элемента.

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 4
        }
    },
    "time": {
        "start": 1722940215.145257,
        "finish": 1722940217.94124,
        "duration": 2.795983076095581,
        "processing": 2.4315829277038574,
        "date_start": "2024-08-06T10:30:15+00:00",
        "date_finish": "2024-08-06T10:30:17+00:00",
        "operating": 2.4314892292022705
    }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит объект с результатом импорта (подробное описание)

time
time

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

Объект result

Название
тип

Описание

item
object

Результат импорта (подробное описание)

Объект item

Название
тип

Описание

id
integer

Идентификатор созданного элемента

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

HTTP-статус: 400, 401, 403

{
    "error": "NOT_FOUND",
    "error_description": "Смарт-процесс не найден"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

NOT_FOUND

Смарт-процесс не найден

Передан неизвестный entityTypeId

400

ACCESS_DENIED

Доступ запрещен

У пользователя нет права на импорт элементов типа entityTypeId

400

CRM_FIELD_ERROR_VALUE_NOT_VALID

Неверное значение поля field

Передано недопустимое значение поля field.

Для системных полей, например createdTime, ошибка также возникает, если запрос выполняет не администратор

400

100

Expected iterable value for multiple field, but got type instead

В одно из множественных полей передано значение типа type, хотя ожидалось перебираемое значение. Ошибка также может возникнуть из-за некорректного JSON или заголовков запроса

400

CREATE_DYNAMIC_ITEM_RESTRICTED

Вы не можете создать новый элемент из-за ограничений вашего тарифа

Ограничения тарифа не позволяют создавать элементы смарт-процессов

401

INVALID_CREDENTIALS

Неверные данные авторизации для запроса

Неверный идентификатор пользователя или код вебхука в URL запроса

403

allowed_only_intranet_user

Действие разрешено только интранет-пользователям

Пользователь не является интранет-пользователем

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

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

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

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

Предыдущая
Импорт
Следующая
Импортировать группу записей