For AI agents: markdown of this page — /docs-content-en/entities/booking-wait-list/booking.md documentation index — /llms.txt

Book from the wait list

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

Creates a booking from a wait list record: the record's clients move to the new booking, and the record itself is removed from the wait list.

Fields go at the root of the JSON, without a fields wrapper. Messages to the client about the booking depend on the is*NotificationOn switches of the booking resource.

Parameters

Parameter	Type	Required	Description
`id` (path)	number	yes	Wait list record identifier. List: `GET /v1/booking-wait-list`

Request fields (body)

Field	Type	Required	Description
`resourceIds`	number[]	yes	Identifiers of the resources the booking reserves. The array cannot be empty. List: `GET /v1/booking-resources`
`datePeriod.from.timestamp`	number	yes	Booking start, Unix time in seconds
`datePeriod.from.timezone`	string	yes	Time zone of the start in IANA format, e.g. `UTC`
`datePeriod.to.timestamp`	number	yes	Booking end, Unix time in seconds. Must be later than the start
`datePeriod.to.timezone`	string	yes	Time zone of the end in IANA format

The body accepts no other fields. The booking name and description are set by updating the booking.

Examples

curl — personal key

Terminal

curl -X POST "https://vibecode.bitrix24.com/v1/booking-wait-list/27/booking" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resourceIds": [49],
    "datePeriod": {
      "from": { "timestamp": 1795158000, "timezone": "UTC" },
      "to": { "timestamp": 1795161600, "timezone": "UTC" }
    }
  }'

curl — OAuth application

Terminal

curl -X POST "https://vibecode.bitrix24.com/v1/booking-wait-list/27/booking" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resourceIds": [49],
    "datePeriod": {
      "from": { "timestamp": 1795158000, "timezone": "UTC" },
      "to": { "timestamp": 1795161600, "timezone": "UTC" }
    }
  }'

JavaScript — personal key

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/booking-wait-list/27/booking', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    resourceIds: [49],
    datePeriod: {
      from: { timestamp: 1795158000, timezone: 'UTC' },
      to: { timestamp: 1795161600, timezone: 'UTC' },
    },
  }),
})

const { data } = await res.json()
console.log('Booking ID:', data.id)

JavaScript — OAuth application

javascript

const res = await fetch('https://vibecode.bitrix24.com/v1/booking-wait-list/27/booking', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    resourceIds: [49],
    datePeriod: {
      from: { timestamp: 1795158000, timezone: 'UTC' },
      to: { timestamp: 1795161600, timezone: 'UTC' },
    },
  }),
})

const { data } = await res.json()
console.log('Booking ID:', data.id)

Response fields

On success, the HTTP status is 201 Created and the response contains the card of the new booking — the same as GET /v1/bookings/:id returns.

Field	Type	Description
`success`	boolean	`true` on success
`data.id`	number	Booking identifier. The booking's clients are returned by `GET /v1/bookings/:id/clients`
`data.name`	string \| null	Booking name
`data.description`	string \| null	Booking description
`data.resourceIds`	number[]	Identifiers of the reserved resources
`data.datePeriod`	object	Booking period: `from` and `to`, each with `timestamp` and `timezone`

Response example

JSON

{
  "success": true,
  "data": {
    "datePeriod": {
      "from": {
        "timestamp": 1795158000,
        "timezone": "UTC"
      },
      "to": {
        "timestamp": 1795161600,
        "timezone": "UTC"
      }
    },
    "description": null,
    "id": 49,
    "name": null,
    "resourceIds": [
      49
    ]
  }
}

Error response example

404 — there is no wait list record with this id, for example because it has already been moved to a booking: