Wassenger Flows API

openapi: 3.2.0
info:
  title: Wassenger Flows API
  version: 1.0.0
  description: '**API documentation for Wassenger**


    > 🔥 🆕 **Introducing Flows**: No-Code Automation Solution to create AI agents and automate anything on WhatsApp! Learn more


    ## Introduction


    This API documentation provides detailed information about the API endpoints and request/response API contracts. You can easily browse all the API resources, request/response the with code examples in 15+ programming languages, including JavaScript/Node.js, Python, PHP, Ruby, Java, C#, Go, Swift, Kotlin, ObjectiveC, C/C++, cURL, Powershell and more. This is a web based API, therefore is only required to send HTTPS requests in order to communicate with the API, making it very easy to use and integrate with any third-party software, programming language, CMS, CRM or CLI tools. The API does not require any SDK and has no strict software dependencies, it can be easily used with no friction by simply sending HTTPS requests to the desired API endpoint. > 🤩 🤖 **Ask the Wassenger AI Assistant to write code for you** 👉


    ## Security


    This API is intended for use exclusively in server-side applications. Attempting to use them in a client-side application will result in Cross-Origin Resource Sharing (CORS) errors. This restriction is intentional and ensures the security and integrity of the service. ## Tutorials


    Learn how to use the API exploring our handy tutorials with detailed code examples and live API testing:


    - 💬 Send messages to phone numbers

    - 💬 Send messages to group chats

    - 💬 Send messages to channel 🆕

    - 💬 Send messages from a CSV file 🆕

    - 💬 Send messages from a Google Sheets document 🆕

    - 📁 Send multimedia messages (images, videos, documents, files or audios)

    - 💬 Include emojis in text messages

    - 💬 Send location messages

    - 💬 Send contacts

    - 💬 Send URL links in text messages

    - 💬 Send auto-expiring messages

    - 💬 Send messages in real-time without queueing

    - 💬 Send messages through a specific WhatsApp number/device

    - 💬 Send messages on behalf of a chat agent

    - 💬 Send messages replying to a specific message

    - 💬 Send dynamic buttons message

    - 💬 Send dynamic list message

    - 📝 How to use template variables

    - 📝 How to format text with styling in messages

    - ✅ Check if a phone number exists in WhatsApp and can receive messages


    ## Chatbots 🔥


    - 🤖 Create a custom chat bot using the API + Webhooks 🆕

    - 🤖 Create a ChatGPT-powered AI chatbot assistant for your business 🆕


    ## MCP 🆕


    MCP (acronym of Model Context Protocol) connector lets you connect your Wassenger WhatsApp numbers into modern AI LLMs and chat with your WhatsApp data, analyze conversation, send messages, or perform any other WhatsApp action directly from your favorite AI chat or code tool. - 🤖 **Learn how to use MCP with your AI tool**


    ## Integrations


    - n8n: integrate with 600+ third-party apps

    - Zapier: integrate with 6000+ third-party apps

    - Make (formerly Integromat): integrate with 2000+ third-party apps

    - Integrately: integrate with 1200+ third-party apps

    - Google Sheets

    - Hubspot

    - Shopify

    - Zoho CRM

    - Salesforce

    - Microsoft Dynamics

    - Pipedrive

    - Bitrix24

    - Airtable

    - Notion

    - Nimble CRM

    - Monday.com


    ## Live API testing


    Explore the live API testing using real use cases with dozens of ready-to-use examples:


    - **Go to the API client live tester**


    - **Explore, test and debug the API using Postman graphical HTTP client**


    ### API examples


    Explore the many API use cases in the API tester ready-to-use code examples available in 15+ programming languages. > 🤩 🤖 **Ask the Wassenger AI Assistant to write code for you** 👉


    Find below each relevant API endpoint documentation with more ready-to-use code examples. ## How to use the API


    Search or browse the API endpoint by name or action to perform in the left bar. Then click on the API endpoint and browse the details of the request/response, including query or body required/optional parameters and possible valid responses.'
  x-traitTag: true
  x-logo:
    url: https://api.wassenger.com/v1/static/accounts/waplatform/fenix/logo.png
    backgroundColor: '#FFFFFF'
    altText: Wassenger
servers:
- url: https://api.wassenger.com/v1
tags:
- description: Manage and send WhatsApp Flows (interactive multi-screen in-chat experiences).
  name: Flows
