How do I replace a notification that was already sent via the Pushwoosh API?

You can update the text of a notification that is already on a user device if they have not opened it yet. This works through the native systems in iOS and Android.

To do this, include specific identification strings in your /createMessage or /createTargetedMessage request. When the device receives a new message with an ID that matches a notification already in the tray, the system swaps the old content for the new content.

Use these parameters in your API payload:

Android: android_collapse_key
iOS: apns_collapse_id

Example request

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "YOUR_API_ACCESS_TOKEN",
    "notifications": [
      {
        "send_date": "now",
        "content": "This is the updated notification content",
        "android_collapse_key": "update_id_123",
        "apns_collapse_id": "update_id_123"
      }
    ]
  }
}

This feature is not available for web push. While web browsers use a tag parameter for this purpose, the Pushwoosh API uses the tag field for segmenting audiences.

Example request

Comments

Have a question?

Articles in this section