Quick Start — Segmentos

Segmento = conjunto dinâmico de contatos que atualiza sozinho quando tags, tópicos ou dados mudam.

Em poucas palavras

Monte regras (match: all ou any).
Salve com POST /v1/segments.
Use em campanha ou GET /v1/segments/{id}/contacts.

Contexto: Segmentos na audiência. Escopos: Escopos de segmentos.

Antes de começar

Item	Obrigatório
`segments:create`	Para criar
`segments:read`	Para listar e exportar membros

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

1. Pelo painel

Audiência → Segmentos → Novo
Nome (Clientes VIP)
Adicione regras (tag, tópico, marketing, canal, etc.)
Salve — o contador de membros atualiza automaticamente

2. Segmento simples (API)

Contatos com tag VIP que aceitam 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. Listar segmentos

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

4. Preview dos membros

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

Retorna amostra paginada dos contatos que entram no segmento (máx. 500 por página).

5. Usar em campanha

No painel, escolha o segmento como audiência. Na API de campanha, use o segmentId retornado ao criar a campanha.

Tipos de regra (`type`)

`type`	Uso
`tag`	Contato tem a tag
`topic`	Inscrito (ou não) no tópico
`receiveMarketing`	Aceita marketing
`hasPhone`, `hasEmail`, `hasTelegram`	Tem canal
`property`, `contactField`	Campo personalizado

Detalhes e exemplos: Segmentos na audiência.

Contatos

Contatos

Tags

Tópicos

Segmentos

Campanhas

Pipelines

Meta

Tarefas

Quick Start — Segmentos

Em poucas palavras

Antes de começar

1. Pelo painel

2. Segmento simples (API)

3. Listar segmentos

4. Preview dos membros

5. Usar em campanha

Tipos de regra (`type`)

Próximos passos

​Em poucas palavras

​Antes de começar

​1. Pelo painel

​2. Segmento simples (API)

​3. Listar segmentos

​4. Preview dos membros

​5. Usar em campanha

​Tipos de regra (type)

​Próximos passos

Em poucas palavras

Antes de começar

1. Pelo painel

2. Segmento simples (API)

3. Listar segmentos

4. Preview dos membros

5. Usar em campanha

Tipos de regra (`type`)

Próximos passos