paths:
  /waba/flows/responses:
    parameters: []
    get:
      summary: List the responses to a WhatsApp Form
      description: Answers customers sent through a WhatsApp Form (Meta WhatsApp Flow), newest first. Only the account owner and admins can read them.
      operationId: getFlowResponses
      tags:
      - Flows
      security:
      - apiKey: []
      parameters:
      - in: query
        name: id
        required: true
        description: WhatsApp Form ID (the "id" returned by GET /waba/flows)
        schema:
          type: string
          maxLength: 24
          minLength: 24
          pattern: ^[a-fA-F0-9]{24}$
      - in: query
        name: from
        description: First day (YYYY-MM-DD, UTC)
        schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
      - in: query
        name: to
        description: Last day (YYYY-MM-DD, UTC)
        schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
      - in: query
        name: campaign
        description: Only responses to this campaign
        schema:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
      - in: query
        name: device
        description: Only responses received on this number
        schema:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
      - in: query
        name: page
        description: Page, from 0
        schema:
          type: integer
          minimum: 0
      - in: query
        name: size
        description: Responses per page (default 25)
        schema:
          type: integer
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: A page of responses, newest first, with the total
        '403':
          description: The key belongs to a team member who is not an admin
        '404':
          description: No such form in this account
  /waba/flows:
    parameters: []
    get:
      summary: List WhatsApp Flows
      operationId: getFlows
      tags:
      - Flows
      security:
      - apiKey: []
      parameters:
      - in: query
        name: waba
        description: Filter by WhatsApp Business Account (WABA) ID
        schema:
          type: string
      - in: query
        name: status
        description: Filter by flow status (DRAFT, PUBLISHED, DEPRECATED, THROTTLED, BLOCKED)
        schema:
          type: string
      responses:
        '200':
          description: List of WhatsApp Flows
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: Token
      in: header
      description: 'User API key token needs to be used on every API request that requires authentication.




        You can define it via "token" URL query param or via "Token" HTTP request header.




        Get or create your API key from the [Web Console](https://console.wassenger.com/apikeys).




        **Note**: chat agents and supervisors have no access to the API.




        #### Example as request header:


        ```


        GET /v1/messages HTTP/1.1


        Host: api.wassenger.com:443


        Token: 5f2296349b12abf18c3e4a072cfceb47f51bde312477d048a0baf7cccf4af17861e28f80739d3a3f


        ```


        #### Example as URL query param:


        ```


        GET /v1/messages?token=5f2296349b12abf18c3e4a072cfceb47f51bde312477d048a0baf7cccf4af17861e28f80739d3a3f HTTP/1.1


        Host: api.wassenger.com:443


        ```'
    keypassToken:
      type: apiKey
      name: Authorization
      in: header
      description: Account-wide keypass token in the Authorization header (issued via the extension download).
externalDocs:
  description: Website
  url: https://app.wassenger.com
x-tagGroups:
- name: Messages (outbound)
  tags:
  - Messages
- name: Numbers Management
  tags:
  - Devices
  - Session
  - Groups
  - Channels
  - Queue
  - Settings
  - Profile
  - Contacts
  - Team Members
  - Departments
  - Labels
  - Automatic Replies
  - Automatic Assignment
  - Automatic Resolution
  - Quick Replies
  - Meeting Links
  - Business catalog
  - Billing
- name: Chat
  tags:
  - Chats
  - Chat Messages
  - Chat Contacts
  - Chat Files
  - User Status
  - Analytics
- name: Sales Funnel
  tags:
  - Pipeline
  - Deals
- name: Campaigns
  tags:
  - Campaigns
- name: WhatsApp Business API
  tags:
  - Templates
  - Templates Pricing
  - Catalog
  - Flows
- name: Files Storage
  tags:
  - Files
- name: Notifications
  tags:
  - Webhooks
- name: Utilities
  tags:
  - Verify
x-mcp:
  protocolVersion: '2025-11-25'
  capabilities:
    tools: {}
    prompts: {}
    logging: {}
    completions: {}
  servers:
  - url: https://api.wassenger.com/mcp
    description: 'MCP server (beta). Authenticate with an Authorization Bearer header holding your API key. Setup guide: /help/mcp'
x-express-openapi-disable-response-validation-middleware: true
x-express-openapi-additional-middleware:
- null
x-express-openapi-schema-extension:
  definitions:
    schema:
      properties:
        oneOf:
          type: array
          minItems: 1
          items: {}