Sign in

v24

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

Schedule a broadcast

Schedules a broadcast for sending either immediately or at a specified time. This endpoint is restricted in demo mode.

post/api/broadcasts.schedule

Request body

workspace_idstring required

The ID of the workspace

idstring required

ID of the broadcast to schedule

send_nowboolean

Send immediately instead of scheduling

scheduled_datestring

Scheduled date in YYYY-MM-DD format (required if send_now=false)

scheduled_timestring

Scheduled time in HH:MM format (required if send_now=false)

timezonestring

IANA timezone

use_recipient_timezoneboolean

Send at scheduled time in each recipient's timezone

Example request

{
  "workspace_id": "ws_1234567890",
  "id": "broadcast_12345",
  "scheduled_date": "2024-03-15",
  "scheduled_time": "10:30",
  "timezone": "America/New_York"
}

Response

Broadcast scheduled successfully

successboolean

Example response

{
  "success": true
}