Push

Send or schedule a push campaign

Changed on

Sends a draft or scheduled push campaign now, or schedules it when scheduledAt is a future ISO 8601 time. Requires content, an audience with at least one contact that has an active device, and at least one selected platform set up in push settings. The audience is re-evaluated when delivery starts. Requires the campaigns:send scope.

post/push/campaigns/{campaignId}/send

Request

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

Path parameters

campaignIdstring required

Push campaign ID.

Request body

scheduledAtstring date-time nullable

Future ISO 8601 time. Omit or null to send immediately.

Response

Campaign sending or scheduled

successboolean
messagestring

Example response

{
  "campaign": {
    "content": {
      "title": "Your order shipped",
      "body": "Tap to track your delivery.",
      "url": "https://shop.example.com/orders"
    }
  },
  "message": "Push campaign is sending to about 340 contacts."
}

Changes