# Zixflow — how to use (mcp.ai)

Connect your Zixflow account and use 7 tools for CRM straight from your AI agent. Connect with your own API key. AI-CRM and Messaging Across SMS, Email, and WhatsApp.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_zixflow?ms=1787295900000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `zixflow_create_attribute`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/zixflow`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/zixflow/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/zixflow/create/attribute` — Tool to create a custom attribute for a Zixflow collection or list. Use when you need to add new fields to track specific data types (text, number, email, etc.). Attributes define the structure of you
  - body: { name: string, config: object, target: string, isUnique?: boolean, targetId: string, inputType: string, apiKeyName: string, isEditable?: boolean, isRequired?: boolean, description?: string, defaultValue?: string }
- `POST https://api.mcp.ai/api/zixflow/get/campaign/report/whatsapp` — Tool to retrieve WhatsApp campaign message report. Use when you need to check the delivery status and details of a WhatsApp message sent via campaign.
  - body: { message_id: string }
- `POST https://api.mcp.ai/api/zixflow/get/email/report` — Tool to retrieve email message delivery report from Zixflow. Use when you need to check the delivery status of a sent campaign email. The report includes delivery status (SENT, OPENED, CLICKED, BOUNCE
  - body: { message_id: string }
- `POST https://api.mcp.ai/api/zixflow/get/sms/report` — Tool to retrieve SMS message delivery report from Zixflow. Use when you need to check the delivery status, destination, and other details of a sent SMS campaign message.
  - body: { messageId: string }
- `POST https://api.mcp.ai/api/zixflow/get/whatsapp/template/variables` — Tool to retrieve template variable details for a WhatsApp template. Use when you need to understand what variables a specific WhatsApp template expects before sending a message.
  - body: { phoneId: string, language: string, templateName: string }
- `POST https://api.mcp.ai/api/zixflow/list/attributes/options` — Tool to retrieve the list of options for select/multiselect attributes. Use when you need to get available options for a specific attribute in a collection or list.
  - body: { target: string, targetId: string, attributeId: string }
- `POST https://api.mcp.ai/api/zixflow/list/attributes/status` — Tool to retrieve the list of options for status attributes in Zixflow. Use when you need to fetch available status configurations for a specific attribute within a collection or list.
  - body: { target: string, targetId: string, attributeId: string }

## Example prompts
- "What can I do in Zixflow?"
- "Show me a summary of my Zixflow account"

## More
- Page: https://mcp.ai/zixflow
- Agent spec (llms.txt): https://mcp.ai/zixflow/llms.txt
- Postman collection: https://mcp.ai/zixflow/postman.json