# Pingmee

- [Introduction](https://docs.pingmee.co.il/index.md): Working with Pingmee Micro Services
- [Send Message](https://docs.pingmee.co.il/api-reference/messages/send-message.md): Send a message
- [Send Template](https://docs.pingmee.co.il/api-reference/messages/send-template.md): Send a WhatsApp template message
- [Get Messages](https://docs.pingmee.co.il/api-reference/messages/get-messages.md): Fetches messages for a conversation identified by the business phone number and the customer (target) phone number. Results are ordered newest first. Omit `startKey` on the first request. For each following batch, set `startKey` to the `lastEvaluatedKey` value returned by the previous response.
- [Get Conversations](https://docs.pingmee.co.il/api-reference/conversation/get-all.md): Get conversations using cursor-based pagination.
- [Get Conversation](https://docs.pingmee.co.il/api-reference/conversation/get.md): Get a single conversation by participants identifiers. Path `id` must be URL-encoded.
- [Set Status](https://docs.pingmee.co.il/api-reference/conversation/status.md): Set the status of a conversation. Path `id` is the conversation `participantsIdentifiers` (URL-encoded).
- [Set Answer Mode](https://docs.pingmee.co.il/api-reference/conversation/answer-mode.md): Set the answer mode for a conversation. Path `id` is the conversation `participantsIdentifiers` (URL-encoded).
- [Get Conversation Tags](https://docs.pingmee.co.il/api-reference/conversation/tags-get.md): Returns the tag IDs assigned to a conversation. Path `id` is the conversation `participantsIdentifiers` (URL-encoded).
- [Assign Tags to Conversation](https://docs.pingmee.co.il/api-reference/conversation/tags-assign.md): Assigns one or more tags to a conversation. Path `id` is the conversation `participantsIdentifiers` (URL-encoded).
- [Remove Tags from Conversation](https://docs.pingmee.co.il/api-reference/conversation/tags-remove.md): Removes one or more tags from a conversation. Path `id` is the conversation `participantsIdentifiers` (URL-encoded).
- [Assign Agents](https://docs.pingmee.co.il/api-reference/conversation/agents/assign.md): Associate agents to a conversation. Path `id` is the conversation `participantsIdentifiers` (URL-encoded).
- [Unassign Agents](https://docs.pingmee.co.il/api-reference/conversation/agents/unassign.md): Remove agents from a conversation. Path `id` is the conversation `participantsIdentifiers` (URL-encoded).
- [Get Phone Numbers](https://docs.pingmee.co.il/api-reference/business/get-phone-numbers.md): List connected WhatsApp (and Green-API) phone numbers for the authenticated business. Call this before creating a workflow: if more than one number is returned, ask the user which one to bind. Copy the chosen row's `id` into the workflow `associatedToBusinessId` (not `associatedBusinessId`, which is…
- [Get WhatsApp Templates](https://docs.pingmee.co.il/api-reference/business/get-templates.md): List WhatsApp message templates for a connected phone number (`type=whatsapp` and `phoneNumberId` required). `phoneNumberId` is the workflow `associatedToBusinessId` (GET `/phone-numbers` row `id`). Call this for **starter/outbound** bots (`workflowTrigger`, POST `/workflows/{id}/trigger`, campaign-…
- [Get Webhooks](https://docs.pingmee.co.il/api-reference/webhook/get.md): Returns all webhooks for the authenticated account.
- [Create Webhook](https://docs.pingmee.co.il/api-reference/webhook/create.md): Creates a new webhook subscription.
- [Delete Webhook](https://docs.pingmee.co.il/api-reference/webhook/delete.md): Deletes a webhook by ID. Path `webhookId` must be URL-encoded.
- [Get Tags](https://docs.pingmee.co.il/api-reference/tags/get-all.md): Returns all conversation tags
- [Get Tag](https://docs.pingmee.co.il/api-reference/tags/get.md): Returns a conversation tag
- [Create Tag](https://docs.pingmee.co.il/api-reference/tags/create.md): Creates a new conversation tag. Send `{ title, color }` only — the server assigns `id` and `associatedTo`. Duplicate title in the same workspace returns 400. There is no POST /conversation/tags.
- [Delete Tag](https://docs.pingmee.co.il/api-reference/tags/delete.md): Deletes a conversation tag by id
- [Get Conversation Statuses](https://docs.pingmee.co.il/api-reference/conversation/statuses-get-all.md): Returns all custom conversation statuses for the authenticated business. These are business-defined status labels (title and color), not the conversation `statusCase` (`open` / `closed` / `standby`).
- [Get Task Statuses](https://docs.pingmee.co.il/api-reference/tasks/statuses-get-all.md): Returns all custom task statuses for the authenticated business. These are business-defined status labels (title and color), not the built-in task `statusCase` values (`open` / `standby` / `completed`).
- [Create Task Status](https://docs.pingmee.co.il/api-reference/tasks/statuses-create.md): Creates a custom task status. `title` and `color` are required. Titles must be unique for the business.
- [Delete Task Status](https://docs.pingmee.co.il/api-reference/tasks/statuses-delete.md): Deletes a custom task status by ID.
- [Get Agents](https://docs.pingmee.co.il/api-reference/conversation/agents/get-all.md): Returns all agents associated with the authenticated account.
- [Get Agent](https://docs.pingmee.co.il/api-reference/conversation/agents/get.md): Returns a single agent by ID (email). Path `id` must be URL-encoded.
- [Get AI Agents](https://docs.pingmee.co.il/api-reference/ai-agents/get-all.md): Returns a flat paginated list of AI agents for the authenticated business. Pass `flat=true` to skip folder grouping. Distinct from human agents under `/agents`.
- [Get AI Agent](https://docs.pingmee.co.il/api-reference/ai-agents/get.md): Returns a single AI agent by ID, including vector store files when available. Path `id` must be URL-encoded.
- [Update AI Agent](https://docs.pingmee.co.il/api-reference/ai-agents/update.md): Updates an AI agent. Supported fields: `name`, `description`, `roles`, and `vectorStore.required`. Changed roles regenerate their OpenAI function tools.
- [Get Customers](https://docs.pingmee.co.il/api-reference/customers/get-all.md): Returns all customers using pagination
- [Get Customer](https://docs.pingmee.co.il/api-reference/customers/get.md): Returns a Customer
- [Create Customers](https://docs.pingmee.co.il/api-reference/customers/create.md): Creates one or more customers.
- [Update Customer](https://docs.pingmee.co.il/api-reference/customers/update.md): Updates editable customer fields. This is a partial update — only include the fields you want to change. `customerName` is not updatable here.
- [Delete Customer](https://docs.pingmee.co.il/api-reference/customers/delete.md): Deletes a single customer based on the ID supplied
- [Get Tasks](https://docs.pingmee.co.il/api-reference/tasks/get-all.md): Returns tasks using cursor-based pagination. Default page size is 50; the maximum is 100.
- [Get Task](https://docs.pingmee.co.il/api-reference/tasks/get.md): Returns a single task by ID.
- [Update Task](https://docs.pingmee.co.il/api-reference/tasks/update.md): Partial update — send only the fields you want to change. The server always refreshes `updatedAt` and `agentIdentification`, and increments `unreadCount`.
- [Delete Task](https://docs.pingmee.co.il/api-reference/tasks/delete.md): Deletes a single task by ID.
- [Get Task Statuses](https://docs.pingmee.co.il/api-reference/tasks/statuses-get-all.md): Returns all custom task statuses for the authenticated business. These are business-defined status labels (title and color), not the built-in task `statusCase` values (`open` / `standby` / `completed`).
- [Create Task Status](https://docs.pingmee.co.il/api-reference/tasks/statuses-create.md): Creates a custom task status. `title` and `color` are required. Titles must be unique for the business.
- [Delete Task Status](https://docs.pingmee.co.il/api-reference/tasks/statuses-delete.md): Deletes a custom task status by ID.
- [Workflow node documentation](https://docs.pingmee.co.il/workflows-documentation.md): Where to author workflows via MCP, and when the board UI catalog is optional
- [Build a workflow](https://docs.pingmee.co.il/build-workflows/overview.md): Create a complex workflow graph and save it through the Workflows API
- [Workflow document](https://docs.pingmee.co.il/build-workflows/document.md): Top-level fields on GET / POST / PUT /workflows/{workflowId}
- [Canvas vs execution](https://docs.pingmee.co.il/build-workflows/canvas-vs-execution.md): How React Flow data and parsedData + trigger stay in sync
- [Nodes and edges](https://docs.pingmee.co.il/build-workflows/nodes-and-edges.md): React Flow JSON, parsedData WorkflowNode shape, handle IDs, and NodeType fragments
- [Variables and parameters](https://docs.pingmee.co.il/build-workflows/variables.md): Fixed, Expression, and Custom bindings; output catalog, template slots, HTTP/Task placeholders, conditions, and triggerData
- [Sub-nodes](https://docs.pingmee.co.il/build-workflows/sub-nodes.md): Answers, true/false, switch cases, fallback, and timeout
- [Sub-workflows](https://docs.pingmee.co.il/build-workflows/sub-workflows.md): Workflow pointer, workflow trigger, resume, and shared timeout/fallback
- [Examples](https://docs.pingmee.co.il/build-workflows/examples.md): Sanitized dual-graph patterns from real WorkflowsTable documents
- [Workflow analytics](https://docs.pingmee.co.il/build-workflows/analytics.md): Fetch canvas analytics from GET, interpret drop-off, then PUT graph changes
- [Hard rules](https://docs.pingmee.co.il/build-workflows/rules.md): Failures that look silent: 409, inactive child, missing parsedData, wrong handles
- [Get Workflows](https://docs.pingmee.co.il/api-reference/workflows/get-minimal.md): List workflows (minimal).
- [Get Workflow](https://docs.pingmee.co.il/api-reference/workflows/get.md): Returns the full workflow document, including canvas `data`, execution `parsedData`, `trigger`, `variables`, `settings`, and (on the Expert AI plan) `analytics`. If `analytics` is omitted, the plan may not include canvas analytics — do not invent counts. There is no separate analytics GET. Path `wor…
- [Create Workflow](https://docs.pingmee.co.il/api-reference/workflows/create.md): Create a workflow. Client supplies `workflowId` in the path (URL-encode it). Required query: `folderId`. Body requires `name`. Before saving, GET `/phone-numbers`, ask the user which number to bind, and set `associatedToBusinessId` to that row's `id` plus `platformType`. Infer intent: if the bot **o…
- [Update Workflow](https://docs.pingmee.co.il/api-reference/workflows/update.md): Update a workflow. `name`, `isActive`, `settings`, and `associatedToBusinessId` can be sent alone — including `{ isActive: true }` to activate without sending a graph. If `data` or `parsedData` is present, this is a graph update: also send `trigger`, `triggerType`, `variables`, `autoLayout: true`, a…
- [Create Folder](https://docs.pingmee.co.il/api-reference/workflows/create-folder.md): Create a workflow folder. Client supplies `id` in the path (URL-encode it). Body requires `{ name }`. Use this folder id as `folderId` when creating a workflow, or reuse `folderId` from POST `/workflows` (minimal list).
- [Trigger Workflow](https://docs.pingmee.co.il/api-reference/workflows/trigger.md): Manually trigger a bot workflow for a conversation. This call is a **starter**: it opens the thread from the business side, so the workflow's first WhatsApp node must be `messageType: template` + `templateType: whatsapp` with an APPROVED catalog template. Optional body `triggerData` is copied onto t…
- [Reset Workflow Analytics](https://docs.pingmee.co.il/api-reference/workflows/analytics-reset.md): Zeros every canvas analytics counter on this workflow (`totalStarted`, `totalCompleted`, `totalDropped`, `nodeStats`, `edgeStats`, `buttonStats`). No request body. Requires the Expert AI plan (`403` otherwise). Destructive — call only when the user explicitly asks. Returns the updated workflow docum…
- [Introduction](https://docs.pingmee.co.il/make.md): Use Pingmee in Make.com and automate your workflows
- [Introduction](https://docs.pingmee.co.il/n8n.md): Use Pingmee in n8n and automate your workflows

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Updates](https://pingmee.co.il/updates/)
- [Academy](https://pingmee.co.il/academy/)