Broadcasts

Schedule a broadcast

POST https://demo.notifuse.com/api/broadcasts.schedule

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

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body application/json

workspace_id string required

The ID of the workspace

  • Example: ws_1234567890
id string required

ID of the broadcast to schedule

  • Example: broadcast_12345
send_now boolean

Send immediately instead of scheduling

  • Example: false
scheduled_date string

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

  • Example: 2024-03-15
scheduled_time string

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

  • Example: 10:30
timezone string

IANA timezone

  • Example: America/New_York
use_recipient_timezone boolean

Send at scheduled time in each recipient's timezone

  • Example: false

Response

200 Broadcast scheduled successfully object
success boolean
  • Example: true
400 Bad request - validation failed object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

404 Broadcast not found object
error string required

Error message

500 Internal server error object
error string required

Error message