About the Assistant Inbox Channels Settings API

The Assistant Inbox Channels Settings API lets you control when the AI assistant responds to customers on a business's messaging channels, such as WhatsApp and Instagram.

With the Assistant Inbox Channels Settings API, you can:

  • Turn the AI assistant on or off for each channel.
  • Limit the AI assistant to specific days and hours, or let it respond at all times.
  • Check whether a channel account is connected and whether the AI assistant is currently responding on it.

Read the AI assistant's status

To find out whether the AI assistant is responding on a channel, retrieve the settings and read operatingModes for that channel. This value is calculated when you make the request from the channel's connection status, its enabled flag, and its active hours. Use it instead of combining those values yourself.

When more than one condition applies, operatingModes reports the most blocking one in this order: CHANNEL_NOT_CONNECTED, then DISABLED, then OUTSIDE_ACTIVE_HOURS. The value is accurate only at the moment of the response, because it changes as time crosses the boundaries of a schedule. Don't cache it.

Before you begin

It's important to note the following points before starting to code:

  • Settings are scoped to a single site, which is inferred from the caller's identity. Each site has one settings record, which is created with all channels disabled the first time it's retrieved.
  • Each supported channel (whatsapp and instagram) has its own settings, connection status, and operating mode. The channels are configured independently, and Instagram settings have the same structure as WhatsApp settings.
  • Turning the AI assistant off stops it from replying automatically. It doesn't disconnect the channel or affect a business's ability to message customers manually.
  • A schedule and its time zone must be set together. To have the AI assistant respond at all times, set the mode to ALWAYS_WITH_AI. The saved schedule and time zone are kept but ignored in this mode, so you can switch back to SCHEDULED without setting them again.
  • The response includes the connection status of each channel account. If the connection statuses can't be retrieved, the request fails.
  • Updates require the current revision. Concurrent edits to the same site's settings are rare, but retrieve the settings again and retry if an update is rejected because of a revision mismatch.

Use cases

Terminology

  • Channel: A messaging channel a business uses to talk to customers. Currently, WhatsApp and Instagram.
  • Active hours: The days and times when the AI assistant is allowed to respond on a channel.
  • Operating mode: The AI assistant's current status on a channel. Either it's responding, or the mode explains why it isn't: the channel isn't connected, the AI assistant is turned off, or the current time is outside the active hours.

Last updated: 13 November 2026

Did this help?