#Создать дело CRM из письма

POST /v1/mail/messages/:id/crm-activity

Создаёт дело CRM из письма.

#Параметры

Параметр В Тип Обяз. Описание
id path integer да Идентификатор письма

#Поля запроса (body)

Поле Тип Обяз. Описание
messageId integer да Идентификатор письма

#Примеры

#curl — личный ключ

Terminal 
curl -X POST \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"messageId": 123}' \
  https://vibecode.bitrix24.tech/v1/mail/messages/123/crm-activity

#curl — OAuth-приложение

Terminal 
curl -X POST \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"messageId": 123}' \
  https://vibecode.bitrix24.tech/v1/mail/messages/123/crm-activity

#JavaScript — личный ключ

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/messages/123/crm-activity',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ messageId: 123 }),
  }
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
console.log(`Дело создано: ${body.data.result}`)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/mail/messages/123/crm-activity',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ messageId: 123 }),
  }
)

#Поля ответа

Поле Тип Описание
success boolean true при успешном выполнении
data.result boolean true при успешном создании дела CRM

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "result": true
  }
}

#Пример ответа при ошибке

422 — нарушена валидация (например, не передан messageId или письмо от внутреннего сотрудника):

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Ошибка при валидации объекта запроса"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Нечисловой или отрицательный :id в пути
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY Неверный или просроченный ключ
401 KEY_INACTIVE Ключ деактивирован
401 KEY_EXPIRED Срок действия ключа истёк
401 TOKEN_MISSING Ключ не привязан к порталу Битрикс24
403 SCOPE_DENIED Ключу не хватает скоупа mail
422 BITRIX_ERROR Не передан messageId, либо письмо от внутреннего сотрудника, либо Битрикс24 отклонил запрос
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

Полный список общих ошибок API — Ошибки.

#Известные особенности

  • Дело создаётся только для писем от внешних адресатов — для писем внутренних сотрудников Битрикс24 дело не создаётся (возвращается 422). Повторный вызов для письма, у которого дело уже создано, завершается успешно (идемпотентно).
  • Идентификатор письма указывается дважды — в пути :id и в теле messageId; передавайте оба с одним значением.

#Смотрите также