UpdateSchedule
Replaces the schedule of a campaign.
Defines when the campaign runs each day, which days it is active, the timezone, and optional start/end dates.
Allowed statuses: DRAFT, SCHEDULED, PAUSED. Returns 400 for any other status (e.g. IN_PROGRESS, FINISHED). For SCHEDULED campaigns the campaign reverts to DRAFT. Once a campaign has been started at least once, startDate cannot be changed.
Body Parameters
-
campaignId (long, required): The campaign to update.
-
schedule (CampaignScheduleApiDto, required): The new schedule configuration.
CampaignScheduleApiDto fields
-
dailyStartTime (TimeSpan, required): Start of the daily active window, format
"HH:mm:ss"(e.g."09:00:00"). Must be beforedailyEndTime. Maximum is 24 hours - see note below. -
dailyEndTime (TimeSpan, required): End of the daily active window, format
"HH:mm:ss"(e.g."17:00:00"). Must be afterdailyStartTime. Maximum is 24 hours - see note below. -
timeZoneId (string, required): IANA timezone identifier (e.g.
"America/New_York","Europe/London"). Default"Etc/GMT". -
enabledMonday (bool, optional): Default
true. -
enabledTuesday (bool, optional): Default
true. -
enabledWednesday (bool, optional): Default
true. -
enabledThursday (bool, optional): Default
true. -
enabledFriday (bool, optional): Default
true. -
enabledSaturday (bool, optional): Default
false. -
enabledSunday (bool, optional): Default
false. -
startDate (date, optional): ISO date, e.g.
"2025-06-01". Ifnullor in the past, the campaign starts immediately when activated. Cannot be modified after the campaign has been started. -
endDate (date, optional): ISO date. Campaign stops automatically on this date. Must be after
startDateif both are set.
At least one enabled* day must be true.
Note on the 24-hour boundary: the maximum is 24 hours and is sent as "24:00:00" (interpreted as end-of-day in the campaign’s timeZoneId). Some client libraries (e.g. Python’s datetime.strptime with %H:%M:%S) reject hours outside 0-23. If yours does, send "23:59:59" instead.
Headers
API key header using this scheme. Example: “X-API-KEY: {API_KEY}”
