#Обновить бронирование

PATCH /v1/bookings/:id

Обновляет поля существующего бронирования. Передавайте только изменяемые поля плоско в корне JSON.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор бронирования

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

Поле Тип Описание
resourceIds number[] Идентификаторы ресурсов, которые резервирует бронирование. Массив не может быть пустым. Получить список ресурсов через API Вайбкод нельзя — укажите известные идентификаторы
datePeriod object Период бронирования. Структура: from и to, у каждого — timestamp (Unix-секунды) и timezone (часовой пояс в формате IANA, например Europe/Moscow)
name string Название бронирования. Может быть null
description string Описание бронирования. Может быть null

#Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/bookings/27" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Переговорная (обновлено)",
    "description": "Изменённое описание"
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/bookings/27" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Переговорная (обновлено)",
    "description": "Изменённое описание"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bookings/27', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Переговорная (обновлено)',
    description: 'Изменённое описание',
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bookings/27', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Переговорная (обновлено)',
    description: 'Изменённое описание',
  }),
})

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

#Поля ответа

Возвращается полный объект обновлённого бронирования.

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор бронирования
data.name string | null Название бронирования
data.description string | null Описание бронирования
data.resourceIds number[] Идентификаторы зарезервированных ресурсов
data.datePeriod object Период бронирования: from и to, у каждого timestamp и timezone

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

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "name": "Переговорная (обновлено)",
    "description": "Изменённое описание",
    "resourceIds": [1],
    "datePeriod": {
      "from": { "timestamp": 1780132384, "timezone": "Europe/Moscow" },
      "to":   { "timestamp": 1780135984, "timezone": "Europe/Moscow" }
    }
  }
}

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

422 — бронирование не найдено:

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

#Ошибки

HTTP Код Описание
422 BITRIX_ERROR Бронирование с указанным id не существует. Сообщение: Booking not found
422 BITRIX_ERROR Передан пустой массив resourceIds. Сообщение: Empty resource collection
403 SCOPE_DENIED API-ключ не имеет скоупа booking
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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