v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-02172186551.1 KB

Create broadcast

Create a new broadcast campaign. Add contacts after creation, then send.

post/v1/broadcasts

namestring required

Name of the broadcast campaign.

Broadcast delivery channel. Use 'smart' for per-contact intelligent routing.

Type of message for broadcast.

textstring

Text content or caption. Supports template variables: {{name}}, {{1}}, etc.

senderIdstring

Sender profile ID. Uses default sender if omitted.

emailSubjectstring

Email subject line. Required for email broadcasts.

emailHtmlBodystring

HTML body for email broadcasts.

scheduledAtstring date-time

Schedule the broadcast for future delivery.

metadataobject

idempotencyKeystring

Idempotency key to prevent duplicate broadcasts.

{
  "name": "Black Friday Sale",
  "text": "Hi {{name}}, check out our Black Friday deals!"
}

Broadcast created.

{
  "broadcast": {
    "id": "brd_abc123"
  }
}