Skip to main content
POST
Create a push campaign draft

Endpoints

  • POST /push/campaigns
  • GET /push/campaigns
  • GET /push/campaigns/:id
  • PATCH /push/campaigns/:id
  • GET /push/campaigns/:id/audience-preview
Public API campaigns are draft-only. Update localized messages, platforms, audience inclusion/exclusion, a published push template version, Android configuration, buttons, and optional Live Activity content. Audience preview counts reachable subscribed devices with a provider registration. To prove content on a device, pass the campaign ID to the push test endpoint. Scheduling, launch, deletion, and broad campaign test sends are not exposed in this API version.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Maximum string length: 120
app_id
string
required
environment
enum<string>
Available options:
production,
development

Response

Push campaign draft created

status
number
data
unknown
error
unknown
metadata
unknown