Skip to main content
POST
/
api
/
broadcasts.schedule
Schedule a broadcast
curl --request POST \
  --url https://{notifuseDomain}/api/broadcasts.schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "id": "broadcast_12345",
  "send_now": false,
  "scheduled_date": "2024-03-15",
  "scheduled_time": "10:30",
  "timezone": "America/New_York",
  "use_recipient_timezone": false
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

API token for authentication

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)

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2024-03-15"

​
scheduled_time
string

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

Pattern: ^\d{2}:\d{2}$
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

Broadcast scheduled successfully

​
success
boolean
Example:

true