MailMoo
ToolsCampaigns

mailmoo_campaign_update_schedule

Change a campaign's sending schedule

Changes when a campaign sends: its time zone and each day's sending window. Use for 'send 9 to 5 Helsinki time', 'stop sending on Fridays', 'move the campaign to New York time'. Only what you pass changes: days you leave out keep their hours, and the time zone stays unless given. Times are 24-hour HH:MM in the campaign's time zone, and the start must be before the end. At least one day must stay on; to stop sending altogether, pause with campaign_set_state. Works while the campaign is running. Campaign by name or id. Without confirm it changes nothing and returns the schedule before and after: show that to the user, then call again with confirm: true.

Effect: Write. See Effects.

Permissions: Read campaigns, Write campaigns.

Parameters

ParameterTypeRequiredDescription
campaignstringYesThe campaign, by name or id.
timeZonestringNoIANA time zone, e.g. Europe/Helsinki or America/New_York.
daysobjectNoOnly the days to change, e.g. { friday: { enabled: false } } or { monday: { start: '08:00', end: '16:00' } }.
confirmbooleanNoLeave out first: the call then changes nothing and returns what would happen. Show that to the user, and call again with confirm: true once they agree.

On this page