Quick Start

​

In short

• Contact = the person. Tag = label. Topic = consent per theme. Segment = saved filter. Campaign = batch send.
• Use the API reference on the Contacts tab for exact routes.

​

Before you start

• Key with scopes you need (contacts:create, tags:create, etc.)
• Auth: Authorization: Bearer sk_live_... or x-api-key
• Base URL: https://api.notifique.dev

​

1. Dashboard flow (first time)

​

1A, Via dashboard

1. Audience → Tags, create labels (Lead, Customer)
2. Custom fields, keys like city, current_plan
3. Import or manual entry in Audience → Contacts, phone or email per row
4. Audience → Topics, marketing themes
5. Audience → Segments, saved filters → use Preview
6. Audience → Campaigns, template + channels + segment or IDs → Run

​

2. Create tag (API)

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

{
  "name": "Lead"
}

​

3. Create contact (API)

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

{
  "phone": "5511999999999",
  "name": "John Silva",
  "email": "john@example.com",
  "telegramPeer": "123456789",
  "tagIds": ["clxxTag1"]
}

​

4. List contacts (API)

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

​

5. Next API steps

​

Next steps

• Introduction: concept map
• Scopes
• Templates: message used in campaigns