Для AI-агентов: markdown этой страницы — /docs-content/entities/booking-wait-list/clients-delete.md индекс документации — /llms.txt

Снять клиентов записи листа ожидания

DELETE /v1/booking-wait-list/:id/clients

Снимает с записи листа ожидания всех клиентов одним вызовом. Контакты и компании остаются в CRM.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID записи листа ожидания. Список: GET /v1/booking-wait-list

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/booking-wait-list/37/clients" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/booking-wait-list/37/clients" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/booking-wait-list/37/clients', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Клиенты записи после снятия:', data)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/booking-wait-list/37/clients', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

В ответе — клиенты записи листа ожидания, заново прочитанные после снятия.

Поле Тип Описание
success boolean true при успехе
data array Клиенты записи после снятия
data[].id number ID контакта или компании CRM
data[].type.code string Код типа клиента: CONTACT — контакт, COMPANY — компания
data[].type.module string Модуль типа клиента: crm

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

JSON 
{
  "success": true,
  "data": []
}

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

404 — записи листа ожидания с таким id нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Booking record not found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Записи листа ожидания с таким id нет. Сообщение Booking record not found
400 INVALID_PARAMS id — не целое положительное число. Сообщение id must be a canonical positive safe integer
401 MISSING_API_KEY Не передан X-Api-Key
401 TOKEN_MISSING У ключа нет токенов Битрикс24
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения. Запрос отклоняется до обращения к порталу
403 SCOPE_DENIED У ключа нет скоупа booking
429 RATE_LIMITED Превышена частота запросов. Действующий потолок — в заголовке x-ratelimit-limit
502 BITRIX_RESPONSE_INVALID Bitrix24 did not confirm the booking operation — Битрикс24 не подтвердил снятие
502 BITRIX_RESPONSE_INVALID Bitrix24 returned an unexpected booking response — Битрикс24 вернул список клиентов неожиданной формы

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

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