# FlowIQ API Documentation - [Introduction](https://docs.flowapt.com/index.md): Message customers on WhatsApp, Instagram and Messenger, run WhatsApp calls, sync tickets, subscriptions and reports, and receive real-time events with the FlowIQ API. - [Quickstart](https://docs.flowapt.com/flowiq-quickstart.md): Create a contact, send a WhatsApp message and read the conversation back in five minutes. - [Conventions](https://docs.flowapt.com/flowiq-api-reference/conventions.md): What every api.flowiq.live/v1 endpoint has in common: request ids, error codes, rate limits and idempotency keys. - [Send Text Message](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-text.md): Send a plain text WhatsApp message to an existing contact. - [Send Image](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-image.md): Send an image message with an optional caption to an existing contact. - [Send Video](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-video.md): Send a video message with an optional caption to an existing contact. - [Send Audio](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-audio.md): Send an audio message to an existing contact. - [Send Document](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-document.md): Send a document message with an optional filename and caption to an existing contact. - [Send Location](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-location.md): Send a location pin to an existing contact. - [Send Contact Card](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-contacts.md): Share one or more contact cards with an existing contact. - [Send Interactive Buttons](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-interactive-buttons.md): Send an interactive button message with up to 3 quick reply buttons. - [Send Interactive List](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-interactive-list.md): Send an interactive list message with sections and selectable rows. - [Send Reaction](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-reaction.md): React to an existing WhatsApp message with an emoji. - [Send Typing Indicator](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-typing.md): Show "typing…" in the customer's WhatsApp chat while you prepare a reply. WhatsApp attaches it to one message the customer sent: that message is marked read, and the indicator shows until you reply or about 25 seconds pass. Nothing is stored as a message. Needs the `send` permission. - [Send Template](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-template.md): Send a single WhatsApp template message to a contact. Each request sends one approved template to one recipient, with support for named/positional body parameters, button URL parameters, and header media. - [Broadcast Analytics](https://docs.flowapt.com/flowiq-api-reference/endpoint/broadcast-analytics.md): Retrieve broadcast analytics for your organization. Supports two modes: - [Get Contact](https://docs.flowapt.com/flowiq-api-reference/endpoint/get-contact.md): Look up an existing contact in your organization by phone number. - [Create Contact](https://docs.flowapt.com/flowiq-api-reference/endpoint/contact.md): Create a new contact. FlowIQ checks whether the number is on WhatsApp: a number confirmed not to be on WhatsApp is rejected with 400, and if the check can't be completed the contact is still created with `whatsapp_verified: null`. - [Conversations](https://docs.flowapt.com/flowiq-api-reference/endpoint/conversations.md): Retrieve messages from a conversation with comprehensive filtering and search capabilities. - [Calling](https://docs.flowapt.com/flowiq-api-reference/calling.md): Run WhatsApp voice calls on your FlowIQ number from your own server: answer, decline, end and start calls, ask for call permission, read call history and transcripts, and change the number's calling settings. - [List Calls](https://docs.flowapt.com/flowiq-api-reference/endpoint/list-calls.md): Calls on your number, newest first, cursor-paged. Scope: read. - [Get Call](https://docs.flowapt.com/flowiq-api-reference/endpoint/get-call.md): One call with every event FlowIQ recorded for it. Scope: read. - [Start Call](https://docs.flowapt.com/flowiq-api-reference/endpoint/start-call.md): Call a customer who has given you call permission. Send your SDP offer; WhatsApp rings the customer and their answer arrives on the call webhook (kind call, event connect, session.sdp_type answer). Scope: send. - [Pre-accept Call](https://docs.flowapt.com/flowiq-api-reference/endpoint/pre-accept-call.md): Optional step before accept: send your SDP answer so the audio connects the moment you accept. Scope: send. - [Accept Call](https://docs.flowapt.com/flowiq-api-reference/endpoint/accept-call.md): Answer a ringing call. Either send your SDP answer to the offer from the call webhook (the audio then flows between WhatsApp and your media server), or send `stream` and FlowIQ answers the call itself and streams the audio to your WebSocket (see Media stream). Scope: send. - [Reject Call](https://docs.flowapt.com/flowiq-api-reference/endpoint/reject-call.md): Decline a ringing call. Scope: send. - [End Call](https://docs.flowapt.com/flowiq-api-reference/endpoint/end-call.md): Hang up a call in progress. Scope: send. - [Get Call Permission](https://docs.flowapt.com/flowiq-api-reference/endpoint/get-call-permission.md): WhatsApp's live answer: may you call this person now, and how many requests and calls you have left. Scope: read. - [Request Call Permission](https://docs.flowapt.com/flowiq-api-reference/endpoint/request-call-permission.md): Ask a customer for permission to call them. Works inside the 24-hour window after they last wrote to you; outside it, send an approved template that has a call permission request (Send Template). Scope: send. - [Get Calling Settings](https://docs.flowapt.com/flowiq-api-reference/endpoint/get-calling-settings.md): WhatsApp's calling settings for your number, and who answers incoming calls. Scope: read (write with include_sip_credentials). - [Update Calling Settings](https://docs.flowapt.com/flowiq-api-reference/endpoint/update-calling-settings.md): Change WhatsApp's calling settings for your number and/or who answers incoming calls. Fields you leave out of calling stay as they are. Scope: write. - [Instagram API](https://docs.flowapt.com/flowiq-api-reference/instagram.md): Send Instagram messages, read conversations and receive events through the FlowIQ API. - [Send Instagram Text](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-instagram-text.md): Send an Instagram text message to an existing contact through FlowIQ, using your organization's API key. - [Send Instagram Image](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-instagram-image.md): Send an Instagram image message to an existing contact through FlowIQ, using your organization's API key. - [Send Instagram Video](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-instagram-video.md): Send an Instagram video message to an existing contact through FlowIQ, using your organization's API key. - [Send Instagram Audio](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-instagram-audio.md): Send an Instagram audio message to an existing contact through FlowIQ, using your organization's API key. - [Instagram Conversations](https://docs.flowapt.com/flowiq-api-reference/endpoint/instagram-conversations.md): Instagram conversation history stored in FlowIQ. Also available as GET /conversations?platform=instagram. Only Instagram messages are returned, even for a contact merged with WhatsApp or email. Does not mark messages read or import earlier Instagram history. Contacts lists connected Instagram identi… - [Messenger API](https://docs.flowapt.com/flowiq-api-reference/messenger.md): Send Facebook Messenger messages, read conversations and receive events through the FlowIQ API. - [Send Messenger Text](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-messenger-text.md): Send a Messenger text message to an existing contact of your Facebook Page through FlowIQ, using your organization's API key. - [Send Messenger Image](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-messenger-image.md): Send a Messenger image message to an existing contact of your Facebook Page through FlowIQ, using your organization's API key. - [Send Messenger Video](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-messenger-video.md): Send a Messenger video message to an existing contact of your Facebook Page through FlowIQ, using your organization's API key. - [Send Messenger Audio](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-messenger-audio.md): Send a Messenger audio message to an existing contact of your Facebook Page through FlowIQ, using your organization's API key. - [Send Messenger File](https://docs.flowapt.com/flowiq-api-reference/endpoint/send-messenger-file.md): Send a Messenger file message to an existing contact of your Facebook Page through FlowIQ, using your organization's API key. - [Messenger Conversations](https://docs.flowapt.com/flowiq-api-reference/endpoint/messenger-conversations.md): Messenger conversation history stored in FlowIQ. Also available as GET /conversations?platform=messenger. Only Messenger messages are returned, even for a contact merged with WhatsApp or email. Does not mark messages read or import earlier Messenger history. Contacts lists people who have messaged y… - [Subscriptions](https://docs.flowapt.com/flowiq-api-reference/subscriptions.md): Read FlowIQ subscriptions, their delivery schedule and upcoming deliveries, and know which Shopify order belongs to which subscription. - [List Subscriptions](https://docs.flowapt.com/flowiq-api-reference/endpoint/list-subscriptions.md): Every subscription in your store, newest first. - [Get Subscription](https://docs.flowapt.com/flowiq-api-reference/endpoint/get-subscription.md): One subscription with its full delivery schedule, past and future, earliest first. - [Upcoming Deliveries](https://docs.flowapt.com/flowiq-api-reference/endpoint/upcoming-deliveries.md): Every subscription delivery scheduled in a date range, earliest first, with customer, shipping address, items and estimated amount. - [Subscription by Shopify Order](https://docs.flowapt.com/flowiq-api-reference/endpoint/subscription-by-order.md): Which subscription a Shopify order belongs to, and which delivery of it the order is. - [Subscription Webhooks](https://docs.flowapt.com/flowiq-api-reference/subscription-webhooks.md): Receive a POST from FlowIQ whenever a subscription is created, renewed, paused, resumed, changed or cancelled, or a payment fails. - [Events](https://docs.flowapt.com/flowiq-api-reference/webhooks.md): Receive real-time events from FlowIQ for WhatsApp and web chat messages (received, sent, delivered, read) and WhatsApp calls. - [Ticket Events](https://docs.flowapt.com/flowiq-api-reference/ticket-webhooks.md): Receive a POST from FlowIQ whenever a ticket is raised, changed, assigned, resolved, reopened or deleted. - [List Webhooks](https://docs.flowapt.com/flowiq-api-reference/endpoint/get-webhooks.md): List all registered webhooks for your organization. - [Create Webhook](https://docs.flowapt.com/flowiq-api-reference/endpoint/create-webhook.md): Register a new webhook endpoint. Optionally configure how FlowIQ authenticates to your server (`auth_type` + `auth_config`), extra static `headers`, and a signing `secret`. Use platform=instagram or messenger for those channels, subscriptions for subscription events and tickets for ticket events. - [Delete Webhook](https://docs.flowapt.com/flowiq-api-reference/endpoint/delete-webhook.md): Remove a registered webhook. Use `GET /get-webhooks` first to find the `id`. - [List Deliveries](https://docs.flowapt.com/flowiq-api-reference/endpoint/list-webhook-deliveries.md): Deliveries to your webhooks, newest first, cursor-paged. Delivered rows are kept 7 days, dead ones 30. Scope: read. - [Get Delivery](https://docs.flowapt.com/flowiq-api-reference/endpoint/get-webhook-delivery.md): One delivery with the body FlowIQ sent (`payload`). Scope: read. - [Retry Delivery](https://docs.flowapt.com/flowiq-api-reference/endpoint/retry-webhook-delivery.md): Send this event to the webhook again now, with the same body and event_id. Works for delivered, failed and dead deliveries. Scope: write. - [Reporting API](https://docs.flowapt.com/flowiq-api-reference/reporting-api.md): Read-only reports for dashboards and scheduled jobs: account activity, conversations, orders, broadcasts, subscriptions and automations. - [AI Assistants (MCP)](https://docs.flowapt.com/flowiq-api-reference/mcp.md): Connect Claude, ChatGPT or any MCP client to your FlowIQ account and work with your WhatsApp business by asking. ## OpenAPI Specs - [openapi-broadcast-analytics](/flowiq-api-reference/openapi-broadcast-analytics.json) - [openapi-calls](/flowiq-api-reference/openapi-calls.json) - [openapi-instagram-send-audio](/flowiq-api-reference/openapi-instagram-send-audio.json) - [openapi-instagram-send-image](/flowiq-api-reference/openapi-instagram-send-image.json) - [openapi-instagram-send-text](/flowiq-api-reference/openapi-instagram-send-text.json) - [openapi-instagram-send-video](/flowiq-api-reference/openapi-instagram-send-video.json) - [openapi-instagram](/flowiq-api-reference/openapi-instagram.json) - [openapi-messenger-send-audio](/flowiq-api-reference/openapi-messenger-send-audio.json) - [openapi-messenger-send-file](/flowiq-api-reference/openapi-messenger-send-file.json) - [openapi-messenger-send-image](/flowiq-api-reference/openapi-messenger-send-image.json) - [openapi-messenger-send-text](/flowiq-api-reference/openapi-messenger-send-text.json) - [openapi-messenger-send-video](/flowiq-api-reference/openapi-messenger-send-video.json) - [openapi-messenger](/flowiq-api-reference/openapi-messenger.json) - [openapi-send-audio](/flowiq-api-reference/openapi-send-audio.json) - [openapi-send-contacts](/flowiq-api-reference/openapi-send-contacts.json) - [openapi-send-document](/flowiq-api-reference/openapi-send-document.json) - [openapi-send-image](/flowiq-api-reference/openapi-send-image.json) - [openapi-send-interactive-buttons](/flowiq-api-reference/openapi-send-interactive-buttons.json) - [openapi-send-interactive-list](/flowiq-api-reference/openapi-send-interactive-list.json) - [openapi-send-location](/flowiq-api-reference/openapi-send-location.json) - [openapi-send-reaction](/flowiq-api-reference/openapi-send-reaction.json) - [openapi-send-template](/flowiq-api-reference/openapi-send-template.json) - [openapi-send-text](/flowiq-api-reference/openapi-send-text.json) - [openapi-send-typing](/flowiq-api-reference/openapi-send-typing.json) - [openapi-send-video](/flowiq-api-reference/openapi-send-video.json) - [openapi-subscriptions](/flowiq-api-reference/openapi-subscriptions.json) - [openapi-webhook-deliveries](/flowiq-api-reference/openapi-webhook-deliveries.json) - [openapi](/flowiq-api-reference/openapi.json) ## Optional - [Dashboard](https://app.flowiq.live) - [Support](mailto:dev@flowapt.com) - [Flowapt](https://flowapt.com) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.