Quick Start — Segments

A segment is a dynamic set of contacts that updates on its own when tags, topics, or data change.

In brief

Build rules (match: all or any).
Save with POST /v1/segments.
Use in a campaign or GET /v1/segments/{id}/contacts.

Context: Segments in the Audience. Scopes: Segment scopes.

Before you start

Item	Required
`segments:create`	To create
`segments:read`	To list and export members

Auth: Authorization: Bearer sk_live_.... Base URL: https://api.notifique.dev.

1. In the dashboard

Audience → Segments → New
Name (VIP Customers)
Add rules (tag, topic, marketing, channel, etc.)
Save — the member count updates automatically

2. Simple segment (API)

Contacts with VIP tag who accept marketing:

POST /v1/segments
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "name": "VIP marketing",
  "definition": {
    "version": 1,
    "match": "all",
    "rules": [
      { "type": "tag", "tagId": "clxxTagVip" },
      { "type": "receiveMarketing", "value": true }
    ]
  }
}

3. List segments

GET /v1/segments?page=1&limit=50
Authorization: Bearer sk_live_xxxxx

4. Preview members

GET /v1/segments/{segmentId}/preview?page=1&limit=100
Authorization: Bearer sk_live_xxxxx

Returns a paginated sample of contacts that match the segment (max. 500 per page).

5. Use in a campaign

In the dashboard, choose the segment as the audience. In the campaign API, use the segmentId returned when creating the campaign.

Rule types (`type`)

`type`	Use
`tag`	Contact has the tag
`topic`	Subscribed (or not) to the topic
`receiveMarketing`	Accepts marketing
`channel`	Has channel (email, whatsapp, …)
`field`	Custom field

Details and examples: Segments in the Audience.

API E-mail

E-mail

Domínios

E-mails recebidos

Quick Start — Segments

In brief

Before you start

1. In the dashboard

2. Simple segment (API)

3. List segments

4. Preview members

5. Use in a campaign

Rule types (`type`)

Next steps

​In brief

​Before you start

​1. In the dashboard

​2. Simple segment (API)

​3. List segments

​4. Preview members

​5. Use in a campaign

​Rule types (type)

​Next steps

In brief

Before you start

1. In the dashboard

2. Simple segment (API)

3. List segments

4. Preview members

5. Use in a campaign

Rule types (`type`)

Next steps