Create broadcast

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

post/v1/broadcasts

Request body

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.

Example request

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

Response

Broadcast created.

Example response

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

Changes

Changed in 4 of the 66 revisions of this API.3213

Jul 7, 2026f467a4da6cd236See the full diff
- ▲
  removed the enum value instagram of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value messenger of the request property
  request-property-enum-value-removed
- ▲
  removed the enum value voice of the request property
  request-property-enum-value-removed
- ○
  removed the instagram enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the instagram enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the messenger enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the messenger enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the voice enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the voice enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 18, 2026a817a073a07f21See the full diff
- ●
  added the new messenger enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new messenger enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new messenger enum value to the request property
  request-property-enum-value-added
May 28, 2026fe72e55655643See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
May 15, 20263e45958691da3See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added

Full history