Quick Start

​

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.

​

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

​

2. Criar tag (API)

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

{
  "name": "Lead"
}

​

3. Criar contato (API)

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

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

​

4. Listar contatos (API)

GET /v1/contacts?page=1&limit=20&search=joao
Authorization: Bearer sk_live_xxxxx

​

5. Próximos passos na API

​

Próximos passos

• Introdução: mapa dos conceitos
• Escopos: permissões
• Templates: mensagem usada na campanha