Push

Create a push campaign

Changed on

Creates a push campaign draft. Content and audience can be set now or later. Requires the campaigns:write scope.

post/push/campaigns

Request

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

Request body

namestring
targetListsobject

Audience, same shape as campaign targetLists, for example {"type":"all"}, {"type":"lists","listIds":["..."]}, {"type":"segment","segmentId":"..."} or {"type":"rules","include":[...]}. Only contacts with an active push device receive the campaign.

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

Campaign created

successboolean

Example response

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

Changes