Skip to main content
← All schemas

InboxOptions

object

channelsrequired
array of object

Connected sending identities; a linked WhatsApp number only for its own agent.

channels[].idrequired
Id

Opaque record id.

channels[].kindrequired
SendChannel

whatsapp_cloud = official WhatsApp; whatsapp_web = an agent’s linked number.

channels[].labelrequired
string
channels[].addressrequired
string
channels[].is_defaultrequired
boolean
membersrequired
array of object

Active members, A → Z.

members[].idrequired
Id

Opaque record id.

members[].namerequired
string
labelsrequired
array of string

Labels already used on the company’s conversations.

Example
{
  "channels": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "whatsapp_cloud",
      "label": "string",
      "address": "string",
      "is_default": true
    }
  ],
  "members": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    }
  ],
  "labels": [
    "string"
  ]
}