Broadcast

object

idrequired: Id
Opaque record id.
namerequired: string
channelrequired: "whatsapp_cloud" | "sms" | "email"
channel_account_idrequired: Id or null
Opaque record id.
templaterequired: object or null
template.idrequired: Id
Opaque record id.
template.namerequired: string
template.categoryrequired: string
template.statusrequired: string
template.languagerequired: string
audiencerequired: object
audience.kindrequired: "leads" | "contacts" | "csv"
audience.summaryrequired: string
audience.definitionrequired: map of any
purposerequired: string or null
varsrequired: map of string
scheduled_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
send_moderequired: "now" | "best_time"
best_time_hoursrequired: integer or null
personalizationrequired: BroadcastPersonalization
compliancerequired: BroadcastCompliance
throttle_per_minrequired: integer
windowrequired: object or null
window.startrequired: string
window.endrequired: string
statusrequired: "draft" | "pending" | "scheduled" | "running" | "paused" | "completed" | …
status_reasonrequired: string or null
manual · template_paused · wallet_insufficient · kill_switch · channel_unavailable · dlt_not_configured · channel_auth · account_issue · failure_rate · spam_rate_limited · rejected
status_noterequired: string or null
estimaterequired: BroadcastEstimate or null
built_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
submitted_byrequired: object or null
submitted_by.idrequired: Id
Opaque record id.
submitted_by.namerequired: string
submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
approved_byrequired: object or null
approved_by.idrequired: Id
Opaque record id.
approved_by.namerequired: string
approved_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
started_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
next_batch_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
created_byrequired: object or null
created_by.idrequired: Id
Opaque record id.
created_by.namerequired: string
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
statsrequired: BroadcastStats
eta_minutesrequired: integer or null
can_editrequired: boolean
can_sendrequired: boolean
can_deleterequired: boolean

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "name": "string",
  "channel": "whatsapp_cloud",
  "channel_account_id": "cmusrceel0000q7kaafxqi1om",
  "template": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "category": "string",
    "status": "string",
    "language": "string"
  },
  "audience": {
    "kind": "leads",
    "summary": "string",
    "definition": {}
  },
  "purpose": "string",
  "vars": {},
  "scheduled_at": "2026-10-06T05:30:00.000Z",
  "send_mode": "now",
  "best_time_hours": 0,
  "personalization": {
    "enabled": true,
    "instructions": "string",
    "variables": [
      {
        "key": "string",
        "hint": "string"
      }
    ],
    "variable_options": [
      {
        "key": "string",
        "label": "string"
      }
    ],
    "status": "idle",
    "mode": "live",
    "total": 0,
    "done": 0,
    "fallback": 0,
    "pending": 0,
    "estimate_credits": 0,
    "credits_used": 0,
    "error": "string",
    "started_at": "string",
    "finished_at": "string"
  },
  "compliance": {
    "status": "pass",
    "issues": [
      {
        "source": "rule",
        "category": "string",
        "severity": "block",
        "quote": "string",
        "message": "string",
        "rule_id": "string"
      }
    ],
    "ai_review": "done",
    "checked_at": "string",
    "override": {
      "by": "string",
      "at": "string",
      "reason": "string"
    }
  },
  "throttle_per_min": 0,
  "window": {
    "start": "string",
    "end": "string"
  },
  "status": "draft",
  "status_reason": "string",
  "status_note": "string",
  "estimate": {
    "recipients": 0,
    "segments": 0,
    "unit_paise": 850000000,
    "total_paise": 850000000,
    "meta": {
      "category": "string",
      "unit_centipaise": 0,
      "total_paise": 850000000
    },
    "wallet": {
      "kind": "string",
      "required": true,
      "available_paise": 850000000,
      "disabled": true,
      "sufficient": true
    },
    "tier": {
      "code": "string",
      "limit": 0,
      "exceeds": true
    }
  },
  "built_at": "2026-10-06T05:30:00.000Z",
  "submitted_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "submitted_at": "2026-10-06T05:30:00.000Z",
  "approved_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "approved_at": "2026-10-06T05:30:00.000Z",
  "started_at": "2026-10-06T05:30:00.000Z",
  "completed_at": "2026-10-06T05:30:00.000Z",
  "next_batch_at": "2026-10-06T05:30:00.000Z",
  "created_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z",
  "stats": {
    "total": 0,
    "queued": 0,
    "sent": 0,
    "delivered": 0,
    "read": 0,
    "replied": 0,
    "failed": 0,
    "opted_out": 0,
    "clicked": 0,
    "skipped": 0,
    "cancelled": 0,
    "skipped_by_reason": {},
    "failed_by_reason": {}
  },
  "eta_minutes": 0,
  "can_edit": true,
  "can_send": true,
  "can_delete": true
}

{ "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "channel": "whatsapp_cloud", "channel_account_id": "cmusrceel0000q7kaafxqi1om", "template": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "category": "string", "status": "string", "language": "string" }, "audience": { "kind": "leads", "summary": "string", "definition": {} }, "purpose": "string", "vars": {}, "scheduled_at": "2026-10-06T05:30:00.000Z", "send_mode": "now", "best_time_hours": 0, "personalization": { "enabled": true, "instructions": "string", "variables": [ { "key": "string", "hint": "string" } ], "variable_options": [ { "key": "string", "label": "string" } ], "status": "idle", "mode": "live", "total": 0, "done": 0, "fallback": 0, "pending": 0, "estimate_credits": 0, "credits_used": 0, "error": "string", "started_at": "string", "finished_at": "string" }, "compliance": { "status": "pass", "issues": [ { "source": "rule", "category": "string", "severity": "block", "quote": "string", "message": "string", "rule_id": "string" } ], "ai_review": "done", "checked_at": "string", "override": { "by": "string", "at": "string", "reason": "string" } }, "throttle_per_min": 0, "window": { "start": "string", "end": "string" }, "status": "draft", "status_reason": "string", "status_note": "string", "estimate": { "recipients": 0, "segments": 0, "unit_paise": 850000000, "total_paise": 850000000, "meta": { "category": "string", "unit_centipaise": 0, "total_paise": 850000000 }, "wallet": { "kind": "string", "required": true, "available_paise": 850000000, "disabled": true, "sufficient": true }, "tier": { "code": "string", "limit": 0, "exceeds": true } }, "built_at": "2026-10-06T05:30:00.000Z", "submitted_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "submitted_at": "2026-10-06T05:30:00.000Z", "approved_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "approved_at": "2026-10-06T05:30:00.000Z", "started_at": "2026-10-06T05:30:00.000Z", "completed_at": "2026-10-06T05:30:00.000Z", "next_batch_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "stats": { "total": 0, "queued": 0, "sent": 0, "delivered": 0, "read": 0, "replied": 0, "failed": 0, "opted_out": 0, "clicked": 0, "skipped": 0, "cancelled": 0, "skipped_by_reason": {}, "failed_by_reason": {} }, "eta_minutes": 0, "can_edit": true, "can_send": true, "can_delete": true }