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

> Da primeira tag ao primeiro contato: painel e API no mesmo fluxo.

<Tip>
  Ordem sugerida: **tags e campos → contatos → tópicos → segmentos → campanhas**. Contato precisa de **telefone ou e-mail** (ou ambos).
</Tip>

## Em poucas palavras

* **Contato** = a pessoa. **Tag** = etiqueta. **Tópico** = consentimento por tema. **Segmento** = filtro salvo. **Campanha** = disparo em lote.
* Na API, use a **referência da API** na aba Contatos para rotas exatas.

Contexto: [Introdução](/contacts-api/como-funciona/introducao). Escopos: [Escopos da API Key](/contacts-api/como-funciona/escopos-da-api-key).

## Antes de começar

* Chave com escopos que for usar (`contacts:create`, `tags:create`, etc.)
* Auth: `Authorization: Bearer sk_live_...` ou `x-api-key`
* Base URL: `https://api.notifique.dev`

***

## 1. Fluxo no painel (primeira vez)

#### 1A, Pelo painel

1. **Contacts → Tags**, crie etiquetas (`Lead`, `Cliente`)
2. **Custom fields**, chaves como `cidade`, `plano_atual`
3. **Import** ou cadastro manual, telefone **ou** e-mail por linha
4. **Audience → Topics**, temas de marketing (Newsletter, Promoções)
5. **Audience → Segments**, filtros salvos → use **Preview**
6. **Audience → Campaigns**, template + canais + segmento ou IDs → **Run**

Guia de cada peça: [Tópicos](/contacts-api/como-funciona/topicos-de-comunicacao) · [Segmentos](/contacts-api/como-funciona/segmentos-na-audiencia) · [Campanhas](/contacts-api/como-funciona/campanhas-no-painel).

***

## 2. Criar tag (API)

Escopo: **`tags:create`**.

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

```json theme={null}
{
  "name": "Lead"
}
```

Resposta esperada: **200**, guarde o **`id`** para `tagIds` ao criar contatos.

***

## 3. Criar contato (API)

Escopo: **`contacts:create`**.

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

```json theme={null}
{
  "phone": "5511999999999",
  "name": "João Silva",
  "email": "joao@exemplo.com",
  "telegramPeer": "123456789",
  "tagIds": ["clxxTag1"]
}
```

Resposta esperada: **200** com o `id` do contato.

<Note>
  `telegramPeer` é opcional (só para Telegram). Telefone ou e-mail duplicado no workspace → **409**.
</Note>

***

## 4. Listar contatos (API)

Escopo: **`contacts:read`**.

```http theme={null}
GET /v1/contacts?page=1&limit=20&search=joao
Authorization: Bearer sk_live_xxxxx
```

Filtros opcionais: `search`, `tagId`.

***

## 5. Próximos passos na API

| Objetivo             | Escopo típico                                         | Guia                                                            |
| -------------------- | ----------------------------------------------------- | --------------------------------------------------------------- |
| Tópicos de marketing | `topics:*`                                            | [Tópicos](/contacts-api/como-funciona/topicos-de-comunicacao)   |
| Público por regra    | `segments:*`                                          | [Segmentos](/contacts-api/como-funciona/segmentos-na-audiencia) |
| Disparo em lote      | `campaigns:create`, `campaigns:run` + envio por canal | [Campanhas](/contacts-api/como-funciona/campanhas-no-painel)    |

**Campanha:** canais `whatsapp`, `sms`, `email`, `telegram`. Além de `campaigns:run`, a chave precisa de `whatsapp:send`, `sms:send`, etc. quando a fila processar.

***

## Próximos passos

* [Introdução](/contacts-api/como-funciona/introducao): mapa dos conceitos
* [Escopos](/contacts-api/como-funciona/escopos-da-api-key): permissões
* [Templates](/template-api/como-funciona/quick-start): mensagem usada na campanha