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

> Monte audiência, template e canal; dispare ou agende uma campanha.

<Tip>
  **Campanha** = envio em massa para um **segmento** (ou lista) com um **template** e **canal** definidos.
</Tip>

## Em poucas palavras

* **Prepare** segmento, template e instância do canal.
* **Crie** a campanha no painel ou com `POST /v1/campaigns`.
* **Dispare** imediato ou agendado; monitore status e métricas.

Contexto: [Campanhas no painel](/contacts-api/como-funciona/campanhas-no-painel). Escopos: [Escopos de campanhas](/contacts-api/como-funciona/campanhas-escopos-da-api-key).

## Antes de começar

| Item                          | Obrigatório                 |
| ----------------------------- | --------------------------- |
| Segmento ou lista de contatos | Audiência                   |
| Template aprovado             | Conteúdo                    |
| Instância conectada           | Canal (e-mail, WhatsApp, …) |
| **`campaigns:create`**        | Para criar via API          |

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

***

## 1. Pelo painel

1. **Campanhas → Nova**
2. Nome interno
3. **Audiência**: segmento (recomendado) ou seleção manual
4. **Canal** + instância
5. **Template** (categoria MARKETING precisa de tópico)
6. **Disparo**: agora ou data/hora
7. Revise prévia e confirme

O painel mostra progresso, entregas e erros por contato.

***

## 2. Criar campanha (API)

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

```json theme={null}
{
  "name": "Newsletter março",
  "segmentId": "clxxSegmentId",
  "channel": "email",
  "instanceId": "clxxInstanceEmail",
  "templateId": "clxxTemplateId",
  "sendAt": null
}
```

`sendAt` em ISO 8601 para agendar; `null` ou omitido para disparo imediato (conforme API).

***

## 3. Consultar campanha

```http theme={null}
GET /v1/campaigns/{campaignId}
Authorization: Bearer sk_live_xxxxx
```

***

## 4. Listar campanhas

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

***

## Boas práticas

* Use **segmentos** em vez de listas estáticas quando a audiência muda com o tempo.
* Templates **MARKETING**: associe **tópico** e respeite `receiveMarketing`.
* Teste com segmento pequeno ou sandbox antes do disparo total.
* Verifique **supressões** — contatos suprimidos não recebem.

***

## Próximos passos

* [Segmentos — Quick Start](/contacts-api/como-funciona/segmentos-quick-start)
* [Supressões — introdução](/suppressions-api/como-funciona/introducao)
* [Introdução — Contatos](/contacts-api/como-funciona/introducao)