Skip to main content
Platform API is the remote control for the dashboard: account, billing, workspace, webhooks, and logs — ideal for AI agents and automated provisioning.

​
What is Platform at Notifique?

It’s the API to operate the account and workspace without a UI. An AI agent or script can:
  • Create an account and confirm phone via OTP
  • Log in and get an API key or session
  • Subscribe, cancel, upgrade, and recharge balance
  • Add and list credit cards
  • Create API keys with restricted scopes
  • Manage workspaces (name, defaults, inbound)
  • Configure webhooks and inspect deliveries
  • Audit calls via API logs
  • Connect third-party apps with OAuth 2.1
Think of the web dashboard as the bank app on your phone; Platform API is the same bank, over HTTP.
Sending messages (WhatsApp, SMS, email…) uses channel APIs with the apiKey you get here. Platform handles the account; channels handle messaging.

​
Credentials in the flow

Details: Registration and verification.
Alternative: x-api-key: sk_live_xxxxx.

​
What you can do (quick map)

​
Typical flow (AI agent)

  1. POST /v1/platform/register — data + onboarding survey (validated enums)
  2. POST /v1/platform/verify — OTP code → apiKey + workspaceId
  3. POST /v1/platform/workspaces/:id/payment-methods — tokenize card
  4. POST /v1/platform/workspaces/:id/subscription — subscribe to Basic/Pro/Business
  5. POST /v1/whatsapp/messages (or another channel) with the API key

​
Next steps