Битрикс24 REST API: crm.item.add — Создать элемент CRM

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

Пример ответа (сокращён):

Параметр	Где	Тип	Обяз.	Описание
`entityTypeId`	body	integer	да	Тип объекта CRM
`fields`	body	object	да	Поля элемента; набор зависит от типа объекта
`fields.title`	body	string	нет	Название; по умолчанию по шаблону {entityTypeName} #{id}
`fields.stageId`	body	crm_status	нет	Стадия, например NEW
`fields.categoryId`	body	integer	нет	Воронка (для сделок), по умолчанию 0
`fields.typeId`	body	crm_status	нет	Тип, например SALE для сделки
`fields.opportunity`	body	double	нет	Сумма
`fields.currencyId`	body	crm_currency	нет	Валюта
`fields.assignedById`	body	user	нет	Ответственный; по умолчанию вызывающий пользователь
`fields.companyId`	body	crm_company	нет	Привязанная компания
`fields.contactIds`	body	crm_contact[]	нет	Привязанные контакты
`fields.sourceId`	body	crm_status	нет	Источник, например CALL
`fields.comments`	body	text	нет	Комментарий
`useOriginalUfNames`	body	boolean	нет	Y — оригинальные имена пользовательских полей (UF_CRM_...)

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

{
    "result": {
        "item": {
            "id": 342,
            "createdTime": "2024-07-18T14:00:14+02:00",
            "assignedById": 6,
            "categoryId": 9,
            "stageId": "C9:UC_KN8KFI",
            "title": "New deal (specifically for rest method examples)",
            "typeId": "SERVICE",
            "opportunity": 999
        }
    }
}

Базовые URL

Боевой (входящий вебхук): https://<ваш-портал>.bitrix24.ru/rest/<id пользователя>/<код вебхука>/<метод>.json
Боевой (приложение OAuth 2.0): https://<ваш-портал>.bitrix24.ru/rest/<метод>.json
Сервер авторизации OAuth: https://oauth.bitrix.info/

Авторизация

Тип: Другое

Два способа:

Входящий вебхук — постоянный секретный код в URL запроса вместе с ID пользователя, создавшего вебхук. Метод выполняется с правами этого пользователя и в рамках выбранных в настройках вебхука скоупов. Подходит для интеграции с одним порталом. Код вебхука — это пароль: не публикуйте его и не передавайте в браузерный код.
OAuth 2.0 — для локальных и тиражных приложений. Временный access_token передаётся в параметре auth; живёт один час и обновляется через https://oauth.bitrix.info/oauth/token/ с помощью refresh_token. client_secret используется только в запросах к oauth.bitrix.info.

Без данных авторизации запрос отклоняется с ошибкой NO_AUTH_FOUND.

curl -X POST \
-H "Content-Type: application/json" \
-d '{
	"entityTypeId": 2,
	"fields": {
		"title": "New Deal",
		"typeId": "SALE",
		"stageId": "NEW"
	}
}' \
https://your-domain.bitrix24.com/rest/1/8g9l071eismy9q2l/crm.item.add.json

Нюансы

Методы crm.deal.*, crm.lead.* и аналогичные больше не развиваются; для новых интеграций используйте crm.item.*.
Ошибку распознают по полям ответа, а не по HTTP-статусу: подзапросы batch с ошибкой приходят со статусом 200, а поле error может быть пустым — тогда причина только в error_description.
В ответе batch поле result.result_error есть всегда; признак ошибки — непустое содержимое.
Методы *.list отдают по 50 записей; для больших выгрузок используйте пагинацию без подсчёта общего количества и batch.
Некоторые методы (например placement.bind, event.bind) недоступны вебхуку и возвращают WRONG_AUTH_TYPE.
Несколько приложений с одного сервера к одному порталу делят общий лимит частоты запросов — лимит учитывает IP-адрес источника.
Запрос по http вместо https вернёт INVALID_REQUEST.
У Битрикс24 есть MCP-сервер b24-dev-mcp для AI-инструментов: он даёт доступ к официальной документации REST API (без доступа к данным портала).

Сценарии с этим методом

Если этого недостаточно — официальная документация: https://apidocs.bitrix24.ru/ Вся интеграция одним документом: https://mcp-everything.ru/integrations/bitrix24.md