Push

Send a test push

Changed on

Sends a real push to one device (deviceId) or to every active device of a contact (email or subscriberId). Provide title and/or body. Tests are excluded from stats and limited to 200 per company in a rolling 24-hour window. Requires the campaigns:send scope.

post/push/test

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/push/test
  • Auth
    HTTP bearer

Request body

deviceIdstring

One device to notify.

emailstring

Notify every active device of this contact.

subscriberIdstring

Notify every active device of this subscriber.

titlestring

Notification title. Merge tags such as {{FIRST_NAME|there}} are supported.

bodystring

Notification message. Merge tags are supported.

urlstring nullable

Link opened on tap. An https URL, an app deep link (myapp://...), or a merge tag. Browsers only open https links. null clears it.

imageUrlstring nullable

Optional https image shown in the notification.

iconUrlstring nullable

Optional https icon for web push. Defaults to the workspace icon.

platformsstring[]

Limit delivery to these platforms. Omit or pass an empty array for every platform.

Example request

{
  "title": "Your order shipped",
  "body": "Tap to track your delivery.",
  "url": "https://shop.example.com/orders"
}

Response

Test queued

successboolean
pushSendIdstring
deviceCountinteger
remainingTodayinteger
messagestring

Example response

{
  "deviceCount": 2,
  "remainingToday": 198,
  "message": "Test push queued for 2 devices."
}

Changes