Edit a notification
pushengage_update_notificationEdit an existing draft, scheduled, or recurring PushEngage notification by passing only the fields to change; use it to fix titles, timing, or audience without creating a new push.
Instructions
Edits an existing draft, scheduled or recurring notification. Pass notification_id plus ONLY the fields to change — everything else is carried over from the notification as it stands. Use this instead of pushengage_send_notification when the user wants to fix or adjust something already created ("change the title", "move it to 9am", "target a different segment"); use pushengage_send_notification to create something new. Cannot edit a notification that has already been sent or is sending, an RSS auto-push notification, or any part of an A/B test (editing one through the API breaks the test, so it is refused). Nor a notification belonging to a drip or triggered campaign, or one timezone's copy of a subscriber-timezone broadcast — manage those from the campaign or the parent. Editing a PAUSED recurring notification resumes it — the API sets the status back to running on save, exactly as the dashboard does — so tell the user that before editing one. Changing the audience replaces it entirely: pass audience_groups or subscriber_filter to set a new one. A notification with no audience goes to all subscribers — the dashboard calls that "All Subscribers" — and editing one is allowed; the response reports the audience that was saved either way, and names any audience group the API dropped because it no longer exists — the send then reaches all subscribers, so tell the user. Do not add optional fields unless the user explicitly asks to change them.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"notification_id": "<notification_id>"
},
"name": "pushengage_update_notification"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Destination URL when the subscriber clicks the notification | |
| tags | No | Up to 5 tags, 36 chars each. Only when the user explicitly asks for tags. | |
| title | No | Notification title | |
| status | No | Change the delivery state. Omit to leave it as it is. Set "sent" to send a draft or a scheduled notification now, or "schedule" with a schedule_date to move it. | |
| actions | No | Action buttons. Only when the user explicitly asks. | |
| message | No | Notification message body | |
| site_id | No | Override the currently selected site | |
| ios_push | No | iOS-specific options. Only when the user explicitly asks. | |
| expire_in | No | Expiry in seconds (60–2419200). Only when the user explicitly asks. | |
| image_url | No | Small notification icon. Only when the user explicitly asks for an image. | |
| utm_params | No | UTM tracking params. Only when the user explicitly asks. | |
| android_push | No | Android-specific options. Requires channel_id when set. Only when the user explicitly asks. | |
| big_image_url | No | Large hero image. Only when the user explicitly asks for a big image. | |
| schedule_date | No | Required when status is "schedule". Format: YYYY-MM-DD HH:mm:ss in the site timezone. | |
| audience_groups | No | Send to one or more predefined audience groups (1-20 group IDs). Each ID refers to an audience group already configured in PushEngage. Omit this field to send to all subscribers. Only set this when the user mentions a saved/predefined audience group. Mutually exclusive with subscriber_filter. | |
| notification_id | Yes | The notification to edit. Get it from pushengage_list_notifications, or from the notification_id a send tool returned. | |
| schedule_timezone | No | OPTIONAL. The IANA timezone that `schedule_date` is written in, e.g. "Asia/Kolkata" or "America/New_York". Set this whenever the user names a timezone, or when you know their timezone differs from the site's — the notification is then scheduled for the instant they actually meant, and the response reports both wall clocks so you can tell them what was scheduled. Omit it and `schedule_date` is taken as the SITE's local time, which is what the API assumes. Requires schedule_date; cannot be combined with recurring_schedule, nor with send_in_subscribers_timezone (that flag already makes schedule_date each subscriber's own local time, so there is nothing to convert). Must be a full IANA zone name — abbreviations like "IST", "PST" or "EST" are ambiguous and are rejected, as are the Etc/GMT±N zones, whose sign is inverted. | |
| subscriber_filter | No | OPTIONAL. The dashboard's "Send to Custom Audience": personalize who receives this notification based on segments, location, device and more. Mutually exclusive with audience_groups; omit both for "Send to All Subscribers". A 2-D expression: `value` is a list of rule-groups, rules inside a group are AND-ed, and the top-level `op` combines the groups ("or" by default). Segment rules accept segment NAMES and are resolved automatically, so { field: "segments", op: "in", value: ["Sports Fans"] } works without a lookup. For country, state, city, device or device_type values call pushengage_list_audience_filter_values first; for an attributes rule's `key` call pushengage_list_attributes first. Both are site-specific, and a guessed value saves successfully but reaches the wrong people. Every segment reference and attribute key is verified before anything is sent; an unresolvable one fails the call rather than silently changing who receives the push. Example — mobile subscribers in the Sports Fans segment: { op: "or", value: [[{ field: "segments", op: "in", value: ["Sports Fans"] }, { field: "device", op: "in", value: ["mobile"] }]] }. Example — subscribed in the last 7 days on a paid plan: { op: "or", value: [[{ field: "ts_created", op: "ts_elapsed_lt", value: 10080 }, { field: "attributes", key: "plan", op: "ne", value: "free" }]] }. | |
| recurring_schedule | No | OPTIONAL. Turns this into a recurring notification that fires on the chosen days/times between start_date and end_date. Mutually exclusive with status="schedule", schedule_date, and send_in_subscribers_timezone. With recurring_schedule set, leave status at "sent" (default) to activate the recurrence, or use "draft" to save without activating. Only set this when the user explicitly asks for a recurring/repeating notification. | |
| send_in_subscribers_timezone | No | Only valid when status="schedule" (and not combined with recurring_schedule). When true, schedule_date is interpreted in each subscriber's local timezone instead of the site timezone — one delivery is scheduled per subscriber timezone so every recipient receives the push at the same wall-clock time. Only set this when the user explicitly asks for subscriber-timezone delivery (for example: "send at 9am in their timezone"). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| title | No | ||
| status | No | ||
| message | No | ||
| view_url | No | ||
| notification_id | No | ||
| schedule_conversion | No |