# Whautomate — how to use (mcp.ai)

Connect your Whautomate account and use 17 tools for AI chatbots straight from your AI agent. Connect with your own API key. Whautomate is a platform that offers seamless integrations for customer engagement, including AI chatbots, appointment scheduling, and broadcast messaging.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_whautomate?ms=1787291340000`
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. `whautomate_add_contact`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/whautomate`
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/whautomate/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/whautomate/add/contact` — Tool to add a new contact. Use when you need to programmatically create contacts via the API.
  - body: { id?: string, name: string, tags?: string[], notes?: string, stage?: string, location: object, phoneNumber: string, customFields?: object }
- `POST https://api.mcp.ai/api/whautomate/delete/segment` — Tool to delete a specific segment. Use when you need to remove a segment by its ID. Use after confirming you have the correct segmentId.
  - body: { segmentId: string }
- `POST https://api.mcp.ai/api/whautomate/delete/service/category` — Tool to delete a service category. Use when you need to remove a specific service category by its ID. Use after confirming you have the correct serviceCategoryId.
  - body: { serviceCategoryId: string }
- `POST https://api.mcp.ai/api/whautomate/get/account/info` — Tool to retrieve account information for the authenticated user. Use when you need to fetch account details like account name and owner email.
- `POST https://api.mcp.ai/api/whautomate/get/all/webhooks` — Tool to retrieve all registered webhooks. Use after authenticating to audit or inspect existing webhook subscriptions.
  - body: { page?: integer, limit?: integer }
- `POST https://api.mcp.ai/api/whautomate/get/broadcast/by/id` — Tool to retrieve a specific broadcast's details. Use when you have a broadcast ID and need its metadata. Use after confirming the broadcastId is valid, as this returns detailed broadcast data.
  - body: { broadcastId: string }
- `POST https://api.mcp.ai/api/whautomate/get/broadcasts` — Tool to retrieve a list of broadcasts. Use when you need to fetch broadcasts with optional filters such as status or date ranges. Example: "Get all scheduled broadcasts after 2023-01-01T00:00:00Z."
  - body: { page?: integer, limit?: integer, endDate?: string, startDate?: string, locationId?: string, searchText?: string }
- `POST https://api.mcp.ai/api/whautomate/get/contacts` — Tool to retrieve a list of contacts. Use when you need to fetch contacts from WhatsApp with optional pagination and filters.
  - body: { page?: string, tags?: string, limit?: string, channel?: string, locationId?: string, searchText?: string }
- `POST https://api.mcp.ai/api/whautomate/get/messages/of/contact` — Tool to retrieve chat messages for a specific contact. Use after providing a valid contactId. Supports pagination and optional date filtering.
  - body: { page?: integer, endDate?: string, contactId: string, startDate?: string }
- `POST https://api.mcp.ai/api/whautomate/get/segments` — Tool to retrieve a list of segments. Use when you need to fetch segments with optional name filtering and pagination. Segments can be used to organize clients and contacts into groups based on various
  - body: { page?: integer, limit?: integer, locationId?: string, searchText?: string }
- `POST https://api.mcp.ai/api/whautomate/get/service/by/id` — Tool to retrieve details of a specific service by its unique ID. Use when you need comprehensive service information.
  - body: { serviceId: string }
- `POST https://api.mcp.ai/api/whautomate/get/service/categories` — Tool to retrieve a list of service categories. Use when you need to list categories with optional pagination.
  - body: { limit?: integer, offset?: integer }
- `POST https://api.mcp.ai/api/whautomate/get/services` — Tool to retrieve a list of services with optional filters. Use when you need to fetch available services for display or scheduling.
  - body: { page?: integer, limit?: integer, locationId?: string, searchText?: string, serviceType?: string }
- `POST https://api.mcp.ai/api/whautomate/get/staff/availability/blocks` — Tool to retrieve a staff member's blocked time schedule over a date range. Use when you need to view unavailable slots after confirming staffId and desired date range.
  - body: { endDate?: string, staffId: string, startDate?: string }
- `POST https://api.mcp.ai/api/whautomate/get/staff/by/id` — Tool to retrieve detailed information about a specific staff member. Use when you have a valid staff ID and need full profile details. Use after confirming staffId.
  - body: { staffId: string }
- `POST https://api.mcp.ai/api/whautomate/get/staffs` — Tool to retrieve a list of staff members. Use when you need to list staff with optional pagination or search filters.
  - body: { page?: integer, limit?: integer, locationId?: string, searchText?: string }
- `POST https://api.mcp.ai/api/whautomate/update/service` — Tool to update an existing Whautomate service. Use when you need to modify service attributes like name, pricing, duration, or active status.
  - body: { name?: string, active?: boolean, credits?: integer, costPrice?: number, serviceId: string, sortOrder?: integer, sellingPrice?: number, durationMinutes?: integer, allowOnlineBooking?: boolean, acceptPaymentOnline?: boolean }

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

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