Skip to main content

inbox_create_whatsapp_channel_payload

oneOf
typestringrequired

Possible values: [whatsapp]

Example: whatsapp
phone_numberstringrequired

WhatsApp phone number

Example: +15551234567
providerstringrequired

WhatsApp provider

Possible values: [whatsapp_cloud]

Example: whatsapp_cloud
provider_config objectrequired

WhatsApp Cloud provider configuration

api_keystringrequired

WhatsApp Cloud API key

Example: your-api-key
phone_number_idstringrequired

Phone number ID for WhatsApp Cloud

Example: your-phone-number-id
business_account_idstringrequired

Business account ID for WhatsApp Cloud

Example: your-business-account-id
inbox_create_whatsapp_channel_payload
{
  "type": "whatsapp",
  "phone_number": "+15551234567",
  "provider": "whatsapp_cloud",
  "provider_config": {
    "api_key": "your-api-key",
    "phone_number_id": "your-phone-number-id",
    "business_account_id": "your-business-account-id"
  }
}