Segments#

Segments group subscribers by external ID for targeted notifications. Manage them from the dashboard or API.

Create a segment#

From the dashboard: Segments > New segment. Enter a name and paste external IDs (comma-separated or one per line).

Via the dashboard API (session auth):

POST /v1/dashboard/segments
{
  "name": "Premium users",
  "externalIds": ["usr_1", "usr_2", "usr_3"]

Use a segment#

When sending a notification, target a segment by its ID:

{
  "body": "Exclusive offer for premium users!",
  "target": { "segment": "SEGMENT_ID" }

The notification is sent to all subscribers whose externalId matches one in the segment.

Delete a segment#

DELETE /v1/dashboard/segments/{id}

Deleting a segment does not affect subscribers. It only removes the grouping.