This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.
The examples use WhatsApp. To manage Instagram, use instagram in place of whatsapp in requests, and read operatingModes.instagram in responses.
A business owner wants to know if the AI assistant is answering customers on WhatsApp, and why not if it isn't.
To check the AI assistant's status on a channel:
operatingModes.whatsapp from the response. ACTIVE means the AI assistant is responding. Any other value gives the reason it isn't: CHANNEL_NOT_CONNECTED means the WhatsApp account isn't connected to the site, DISABLED means the AI assistant is turned off for the channel, and OUTSIDE_ACTIVE_HOURS means the current time is outside the schedule in assistantInboxChannelsSettings.whatsapp.activeHours.A business owner wants to handle all WhatsApp conversations manually.
To turn the AI assistant off for a channel:
assistantInboxChannelsSettings.revision.revision and whatsapp.enabled set to false. Other settings, such as the channel's active hours, are left unchanged. From now on, operatingModes.whatsapp is DISABLED, or CHANNEL_NOT_CONNECTED if the WhatsApp account isn't connected.A business owner wants the AI assistant to answer WhatsApp messages only on weekdays from 9
AM to 5 PM, and to handle messages manually the rest of the time.To limit the AI assistant to business hours:
Call Get Assistant Inbox Channels Settings and save assistantInboxChannelsSettings.revision.
Call Update Assistant Inbox Channels Settings with the saved revision, whatsapp.enabled set to true, and whatsapp.activeHours set to SCHEDULED mode with a time zone and a weekly schedule:
If the WhatsApp account is connected, operatingModes.whatsapp is now ACTIVE during the scheduled hours and OUTSIDE_ACTIVE_HOURS the rest of the time.
Keep these rules in mind when you build a schedule:
timeZone and schedule together. The request fails if you specify only one of them. To change the schedule later, pass both again.SCHEDULED mode, the AI assistant responds only during the frames in schedule. If the schedule is empty, it never responds.timeZone must be a standard IANA time zone identifier, such as "America/New_York". Fixed offsets like "+02:00" and "UTC" also work, but abbreviations like "EST" don't.startTime is inclusive, endTime is exclusive, and endTime must be later than startTime.endTime to "00:00". "24:00" isn't valid."00:00" and another starting at "00:00" on the next day.Last updated: 13 November 2026