API Authentication - Zixflow Docs

Zixflow AI APIs use header-based authentication. You must include these headers in every request:

x-api-key: <your-api-key>
x-workspace-id: <your-workspace-id>

Required Headers

x-api-key: Your API key for the workspace.
x-workspace-id: Your workspace ID.

API key permissions

When you create an API key, you select one permission. Use the key that matches the APIs you call:

Permission	Use for
Messaging	Sending messages (SMS, WhatsApp, RCS, Email) and Sendflow
Tracking	Events (identify, track, screen, page, batch)
MCP	MCP server access
Dashboard	CSV Import (people, events, devices)

If the key is valid but does not have the required permission for an endpoint, the API returns 403.

Where to find your API key and workspace ID

You can create/manage your API key and copy your workspace ID from the Zixflow dashboard:

Dashboard path: Settings > Developer > API Keys
Direct link: https://ai.zixflow.com/settings/workspace/developer

Create an API key

Open Developer → API Keys.
Click + Add New.
Enter an API Key Name.
Select the permission (Messaging, Tracking, MCP, or Dashboard).
Click Save.

Create API Key modal showing Messaging, Tracking, MCP, and Dashboard permissions

Example request

curl -X POST "https://api-ai.zixflow.com/api/ingest/sms/v1/message/send" \
  -H "Content-Type: application/json" \
  -H "x-api-key: <your-api-key>" \
  -H "x-workspace-id: <your-workspace-id>" \
  -d '{ "recipient": "919876543210", "message": "Hello", "sender_id": "ZIXFLW", "route": "transactional" }'