CreateBroadcastInput

object

namerequired: string
channelrequired: "whatsapp_cloud" | "sms" | "email"
template_idrequired: Id
Opaque record id.
channel_account_id: Id or null
Opaque record id.
audiencerequired: BroadcastAudienceInput
scheduled_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
throttle_per_min: integer or null
window: object or null
window.startrequired: string
window.endrequired: string
vars: map of string or null
send_mode: "now" | "best_time" or null
best_time: each contact at their best hour (engagement history) within best_time_hours.
best_time_hours: integer or null
personalize_with_ai: boolean or null
personalization: object or null
The template variables AI writes per recipient (up to 3) and the creator’s instructions.
personalization.instructions: string or null
personalization.variablesrequired: array of object
personalization.variables[].keyrequired: string
personalization.variables[].hint: string or null

Example

{
  "name": "string",
  "channel": "whatsapp_cloud",
  "template_id": "cmusrceel0000q7kaafxqi1om",
  "channel_account_id": "cmusrceel0000q7kaafxqi1om",
  "audience": {
    "kind": "leads",
    "filter": null,
    "view": "all",
    "q": "string",
    "ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "saved_view_id": "cmusrceel0000q7kaafxqi1om"
  },
  "scheduled_at": "2026-10-06T05:30:00.000Z",
  "throttle_per_min": 1,
  "window": {
    "start": "string",
    "end": "string"
  },
  "vars": {},
  "send_mode": "now",
  "best_time_hours": 1,
  "personalize_with_ai": true,
  "personalization": {
    "instructions": "string",
    "variables": [
      {
        "key": "string",
        "hint": "string"
      }
    ]
  }
}