Skip to main content
PATCH
Update a Push Campaign
Updates a draft or scheduled push campaign. Only the fields you pass change; content fields merge over the stored content, and editing the title or message keeps the stored language versions. A scheduled campaign keeps its schedule, and cannot have its content cleared; unschedule it first. Requires the campaigns:write scope.

Request

string
required
The push campaign ID.
string
Campaign name.
object
Audience, same shape as campaign targetLists.
string
Notification title, up to 120 characters. Merge tags such as {{FIRST_NAME|there}} work.
string
Notification message, up to 500 characters. Merge tags work.
string | null
Link opened on tap: an https URL, an app deep link (myapp://...), or a merge tag. Browsers only open https links. null clears it.
string | null
Optional https image shown in the notification.
string | null
Optional https icon for web push. Defaults to the icon in push settings.
string[]
Limit delivery to web, ios, and/or android. Omit or pass [] for every platform.
object[]
Versions in your other languages (Settings > Localization). Each item has locale (such as de or pt-BR), title and body (a title or a body is required), and optional url and imageUrl (null uses the main link and image). Keep sourceHash and origin as you read them. Passing the list replaces every version, and [] removes them all. Each contact gets the version for their language attribute, else their device language, else your fallback language. Write them with AI using Translate a Push Campaign.
boolean
Save local-time delivery on a draft: the scheduled wall-clock time is delivered in each contact’s own timezone when you send with scheduledAt. Turning it on turns sendTimeOptimization off.
string | null
IANA timezone the scheduled wall-clock time refers to. null clears it.
boolean
Save send-time optimization on a draft. Turning it on turns sendInRecipientTimezone off; passing both as true returns 400.
integer
Hours after the start in which optimized sends may land, from 1 to 24.
Timing fields save on drafts. On a scheduled campaign, a request that changes them returns 409; reschedule with Send a Push Campaign instead. Sending the saved values again is accepted.

Responses