> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start — Segmentos

> Defina regras, salve o segmento e use em campanhas ou exportação.

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

## 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](/contacts-api/como-funciona/segmentos-na-audiencia). Escopos: [Escopos de segmentos](/contacts-api/como-funciona/segmentos-escopos-da-api-key).

## 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

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

***

## 2. Segmento simples (API)

Contatos com tag VIP que aceitam marketing:

```http theme={null}
POST /v1/segments
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx
```

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

***

## 3. Listar segmentos

```http theme={null}
GET /v1/segments?page=1&limit=50
Authorization: Bearer sk_live_xxxxx
```

***

## 4. Preview dos membros

```http theme={null}
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](/contacts-api/como-funciona/segmentos-na-audiencia).

***

## Próximos passos

* [Campanhas — Quick Start](/contacts-api/como-funciona/campanhas-quick-start)
* [Tags — Quick Start](/contacts-api/como-funciona/tags-quick-start)
* [Introdução](/contacts-api/como-funciona/introducao)