Для AI-агентов: markdown этой страницы — /docs-content/mail/conversions/crm-activity-delete.md индекс документации — /llms.txt

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

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

Удаляет дело CRM, созданное из письма, и снимает привязку письма к CRM. Тело запроса не требуется — идентификатор письма берётся из пути.

Параметры

Параметр В Тип Обяз. Описание
id path integer да Идентификатор письма. Список: GET /v1/mail/messages

Примеры

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

Terminal 
curl -X DELETE \
  -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/mail/messages/123/crm-activity

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

Terminal 
curl -X DELETE \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  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: 'DELETE',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  }
)
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: 'DELETE',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const body = await res.json()

Поля ответа

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

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

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

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

400 — письмо не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Ошибка при валидации объекта запроса",
    "validation": [
      {
        "message": "Сообщение удалено или перемещено в другую папку"
      }
    ]
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Нечисловой или отрицательный :id в пути — сообщение id must be a positive integer
400 INVALID_PARAMS Письмо удалено или перемещено в другую папку. Причина — в массиве validation
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 Прочие ошибки Битрикс24
429 RATE_LIMITED Превышен лимит запросов
502 BITRIX_UNAVAILABLE Битрикс24 недоступен

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

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

  • Повторный вызов для письма, у которого дела CRM нет, возвращает тот же успешный ответ — операция идемпотентна.
  • Запись CRM, созданная вместе с делом, остаётся на портале — удаляйте её отдельно.

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