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

Изменить запись

PATCH /v1/booking-wait-list/:id

Изменяет заметку к записи листа ожидания — очереди клиентов, которым не нашлось свободного времени для записи.

Поля передаются в корне JSON, без обёртки fields.

Параметры

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

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

Поле Тип Обяз. Описание
note string | null нет Новая заметка. Пустая строка "" удаляет заметку. null или запрос без поля оставляют прежнюю

Других полей тело не принимает. Клиентов записи меняет PUT /v1/booking-wait-list/:id/clients.

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/booking-wait-list/27" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note": "Перезвонить после 16:00"}'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/booking-wait-list/27" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note": "Перезвонить после 16:00"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/booking-wait-list/27', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ note: 'Перезвонить после 16:00' }),
})

const { data } = await res.json()
console.log(data.note)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/booking-wait-list/27', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ note: 'Перезвонить после 16:00' }),
})

const { data } = await res.json()
console.log(data.note)

Поля ответа

Поле Тип Описание
success boolean true при успехе
data.id number Идентификатор записи
data.note string | null Заметка после изменения. null — заметки нет

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

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "note": "Перезвонить после 16:00"
  }
}

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

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 В теле поле, кроме note. Сообщение Only note can be written
400 INVALID_PARAMS note — не строка и не null. Сообщение note must be a string or null
400 INVALID_PARAMS Тело — не JSON-объект, например массив. Сообщение Body must be an object
400 INVALID_PARAMS id — не целое положительное число. Сообщение id must be a canonical positive safe integer
401 MISSING_API_KEY Не передан X-Api-Key
401 TOKEN_MISSING У ключа нет токенов Битрикс24
403 SCOPE_DENIED У ключа нет скоупа booking
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «Только чтение»
429 RATE_LIMITED Превышена частота запросов. Действующий потолок — в заголовке x-ratelimit-limit
502 BITRIX_RESPONSE_INVALID Битрикс24 не подтвердил изменение. Сообщение Bitrix24 did not confirm the booking operation
502 BITRIX_RESPONSE_INVALID Битрикс24 вернул запись неожиданной формы при перечитывании после изменения. Изменение уже сохранено — проверьте запись через получение перед повтором

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

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