Skip to main content
POST
Send a Push Campaign
Sends a draft or scheduled push campaign now, or schedules it when scheduledAt is a future ISO 8601 time. The campaign needs a title or message, an audience with at least one contact that has an active device, and at least one selected platform set up in push settings. The audience is re-evaluated when delivery starts. Each contact receives one notification per active device. If a push service is temporarily unavailable, only devices that have not accepted the message are retried. Requires the campaigns:send scope.

Request

string
required
The push campaign ID.
string | null
Future ISO 8601 time. Omit or pass null to send immediately.
boolean
Deliver the wall-clock time of scheduledAt in each contact’s own timezone. Needs scheduledAt and scheduledTimezone. The timezone comes from the contact’s most recently seen active device (reported by the SDKs), else the contact’s timezone attribute. Contacts whose local time has already passed get the push right away, and contacts with no known timezone get it at scheduledAt. Delivery starts where that wall-clock time first occurs (UTC+14), so the campaign can stay sending for about 26 hours. Turning it on turns sendTimeOptimization off. Omit to keep the saved value.
string | null
IANA timezone the scheduled wall-clock time refers to, for example America/New_York. Omit to keep the saved value.
boolean
Send each contact the push at their most engaged hour, within sendTimeWindowHours of the start (now, or scheduledAt). The hour is the contact’s most-clicked push hour over the last 90 days (at least 3 clicks), else their most-opened email hour, else your workspace’s most-clicked push hour (once it has at least 20 clicks in the last 90 days), else the start time. Turning it on turns sendInRecipientTimezone off. Passing both as true returns 400. Omit to keep the saved value.
integer
Hours after the start in which optimized sends may land, from 1 to 24. Omit to keep the saved value, which is 12 if never set.
Push campaigns have no spreadOverHours. Cancelling a campaign while it waits for later timezones or optimized hours skips every push that has not gone out yet.
Deliver at 9:00 in each contact’s own timezone:

Responses