Client on the Waitlist: Overview of Methods
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
You can add a client to the waitlist: either a contact or a company. The client will receive a notification when their entry is moved to a specific time.
Quick navigation: all methods
How to Start
- Create a waitlist entry using the booking.v1.waitlist.* methods
- Retrieve the CRM contact or company
ID - Add a client using booking.v1.waitlist.client.set
- Check the linked client information using booking.v1.waitlist.client.list
Relationships with Other Objects
Waitlist. To add or replace a client, use the ID of the waitlist entry in the waitListId parameter of the booking.v1.waitlist.client.* methods. You can obtain the entry ID using booking.v1.waitlist.add or booking.v1.waitlist.list.
Contact. To attach a contact to the waitlist entry, pass the contact ID to the booking.v1.waitlist.client.set method. You can obtain the contact ID using the crm.item.list method with the entityTypeId = 3 parameter.
Company. To attach a company to the waitlist entry, pass the company ID to the booking.v1.waitlist.client.set method. You can obtain the company ID using the crm.item.list method with the entityTypeId = 4 parameter.
If the client is new, first add them to the CRM using the crm.item.add method with the entityTypeId = 3 for a contact or entityTypeId = 4 for a company.
Overview of Methods
Scope:
bookingWho can execute the methods: any user
|
Method |
Description |
|
Adds a contact or company to the waitlist entry |
|
|
Returns the contact and company linked to the waitlist entry |
|
|
Removes a contact or company from the waitlist entry |