[{"data":1,"prerenderedAt":16},["ShallowReactive",2],{"docs-entities\u002Fbooking-wait-list":3,"docs-tabs-entities\u002Fbooking-wait-list":6},{"content":4,"lastmod":5},"# Booking wait list\n\nThe wait list is a queue of clients for whom no free time slot was available for a booking. When time frees up, a wait list record becomes a booking, and a booking can be moved back to the list.\n\nBitrix24 API: `booking.v1.waitList.*`, `booking.v1.booking.createFromWaitList`\nScope: `booking`\n\n## Operations\n\n- [Create an entry](.\u002Fbooking-wait-list\u002Fcreate.md) — `POST \u002Fv1\u002Fbooking-wait-list`\n- [List booking wait list records](.\u002Fbooking-wait-list\u002Flist.md) — `GET \u002Fv1\u002Fbooking-wait-list`\n- [Get an entry](.\u002Fbooking-wait-list\u002Fget.md) — `GET \u002Fv1\u002Fbooking-wait-list\u002F:id`\n- [Update an entry](.\u002Fbooking-wait-list\u002Fupdate.md) — `PATCH \u002Fv1\u002Fbooking-wait-list\u002F:id`\n- [Delete an entry](.\u002Fbooking-wait-list\u002Fdelete.md) — `DELETE \u002Fv1\u002Fbooking-wait-list\u002F:id`\n- [List clients of a wait list record](.\u002Fbooking-wait-list\u002Fclients-list.md) — `GET \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`\n- [Replace clients of a wait list record](.\u002Fbooking-wait-list\u002Fclients-set.md) — `PUT \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`\n- [Remove clients from a wait list record](.\u002Fbooking-wait-list\u002Fclients-delete.md) — `DELETE \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`\n- [Book from the wait list](.\u002Fbooking-wait-list\u002Fbooking.md) — `POST \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fbooking`\n\n## Key fields\n\n| Field | Description |\n|------|----------|\n| `id` | Wait list record identifier. List: [`GET \u002Fv1\u002Fbooking-wait-list`](.\u002Fbooking-wait-list\u002Flist.md). Used in the path of the record methods, its client methods and the method that creates a booking from it |\n| `note` | Note on the record: a string or `null`. The only field accepted when creating or updating a record |\n| `clients` | Clients of the record — CRM contacts and companies. Read and written by separate methods: [Wait list clients](.\u002Fbooking-wait-list\u002Fclients.md) |\n| `resourceIds` | Identifiers of the resources that a booking created from the record reserves. List: [`GET \u002Fv1\u002Fbooking-resources`](\u002Fdocs\u002Fentities\u002Fbooking-resources\u002Flist) |\n| `datePeriod` | Time of the booking created from the record: `from` and `to`, each with `timestamp` in Unix seconds and `timezone` in IANA format |\n\nA wait list record consists of two fields — `id` and `note`. Record example — [Get an entry](.\u002Fbooking-wait-list\u002Fget.md).\n\n## What to know before you start\n\n1. **A record stores only a note.** Create and update accept a single field, `note`. Any other field in the body is rejected with `400 INVALID_PARAMS`. Resources and time are set later, when a booking is created from the record: [Book from the wait list](.\u002Fbooking-wait-list\u002Fbooking.md).\n2. **Clients go through separate requests.** The record and the list do not contain clients. Clients are written by [`PUT \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](.\u002Fbooking-wait-list\u002Fclients-set.md) and read by [`GET \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](.\u002Fbooking-wait-list\u002Fclients-list.md).\n3. **An empty string deletes the note.** `note: null` or a body without `note` keeps the existing note. To delete the note, pass `note: \"\"`.\n4. **A booking from a record deletes the record.** [`POST \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fbooking`](.\u002Fbooking-wait-list\u002Fbooking.md) creates a booking with the record's clients and deletes the record from the list. A request rejected with `400` or `422` does not delete the record. The reverse transfer, [`POST \u002Fv1\u002Fbookings\u002F:id\u002Fwait-list`](\u002Fdocs\u002Fentities\u002Fbookings\u002Fwait-list), deletes the booking and creates a new record in the list with its own `id`.\n5. **Client messages follow the resource settings.** Whether a booking created from a record sends a message to the client depends on the `is*NotificationOn` switches of the [booking resource](\u002Fdocs\u002Fentities\u002Fbooking-resources\u002Fget).\n6. **A read-only key can read the list.** The list, the record and its clients are available to it. Creating, updating and deleting a record, replacing and removing clients, creating a booking from a record and the reverse transfer are rejected with `403 WRITE_BLOCKED_READONLY_KEY`.\n\n## Typical scenario\n\n1. Put the client in the queue — create a record with a note: [`POST \u002Fv1\u002Fbooking-wait-list`](.\u002Fbooking-wait-list\u002Fcreate.md).\n2. Find a contact or company — [`GET \u002Fv1\u002Fcontacts`](\u002Fdocs\u002Fentities\u002Fcontacts\u002Flist), [`GET \u002Fv1\u002Fcompanies`](\u002Fdocs\u002Fentities\u002Fcompanies\u002Flist) — and set them as the record's clients: [`PUT \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](.\u002Fbooking-wait-list\u002Fclients-set.md).\n3. Review the queue: [`GET \u002Fv1\u002Fbooking-wait-list`](.\u002Fbooking-wait-list\u002Flist.md).\n4. When time frees up, find a resource — [`GET \u002Fv1\u002Fbooking-resources`](\u002Fdocs\u002Fentities\u002Fbooking-resources\u002Flist) — and create a booking from the record: [`POST \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fbooking`](.\u002Fbooking-wait-list\u002Fbooking.md).\n5. If the client declines the booking, move it back to the list: [`POST \u002Fv1\u002Fbookings\u002F:id\u002Fwait-list`](\u002Fdocs\u002Fentities\u002Fbookings\u002Fwait-list). If the record is no longer needed, delete it: [`DELETE \u002Fv1\u002Fbooking-wait-list\u002F:id`](.\u002Fbooking-wait-list\u002Fdelete.md).\n\n## Limits\n\n| Limit | Value |\n|-------|----------|\n| Records in a list response | up to 5000. If there are more records, the list responds with `502 BITRIX_RESULT_TOO_LARGE` |\n| Pagination | none: the list comes back whole; `limit`, `offset` and `order` are rejected with `400 INVALID_PARAMS` |\n| Filtering | none: `filter[createdWithin]` is rejected with `422 BITRIX_ERROR`, and other `filter` fields with `400 INVALID_PARAMS` |\n| Request rate | general API limits — [Limits and optimization](\u002Fdocs\u002Foptimization) |\n\n## See also\n\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Move a booking to the wait list](\u002Fdocs\u002Fentities\u002Fbookings\u002Fwait-list)\n- [Booking client types](\u002Fdocs\u002Fentities\u002Fbooking-client-types)\n- [Bookings](\u002Fdocs\u002Fentities\u002Fbookings)\n- [Booking resources](\u002Fdocs\u002Fentities\u002Fbooking-resources)\n- [Errors](\u002Fdocs\u002Ferrors)\n- [Limits and optimization](\u002Fdocs\u002Foptimization)\n","2026-10-15",{"booking-wait-list\u002Fcreate.md":7,"booking-wait-list\u002Flist.md":8,"booking-wait-list\u002Fget.md":9,"booking-wait-list\u002Fupdate.md":10,"booking-wait-list\u002Fdelete.md":11,"booking-wait-list\u002Fclients-list.md":12,"booking-wait-list\u002Fclients-set.md":13,"booking-wait-list\u002Fclients-delete.md":14,"booking-wait-list\u002Fbooking.md":15},"# Create an entry\n\n`POST \u002Fv1\u002Fbooking-wait-list`\n\nAdds a record to the wait list — the queue of clients for whom no free time slot was available to book.\n\nFields go at the root of the JSON, without a `fields` wrapper.\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|----------|\n| `note` | string \\| null | no | Note on the record. If the field is omitted or `null`, the record is created without a note |\n\nThe body accepts no other fields. The record's clients are set by a separate [`PUT \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients) request after creation.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"note\": \"Call back after 15:00\"}'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"note\": \"Call back after 15:00\"}'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ note: 'Call back after 15:00' }),\n})\n\nconst { data } = await res.json()\nconsole.log('Record ID:', data.id)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ note: 'Call back after 15:00' }),\n})\n\nconst { data } = await res.json()\nconsole.log('Record ID:', data.id)\n```\n\n## Response fields\n\nOn success, the HTTP status is `201 Created`.\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data.id` | number | Identifier of the created record. Pass it in the path of requests to the record, for example [`PUT \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients) |\n| `data.note` | string \\| null | Note on the record. `null` — no note |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 27,\n    \"note\": \"Call back after 15:00\"\n  }\n}\n```\n\n## Error response example\n\n400 — the body contains a field other than `note`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Only note can be written\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_PARAMS` | The body contains a field other than `note`. Message `Only note can be written` |\n| 400 | `INVALID_PARAMS` | `note` is neither a string nor `null`. Message `note must be a string or null` |\n| 400 | `INVALID_PARAMS` | The body is not a JSON object, for example an array. Message `Body must be an object` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is in read-only mode |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned a response of an unexpected shape. If this happened while re-reading the record after creation, the record has already been created — find it in the [list](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) before retrying |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [List wait list records](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist)\n- [Update a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fupdate)\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Book from the wait list](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fbooking)\n- [Errors](\u002Fdocs\u002Ferrors)\n","# List booking wait list records\n\n`GET \u002Fv1\u002Fbooking-wait-list`\n\nReturns all wait list records — the queue of clients for whom no free booking slot was found.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `filter[createdWithin][from]` (query) | string | no | Start of the record creation date range. Passed together with `filter[createdWithin][to]`. Bitrix24 rejects the filter with `422 BITRIX_ERROR` — see \"Known specifics\" |\n| `filter[createdWithin][to]` (query) | string | no | End of the record creation date range. Passed together with `filter[createdWithin][from]`. Bitrix24 rejects the filter with `422 BITRIX_ERROR` — see \"Known specifics\" |\n\n**Pagination.** There is no paging: the list returns all records in one response, up to 5000. The `limit`, `offset` and `order` parameters are not accepted — a request with them is rejected with `400 INVALID_PARAMS`.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\n\nconst { data, meta } = await res.json()\nconsole.log(meta.total, data.map((item) => item.note))\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { data, meta } = await res.json()\nconsole.log(meta.total, data.map((item) => item.note))\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data` | array | Array of wait list records |\n| `data[].id` | number | Record identifier |\n| `data[].note` | string \\| null | Note on the record. `null` — no note |\n| `meta.total` | number | Number of records in the response |\n| `meta.hasMore` | boolean | Always `false`: the list is returned in full |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 5,\n      \"note\": null\n    },\n    {\n      \"id\": 27,\n      \"note\": \"Call back after 16:00\"\n    },\n    {\n      \"id\": 29,\n      \"note\": null\n    }\n  ],\n  \"meta\": {\n    \"total\": 3,\n    \"hasMore\": false\n  }\n}\n```\n\n## Error response example\n\n400 — the request contains the `limit` parameter:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Only filter is supported; Bitrix24 ignores order\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_PARAMS` | A parameter other than `filter` is passed, for example `limit`, `offset` or `order`. Message `Only filter is supported; Bitrix24 ignores order` |\n| 400 | `INVALID_PARAMS` | `filter` contains a field other than `createdWithin`. Message `Only createdWithin is supported; Bitrix24 ignores other wait list filters` |\n| 400 | `INVALID_PARAMS` | `filter` is neither an object nor a JSON-encoded object. Message `filter must be an object` |\n| 400 | `INVALID_PARAMS` | `filter[createdWithin]` lacks `from` or `to`. Message `createdWithin requires from and to date strings` |\n| 422 | `BITRIX_ERROR` | `filter[createdWithin]` is passed. Message `Invalid date` — see \"Known specifics\" |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESULT_TOO_LARGE` | The wait list holds more than 5000 records. Message `Narrow the wait list filter; more than 5000 records matched` |\n| 502 | `BITRIX_PAGINATION_INCOMPLETE` | While the list was being collected, the wait list records shifted and one record was returned twice. Message `Bitrix24 wait list pagination did not progress`. Retry the request |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned a list of an unexpected shape |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**Filtering by creation date does not work.** Bitrix24 rejects `filter[createdWithin]` with `422 BITRIX_ERROR` and the message `Invalid date` for any date format. Request the list without `filter`: the response contains all wait list records.\n\n**Record clients come from a separate request.** The list does not include the clients of the records. They are returned by [`GET \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients).\n\n## See also\n\n- [Get a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fget)\n- [Create a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fcreate)\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Booking wait list](\u002Fdocs\u002Fentities\u002Fbooking-wait-list)\n- [Errors](\u002Fdocs\u002Ferrors)\n","# Get an entry\n\n`GET \u002Fv1\u002Fbooking-wait-list\u002F:id`\n\nReturns a wait list record by its identifier — the record number and its note.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `id` (path) | number | yes | Record identifier. List: [`GET \u002Fv1\u002Fbooking-wait-list`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\n\nconst { data } = await res.json()\nconsole.log(data.id, data.note)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { data } = await res.json()\nconsole.log(data.id, data.note)\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data.id` | number | Record identifier |\n| `data.note` | string \\| null | Note on the record. `null` — no note |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 27,\n    \"note\": \"Call back after 15:00\"\n  }\n}\n```\n\n## Error response example\n\n404 — no record with this `id`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Booking record not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 404 | `ENTITY_NOT_FOUND` | No record with this `id`, including one that was deleted or moved to a booking. Message `Booking record not found` |\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer. Message `id must be a canonical positive safe integer` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 429 | `RATE_LIMITED` | Bitrix24 refused the request because its own rate limit was reached. Retry after the delay in the `Retry-After` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned a record of an unexpected shape |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**Record clients come from a separate request.** The record does not include its clients. They are returned by [`GET \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients).\n\n## See also\n\n- [List wait list records](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist)\n- [Update a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fupdate)\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Book from the wait list](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fbooking)\n- [Errors](\u002Fdocs\u002Ferrors)\n","# Update an entry\n\n`PATCH \u002Fv1\u002Fbooking-wait-list\u002F:id`\n\nChanges the note of a wait list record. The wait list is the queue of clients for whom no free time slot was available to book.\n\nFields go at the root of the JSON, without a `fields` wrapper.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `id` (path) | number | yes | Record identifier. List: [`GET \u002Fv1\u002Fbooking-wait-list`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) |\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|----------|\n| `note` | string \\| null | no | New note. An empty string `\"\"` removes the note. `null` or omitting the field keeps the current note |\n\nThe body accepts no other fields. To change the record's clients, use [`PUT \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients).\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"note\": \"Call back after 16:00\"}'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X PATCH \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"note\": \"Call back after 16:00\"}'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ note: 'Call back after 16:00' }),\n})\n\nconst { data } = await res.json()\nconsole.log(data.note)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27', {\n  method: 'PATCH',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({ note: 'Call back after 16:00' }),\n})\n\nconst { data } = await res.json()\nconsole.log(data.note)\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data.id` | number | Record identifier |\n| `data.note` | string \\| null | Note after the update. `null` — no note |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 27,\n    \"note\": \"Call back after 16:00\"\n  }\n}\n```\n\n## Error response example\n\n404 — there is no record with this `id`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Booking record not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 404 | `ENTITY_NOT_FOUND` | There is no record with this `id`. Message `Booking record not found` |\n| 400 | `INVALID_PARAMS` | The body contains a field other than `note`. Message `Only note can be written` |\n| 400 | `INVALID_PARAMS` | `note` is neither a string nor `null`. Message `note must be a string or null` |\n| 400 | `INVALID_PARAMS` | The body is not a JSON object, for example an array. Message `Body must be an object` |\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer. Message `id must be a canonical positive safe integer` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is in read-only mode |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 did not confirm the update. Message `Bitrix24 did not confirm the booking operation` |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned the record in an unexpected shape when it was re-read after the update. The update is already saved — check the record with a [get request](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fget) before retrying |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Get a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fget)\n- [List wait list records](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist)\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Errors](\u002Fdocs\u002Ferrors)\n","# Delete an entry\n\n`DELETE \u002Fv1\u002Fbooking-wait-list\u002F:id`\n\nDeletes a record from the wait list. A deleted record cannot be restored through the API — create a new one if needed.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `id` (path) | number | yes | Record identifier. List: [`GET \u002Fv1\u002Fbooking-wait-list`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F29\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F29\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F29', {\n  method: 'DELETE',\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\n\nconst { data } = await res.json()\nconsole.log(data.id, data.deleted)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F29', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { data } = await res.json()\nconsole.log(data.id, data.deleted)\n```\n\n## Response fields\n\nOn success, the method returns `200 OK` with a response body.\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data.id` | number | Identifier of the deleted record |\n| `data.deleted` | boolean | Always `true`: the record is deleted |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 29,\n    \"deleted\": true\n  }\n}\n```\n\n## Error response example\n\n404 — there is no record with this `id`, including when you delete the same record again:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Booking record not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 404 | `ENTITY_NOT_FOUND` | There is no record with this `id`, including when you delete the same record again. Message `Booking record not found` |\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer. Message `id must be a canonical positive safe integer` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is in read-only mode |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 did not confirm the deletion. Message `Bitrix24 did not confirm the booking operation` |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned the record in an unexpected shape during the pre-deletion check. The record was not deleted |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [List wait list records](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist)\n- [Create a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fcreate)\n- [Book from the wait list](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fbooking)\n- [Errors](\u002Fdocs\u002Ferrors)\n","## List clients of a wait list record\n\n`GET \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`\n\nReturns the CRM contacts and companies assigned as clients of a wait list record.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `id` (path) | number | yes | Wait list record ID. List: [`GET \u002Fv1\u002Fbooking-wait-list`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) |\n\nThe generic `filter` parameter is not applied by this endpoint. By default, the API preserves the previous HTTP 200 response and data, adds `Warning: 299 - \"filter is not supported on this endpoint and was ignored\"`, and records unsupported-filter use in the server log.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients', {\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconst contacts = data.filter((client) => client.type.code === 'CONTACT')\nconsole.log('Record contacts:', contacts.map((client) => client.id))\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data` | array | Clients of the wait list record. A record without clients returns an empty array |\n| `data[].id` | number | CRM contact or company ID. Get: [`GET \u002Fv1\u002Fcontacts\u002F:id`](\u002Fdocs\u002Fentities\u002Fcontacts\u002Fget), [`GET \u002Fv1\u002Fcompanies\u002F:id`](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fget) |\n| `data[].type.code` | string | Client type code: `CONTACT` — contact, `COMPANY` — company. Dictionary: [`GET \u002Fv1\u002Fbooking-client-types`](\u002Fdocs\u002Fentities\u002Fbooking-client-types) |\n| `data[].type.module` | string | Client type module: `crm` |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 3013,\n      \"type\": {\n        \"code\": \"CONTACT\",\n        \"module\": \"crm\"\n      }\n    },\n    {\n      \"id\": 3149,\n      \"type\": {\n        \"code\": \"COMPANY\",\n        \"module\": \"crm\"\n      }\n    }\n  ]\n}\n```\n\n## Error response example\n\n404 — no wait list record with this `id`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Booking record not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 200 | `Warning: 299` | The filter is ignored by default; previous data is preserved and the warning is sent in the `Warning` header. |\n| 400 (strict mode only) | `UNSUPPORTED_FILTER` | The server mode is disabled by default; until it is enabled, the endpoint preserves HTTP 200 and the previous data. |\n| 404 | `ENTITY_NOT_FOUND` | No wait list record with this `id`. Message `Booking record not found` |\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer. Message `id must be a canonical positive safe integer` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned a client list of an unexpected shape |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Replace clients of a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients-set)\n- [Remove clients from a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients-delete)\n- [Get an entry](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fget)\n- [Booking client types](\u002Fdocs\u002Fentities\u002Fbooking-client-types)\n","## Replace clients of a wait list record\n\n`PUT \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`\n\nWrites the passed set as the clients of a wait list record: clients missing from the request are removed from the record. An empty `clients` array removes all clients.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `id` (path) | number | yes | Wait list record ID. List: [`GET \u002Fv1\u002Fbooking-wait-list`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) |\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|----------|\n| `clients` | array | yes | New set of the record's clients. An empty array removes all clients |\n| `clients[].id` | number | yes | CRM contact or company ID. Lists: [`GET \u002Fv1\u002Fcontacts`](\u002Fdocs\u002Fentities\u002Fcontacts\u002Flist), [`GET \u002Fv1\u002Fcompanies`](\u002Fdocs\u002Fentities\u002Fcompanies\u002Flist) |\n| `clients[].type.module` | string | yes | Client type module: `crm`. Dictionary: [`GET \u002Fv1\u002Fbooking-client-types`](\u002Fdocs\u002Fentities\u002Fbooking-client-types) |\n| `clients[].type.code` | string | yes | Client type code: `CONTACT` — contact, `COMPANY` — company. Dictionary: [`GET \u002Fv1\u002Fbooking-client-types`](\u002Fdocs\u002Fentities\u002Fbooking-client-types) |\n\nThe body accepts no other fields: an extra field returns `400 INVALID_PARAMS`.\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X PUT \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"clients\": [\n      { \"id\": 3013, \"type\": { \"module\": \"crm\", \"code\": \"CONTACT\" } },\n      { \"id\": 3149, \"type\": { \"module\": \"crm\", \"code\": \"COMPANY\" } }\n    ]\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X PUT \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"clients\": [\n      { \"id\": 3013, \"type\": { \"module\": \"crm\", \"code\": \"CONTACT\" } },\n      { \"id\": 3149, \"type\": { \"module\": \"crm\", \"code\": \"COMPANY\" } }\n    ]\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients', {\n  method: 'PUT',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    clients: [\n      { id: 3013, type: { module: 'crm', code: 'CONTACT' } },\n      { id: 3149, type: { module: 'crm', code: 'COMPANY' } },\n    ],\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log('Record clients:', data.map((client) => `${client.type.code} ${client.id}`))\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients', {\n  method: 'PUT',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    clients: [\n      { id: 3013, type: { module: 'crm', code: 'CONTACT' } },\n      { id: 3149, type: { module: 'crm', code: 'COMPANY' } },\n    ],\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Response fields\n\nThe response contains the clients of the wait list record, read again after writing.\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data` | array | The record's clients after the replacement. After an empty `clients`, an empty array |\n| `data[].id` | number | CRM contact or company ID. Get: [`GET \u002Fv1\u002Fcontacts\u002F:id`](\u002Fdocs\u002Fentities\u002Fcontacts\u002Fget), [`GET \u002Fv1\u002Fcompanies\u002F:id`](\u002Fdocs\u002Fentities\u002Fcompanies\u002Fget) |\n| `data[].type.code` | string | Client type code: `CONTACT` — contact, `COMPANY` — company |\n| `data[].type.module` | string | Client type module: `crm` |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 3013,\n      \"type\": {\n        \"code\": \"CONTACT\",\n        \"module\": \"crm\"\n      }\n    },\n    {\n      \"id\": 3149,\n      \"type\": {\n        \"code\": \"COMPANY\",\n        \"module\": \"crm\"\n      }\n    }\n  ]\n}\n```\n\n## Error response example\n\n400 — the client type is not in the dictionary:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"Client type not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_PARAMS` | `Client type not found` — the `type.module` and `type.code` pair is not in the [client type dictionary](\u002Fdocs\u002Fentities\u002Fbooking-client-types). The record's clients stay unchanged |\n| 400 | `INVALID_PARAMS` | `Each client requires id and type.module\u002Ftype.code` — a `clients` item has no `id`, `type.module` or `type.code`, or its `id` is not a positive integer |\n| 400 | `INVALID_PARAMS` | `Only clients can be written` — the body contains a field other than `clients` |\n| 400 | `INVALID_PARAMS` | `id must be a canonical positive safe integer` — the record `id` is not a positive integer |\n| 400 | `MISSING_REQUIRED_FIELDS` | `clients must be an array` — the body has no `clients`, or it is not an array |\n| 404 | `ENTITY_NOT_FOUND` | `Booking record not found` — no wait list record with this `id` |\n| 404 | `ENTITY_NOT_FOUND` | No CRM contact or company with the given `clients[].id`. The record's clients stay unchanged |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only. The request is rejected before any call to Bitrix24 |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | `Bitrix24 did not confirm the booking operation` — Bitrix24 did not confirm the write |\n| 502 | `BITRIX_RESPONSE_INVALID` | `Bitrix24 returned an unexpected booking response` — Bitrix24 returned a client list of an unexpected shape |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [List clients of a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients-list)\n- [Remove clients from a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients-delete)\n- [Booking client types](\u002Fdocs\u002Fentities\u002Fbooking-client-types)\n- [List contacts](\u002Fdocs\u002Fentities\u002Fcontacts\u002Flist)\n- [List companies](\u002Fdocs\u002Fentities\u002Fcompanies\u002Flist)\n","## Remove clients from a wait list record\n\n`DELETE \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fclients`\n\nRemoves all clients from a wait list record in one call. The contacts and companies stay in CRM.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `id` (path) | number | yes | Wait list record ID. List: [`GET \u002Fv1\u002Fbooking-wait-list`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X DELETE \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n  },\n})\n\nconst { success, data } = await res.json()\nconsole.log('Record clients after removal:', data)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F37\u002Fclients', {\n  method: 'DELETE',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { success, data } = await res.json()\n```\n\n## Response fields\n\nThe response contains the clients of the wait list record, read again after the removal.\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data` | array | Record clients after the removal |\n| `data[].id` | number | CRM contact or company ID |\n| `data[].type.code` | string | Client type code: `CONTACT` — contact, `COMPANY` — company |\n| `data[].type.module` | string | Client type module: `crm` |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": []\n}\n```\n\n## Error response example\n\n404 — no wait list record with this `id`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Booking record not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 404 | `ENTITY_NOT_FOUND` | No wait list record with this `id`. Message `Booking record not found` |\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer. Message `id must be a canonical positive safe integer` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only. The request is rejected before any call to Bitrix24 |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | `Bitrix24 did not confirm the booking operation` — Bitrix24 did not confirm the removal |\n| 502 | `BITRIX_RESPONSE_INVALID` | `Bitrix24 returned an unexpected booking response` — Bitrix24 returned a client list of an unexpected shape |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## See also\n\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [List clients of a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients-list)\n- [Replace clients of a wait list record](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients-set)\n- [Delete an entry](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fdelete)\n","# Book from the wait list\n\n`POST \u002Fv1\u002Fbooking-wait-list\u002F:id\u002Fbooking`\n\nCreates 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.\n\nFields 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](\u002Fdocs\u002Fentities\u002Fbooking-resources\u002Fget).\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|:-----:|----------|\n| `id` (path) | number | yes | Wait list record identifier. List: [`GET \u002Fv1\u002Fbooking-wait-list`](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Flist) |\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|----------|\n| `resourceIds` | number[] | yes | Identifiers of the resources the booking reserves. The array cannot be empty. List: [`GET \u002Fv1\u002Fbooking-resources`](\u002Fdocs\u002Fentities\u002Fbooking-resources\u002Flist) |\n| `datePeriod.from.timestamp` | number | yes | Booking start, Unix time in seconds |\n| `datePeriod.from.timezone` | string | yes | Time zone of the start in IANA format, e.g. `UTC` |\n| `datePeriod.to.timestamp` | number | yes | Booking end, Unix time in seconds. Must be later than the start |\n| `datePeriod.to.timezone` | string | yes | Time zone of the end in IANA format |\n\nThe body accepts no other fields. The booking name and description are set by [updating the booking](\u002Fdocs\u002Fentities\u002Fbookings\u002Fupdate).\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\u002Fbooking\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"resourceIds\": [49],\n    \"datePeriod\": {\n      \"from\": { \"timestamp\": 1795158000, \"timezone\": \"UTC\" },\n      \"to\": { \"timestamp\": 1795161600, \"timezone\": \"UTC\" }\n    }\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\u002Fbooking\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"resourceIds\": [49],\n    \"datePeriod\": {\n      \"from\": { \"timestamp\": 1795158000, \"timezone\": \"UTC\" },\n      \"to\": { \"timestamp\": 1795161600, \"timezone\": \"UTC\" }\n    }\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\u002Fbooking', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    resourceIds: [49],\n    datePeriod: {\n      from: { timestamp: 1795158000, timezone: 'UTC' },\n      to: { timestamp: 1795161600, timezone: 'UTC' },\n    },\n  }),\n})\n\nconst { data } = await res.json()\nconsole.log('Booking ID:', data.id)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fbooking-wait-list\u002F27\u002Fbooking', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    resourceIds: [49],\n    datePeriod: {\n      from: { timestamp: 1795158000, timezone: 'UTC' },\n      to: { timestamp: 1795161600, timezone: 'UTC' },\n    },\n  }),\n})\n\nconst { data } = await res.json()\nconsole.log('Booking ID:', data.id)\n```\n\n## Response fields\n\nOn success, the HTTP status is `201 Created` and the response contains the card of the new booking — the same as [`GET \u002Fv1\u002Fbookings\u002F:id`](\u002Fdocs\u002Fentities\u002Fbookings\u002Fget) returns.\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | `true` on success |\n| `data.id` | number | Booking identifier. The booking's clients are returned by [`GET \u002Fv1\u002Fbookings\u002F:id\u002Fclients`](\u002Fdocs\u002Fentities\u002Fbookings\u002Fclients) |\n| `data.name` | string \\| null | Booking name |\n| `data.description` | string \\| null | Booking description |\n| `data.resourceIds` | number[] | Identifiers of the reserved resources |\n| `data.datePeriod` | object | Booking period: `from` and `to` are ISO 8601 date-time strings |\n\n## Response example\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"datePeriod\": {\n      \"from\": \"2026-11-20T07:00:00+00:00\",\n      \"to\": \"2026-11-20T08:00:00+00:00\"\n    },\n    \"description\": null,\n    \"id\": 49,\n    \"name\": null,\n    \"resourceIds\": [\n      49\n    ]\n  }\n}\n```\n\n## Error response example\n\n404 — there is no wait list record with this `id`, for example because it has already been moved to a booking:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"Booking record not found\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 404 | `ENTITY_NOT_FOUND` | There is no wait list record with this `id`, including one already moved to a booking. Message `Booking record not found` |\n| 400 | `MISSING_REQUIRED_FIELDS` | `resourceIds` or `datePeriod` is missing, or `resourceIds` is an empty array. Message `resourceIds and datePeriod are required` |\n| 400 | `INVALID_PARAMS` | The body contains a field other than `resourceIds` and `datePeriod`. Message `Only resourceIds and datePeriod can be written` |\n| 400 | `INVALID_PARAMS` | `resourceIds` contains a value that is not a positive integer. Message `resourceIds must contain positive integers` |\n| 400 | `INVALID_PARAMS` | `from` or `to` has no `timestamp` or `timezone`. Message `datePeriod requires from\u002Fto with a finite timestamp and timezone` |\n| 400 | `INVALID_PARAMS` | The time zone is not in IANA format. Message `timezone must be an IANA timezone` |\n| 400 | `INVALID_PARAMS` | The body is not a JSON object. Message `Body must contain resourceIds and datePeriod` |\n| 400 | `INVALID_PARAMS` | `id` is not a positive integer. Message `id must be a canonical positive safe integer` |\n| 422 | `BITRIX_ERROR` | A resource from `resourceIds` does not exist. Message `Some resources were not found` with the resource IDs, `b24Code` `1038` |\n| 422 | `BITRIX_ERROR` | The booking end is earlier than the start. Message `Invalid date period` |\n| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is not passed |\n| 401 | `TOKEN_MISSING` | The key has no Bitrix24 tokens |\n| 403 | `SCOPE_DENIED` | The key does not have the `booking` scope |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is in read-only mode |\n| 429 | `RATE_LIMITED` | Request rate exceeded. The effective cap is in the `x-ratelimit-limit` header |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned a response of an unexpected shape. If this happened while re-reading the booking after creation, the booking has already been created and the record removed from the wait list — find the booking in the [list of bookings](\u002Fdocs\u002Fentities\u002Fbookings\u002Flist) before retrying |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**A rejected request does not remove the record.** On a `400` or `422` response, the record stays in the wait list, and the move can be retried.\n\n**The booking card does not return the note.** The record's note moves to the booking, but the booking card has no field for it, and `description` stays `null`. When the [booking is moved back to the wait list](\u002Fdocs\u002Fentities\u002Fbookings\u002Fwait-list), the note returns to the new wait list record.\n\n## See also\n\n- [Move a booking to the wait list](\u002Fdocs\u002Fentities\u002Fbookings\u002Fwait-list)\n- [Wait list clients](\u002Fdocs\u002Fentities\u002Fbooking-wait-list\u002Fclients)\n- [Get a booking](\u002Fdocs\u002Fentities\u002Fbookings\u002Fget)\n- [List booking resources](\u002Fdocs\u002Fentities\u002Fbooking-resources\u002Flist)\n- [Errors](\u002Fdocs\u002Ferrors)\n",1795000273381]