# Notifique

> Multichannel REST API (9 product channels: WhatsApp, Instagram, SMS, Telegram, Email, Push, RCS, Voice, website chat widget). Base URL: `https://api.notifique.dev/v1`. Authenticate with API Key (`sk_live_` / `sk_test_`) or OAuth 2.1 Bearer. Docs: https://docs.notifique.dev/en. MCP: https://mcp.notifique.dev/mcp (catalog 3.0).

## Get started

- [Start here](https://docs.notifique.dev/en/guides/introducao/comece-aqui)
- [The magic of templates](https://docs.notifique.dev/en/guides/simples assim/a-magia-dos-templates): one concept, many channels (`POST /v1/templates/send`)
- [Localization and i18n](https://docs.notifique.dev/en/guides/conceitos/localizacao-e-i18n): `localization` + `i18n` per channel
- [Platform API](https://docs.notifique.dev/en/platform-api/como-funciona/introducao): account, billing, workspaces, webhooks, logs, OAuth — dashboard parity via `/v1/platform/*`, `/v1/workspaces`, `/v1/webhooks`, `/v1/logs`
- [API keys](https://docs.notifique.dev/en/guides/api-key/index): required scopes per route
- [OAuth 2.1](https://docs.notifique.dev/en/oauth-api/como-funciona/introducao): PKCE, DCR, workspace apps `GET|POST /v1/oauth/apps`
- [Sandbox](https://docs.notifique.dev/en/guides/sandbox/index)
- [Webhooks](https://docs.notifique.dev/en/guides/webhooks/index)
- [Errors](https://docs.notifique.dev/en/guides/conceitos/resposta-de-erros)
- [Notify (fallback)](https://docs.notifique.dev/en/platform-api/como-funciona/notify) · [Metrics](https://docs.notifique.dev/en/platform-api/como-funciona/metrics)
- [MCP](https://docs.notifique.dev/en/build-with-ai/mcp-notifique) · [skill.md](https://docs.notifique.dev/en/skill.md)

## Send channels (API v1)

Canonical body: **`type` + `payload`** (+ `to`, `variables`, `localization`, `i18n`, `metadata`, `schedule`, `options`).

| Channel | Send | Notes |
|---------|------|-------|
| WhatsApp | `POST /v1/whatsapp/messages` | Official Cloud + QR; `type`: text, buttons, list, carousel, media, template; shareable connect-page |
| Instagram | `POST /v1/instagram/messages` | Official + unofficial; comments API |
| SMS | `POST /v1/sms/messages` | `variables` at root for `{{placeholders}}` |
| Telegram | `POST /v1/telegram/messages` | USER (QR) + BOT |
| Email | `POST /v1/email/messages` | CC/BCC, attachments, Reply-To, `headers`, `options.category`; inbound `email.received` |
| Push | `POST /v1/push/messages` | `to` + `payload`; rich options in `options.notification`; `GET` returns `type` + `payload` |
| RCS | `POST /v1/rcs/messages` | BASIC / CARD / CAROUSEL / FILE; list/detail include `payload` |
| Voice | `POST /v1/voice/calls` | speak / TTS / IVR + actions |
| Notify | `POST /v1/notify` | Ordered cascade across API send channels (`fallback[]`, up to 5 steps) |
| Website chat | dashboard / AI widget addon | Admin API `/v1/ai-web-widget`; no public visitor send API |

## Main endpoints

- **Templates:** `POST /v1/templates/send` · Meta sync: `POST /v1/whatsapp/instances/:id/meta/sync-templates`
- **Connect page:** `GET|POST /v1/{whatsapp|telegram|instagram}/instances/:id/connect-page*`
- **CRM:** `/v1/contacts`, `/v1/tags`, `/v1/topics`, `/v1/segments`, `/v1/campaigns` (+ `run-preview`, `cancel`, `stats`, `recipients`)
- **Forms:** `/v1/forms/lists`, `/v1/forms/subscriptions`
- **Short links & conversions:** `/v1/short-links`, `POST /v1/conversions`
- **Automations:** `/v1/automations` (+ `ai-compose`, `quick-chatbot`, `post-campaign-agent`, `duplicate`, `webhook-secret`, `test-trigger`, `batch/delete`) · `/v1/events` (+ `batch/delete`)
- **AI platform:** `/v1/assistants` (+ `invoke`, MCP/HTTP bindings) · `/v1/knowledge-bases` · `/v1/mcp-connections` · `/v1/http-tools`
- **Pipelines:** `/v1/pipelines` (boards, columns, cards, overview)
- **Sending pools:** `/v1/sending-pools` (+ members, stats)
- **AI web widget (admin):** `/v1/ai-web-widget` (CRUD, messages, rotate key/HMAC)
- **Suppressions:** `/v1/suppressions`
- **Phone numbers:** `/v1/phone-numbers` (list, available, orders, regulatory, config, release)
- **OAuth apps:** `/v1/oauth/apps`, `/v1/oauth/connections`
- **Webhooks:** `/v1/webhooks` — create `POST`, update **`PUT /v1/webhooks/{id}`** (full body), `POST /v1/webhooks/{id}/rotate-secret`, deliveries `GET /v1/webhooks/deliveries`
- **Platform:** account `POST /v1/platform/register`, `/verify`, `/login`; billing `/v1/platform/workspaces/:id/*`; API keys `GET/PATCH/DELETE /v1/platform/api-keys/:id`, `POST .../revoke`; `GET /v1/workspaces`; logs `GET /v1/logs/:id`; metrics `GET /v1/metrics/overview`
- **Meta:** `GET /v1/meta/legacy-fields`, `/webhook-events`, `/message-statuses`, `/channels`
- **Pricing:** `GET /v1/pricing`
- **OAuth discovery:** `/.well-known/*`, `/oauth/*`

## Authentication

```
Authorization: Bearer sk_live_xxxxx
# or
x-api-key: sk_live_xxxxx
# or OAuth access token (Bearer JWT)
```

Do **not** send `x-workspace-id` — the key or token already scopes the workspace.

## Build with AI

- This file: `https://docs.notifique.dev/en/llms.txt`
- Skill: `https://docs.notifique.dev/en/skill.md`
- MCP catalog 3.0 (~200 tools; in Cursor: `system.list_domains` → `system.load_domain`; packs: channels, connect-page, forms, short_links, automations, oauth_apps)
- Destructive MCP ops: `NOTIFIQUE_ALLOW_DESTRUCTIVE=true` + `confirm: "YES"`

## Common errors

- 401 `UNAUTHORIZED` · 402 `INSUFFICIENT_CREDITS` / `WORKSPACE_BLOCKED` · 403 missing scope `FORBIDDEN` · 404 resource · 429 rate limit / sandbox