Skip to main content
POST
Set Campaign Schedule

Authorizations

X-API-Key
string
header
required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization
string | null
X-API-Key
string | null

Path Parameters

campaign_id
integer
required

Body

application/json

Set or clear a campaign's schedule.

Both fields are sent every time: omitting one clears it, because "no start time" and "no calling window" are real settings a customer picks.

scheduled_start_at
string<date-time> | null
calling_window
CallingWindowRequest · object | null

Hours a campaign may dial in, in the customer's own timezone.

Response

Successful Response

id
integer
required
name
string
required
workflow_id
integer
required
workflow_name
string
required
state
string
required
source_type
string
required
source_id
string
required
total_rows
integer | null
required
processed_rows
integer
required
failed_rows
integer
required
created_at
string<date-time>
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
goal
string | null
source_config
object | null
source_refresh_minutes
integer | null
source_last_synced_at
string<date-time> | null
source_sync_error
string | null
scheduled_start_at
string<date-time> | null
calling_window
object | null