Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-emails/send.md индекс документации — /llms.txt
Отправить письмо из CRM
POST /v1/deals/:id/emails
POST /v1/leads/:id/emails
POST /v1/contacts/:id/emails
POST /v1/companies/:id/emails
Отправляет настоящее письмо из CRM от имени доступного отправителя. Письмо связывается с указанной записью CRM.
Доступность: в облаке метод доступен. Для коробочной установки требуется обновление CRM
crm 26.800.1. Без него API вернёт422 METHOD_NOT_YET_AVAILABLEс требуемым выпуском вerror.release.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрid (path) |
Типinteger | Обяз.да | ОписаниеИдентификатор записи из сделок, лидов, контактов или компаний. |
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
Полеto |
Типstring[] | Обяз.да | ОписаниеОсновные адресаты. |
Полеsubject |
Типstring or null | Обяз.нет | ОписаниеТема письма. |
Полеbody |
Типstring | Обяз.да | ОписаниеТекст письма. |
Полеcc |
Типstring[] or null | Обяз.нет | ОписаниеКопия. |
Полеbcc |
Типstring[] or null | Обяз.нет | ОписаниеСкрытая копия. |
Полеfrom |
Типstring or null | Обяз.нет | ОписаниеАдрес доступного отправителя. |
ПолеsenderId |
Типinteger or null | Обяз.нет | ОписаниеИдентификатор отправителя, принимаемый Битрикс24. |
ПолеmailboxId |
Типinteger or null | Обяз.нет | ОписаниеИдентификатор из ящиков. |
Примеры
curl — личный ключ
curl -X POST "https://vibecode.bitrix24.tech/v1/deals/741/emails" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"to": ["reader@example.com"], "body": "Hello", "subject": "Integration request"}'
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/deals/741/emails" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"to": ["reader@example.com"], "body": "Hello", "subject": "Integration request"}'
JavaScript — личный ключ
const response = await fetch('https://vibecode.bitrix24.tech/v1/deals/741/emails', {
method: 'POST',
headers: {"X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
body: JSON.stringify({"to": ["reader@example.com"], "body": "Hello", "subject": "Integration request"}),
})
const result = await response.json()
JavaScript — OAuth-приложение
const response = await fetch('https://vibecode.bitrix24.tech/v1/deals/741/emails', {
method: 'POST',
headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN", "Content-Type": "application/json"},
body: JSON.stringify({"to": ["reader@example.com"], "body": "Hello", "subject": "Integration request"}),
})
const result = await response.json()
Поля ответа
| Поле | Описание |
|---|---|
Полеdata.activityId |
ОписаниеИдентификатор созданного дела. Чтение: содержимое письма. |
Полеdata.parentActivityId |
ОписаниеИдентификатор исходного дела или null. |
Полеdata.from |
ОписаниеОтправитель. |
Полеdata.to |
ОписаниеОсновные получатели. |
Полеdata.cc |
ОписаниеПолучатели копии. |
Полеdata.bcc |
ОписаниеПолучатели скрытой копии. |
Полеdata.isSyncedToImap |
ОписаниеСохранена ли копия в подключённом ящике. |
Полеdata.warnings |
ОписаниеПредупреждения об отправке и синхронизации. |
Пример ответа
Пример структуры с нейтральными данными.
{
"success": true,
"data": {
"activityId": 1204,
"parentActivityId": null,
"from": "sender@example.com",
"to": [
"reader@example.com"
],
"cc": [],
"bcc": [],
"isSyncedToImap": false,
"warnings": []
}
}
Пример ответа при ошибке
400 — неизвестный параметр или отсутствует обязательное поле:
{
"success": false,
"error": {
"code": "MISSING_REQUIRED_FIELDS",
"message": "to and body are required"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеНекорректный тип или идентификатор. |
| HTTP400 | КодUNKNOWN_FILTER_FIELD |
ОписаниеНеизвестный параметр запроса. |
| HTTP400 | КодMISSING_REQUIRED_FIELDS |
ОписаниеНет обязательного поля тела. |
| HTTP400 | КодUNKNOWN_FIELD |
ОписаниеНеизвестное поле тела. |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеНет доступа к Битрикс24 у ключа. |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеНужен скоуп crm. |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеЗапись запрещена режимом ключа. |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеЗапись отсутствует или недоступна. |
| HTTP404 | КодCRM_EMAIL_ACTIVITY_NOT_FOUND |
ОписаниеДело электронной почты не найдено. |
| HTTP422 | КодMETHOD_NOT_YET_AVAILABLE |
ОписаниеНа портале нет метода. Требуемый выпуск указан в error.release. |
| HTTP502 | КодBITRIX_UNAVAILABLE |
ОписаниеОтвет Битрикс24 недоступен или имеет некорректную структуру. |
Другие отказы Битрикс24 сохраняют исходные код и текст. Общие ошибки API.
Известные особенности
Это письма дел CRM. Модуль почты работает с другими идентификаторами сообщений.
Не повторяйте отправку вслепую после таймаута, разрыва ответа или ошибки 502: настоящее письмо могло уйти. Сначала прочитайте список писем.