Skip to main content

WhatsApp Flows

Read the WhatsApp Flow forms built in Forms and the answers clients submit inside WhatsApp. Flows are read only through the API: send a flow from the Team Inbox or an automation. Poll responses with since to get new ones oldest first without skipping any.

API regionapi.whautomate.com

List WhatsApp Flows​

GET /v1/whatsapp-flows

Lists WhatsApp Flows built in Forms, newest update first. status is DRAFT, PUBLISHED or DEPRECATED. Read only: a flow is sent as an inbox message.

Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
locationIdstring
Location (workspace) id. Get ids from GET /v1/locations.
statusstring
One of DRAFT, PUBLISHED, DEPRECATED.
searchTextstring
Text to search for.
pageinteger
Page number, from 1 (default 1).
limitinteger
Results per page (default 10, max 100).
Response 200
idstring
namestring
statusstring (enum)
One of: DRAFT, PUBLISHED, DEPRECATED.
locationobject
responseCountnumber
lastResponseAtstring
createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/whatsapp-flows?locationId=Le6dWjQF9K&limit=2" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "vJduEYBNoE",
    "name": "Book a free consultation",
    "status": "PUBLISHED",
    "location": {
      "id": "Le6dWjQF9K",
      "title": "Serene Wellness Studio"
    },
    "responseCount": 4,
    "lastResponseAt": "2026-10-29T06:43:33.008Z",
    "createdAt": "2026-10-29T11:43:32.963Z",
    "updatedAt": "2026-10-29T11:43:33.024Z"
  }
]

Get a WhatsApp Flow​

GET /v1/whatsapp-flows/{flowId}

Gets a WhatsApp Flow with its fields.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
flowIdstringrequired
Response 200
idstring
namestring
statusstring (enum)
One of: DRAFT, PUBLISHED, DEPRECATED.
locationobject
responseCountnumber
lastResponseAtstring
createdAtstring
updatedAtstring
fieldsobject[]
Request
curl -X GET "https://api.whautomate.com/v1/whatsapp-flows/vJduEYBNoE" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "vJduEYBNoE",
  "name": "Book a free consultation",
  "status": "PUBLISHED",
  "location": {
    "id": "Le6dWjQF9K",
    "title": "Serene Wellness Studio"
  },
  "responseCount": 4,
  "lastResponseAt": "2026-10-29T06:43:33.008Z",
  "createdAt": "2026-10-29T11:43:32.963Z",
  "updatedAt": "2026-10-29T11:43:33.024Z",
  "fields": [
    {
      "key": "main_goal",
      "title": "Main goal",
      "type": "RadioButtonsGroup",
      "required": true,
      "options": [
        "Ease muscle tension",
        "Recover from an injury",
        "Start yoga or Pilates"
      ],
      "section": "Free consultation"
    },
    {
      "key": "current_challenge",
      "title": "Where are you now?",
      "type": "TextArea",
      "required": true,
      "options": [],
      "section": "Free consultation"
    },
    {
      "key": "meeting_format",
      "title": "How would you like to meet?",
      "type": "RadioButtonsGroup",
      "required": true,
      "options": [
        "In person",
        "Video call"
      ],
      "section": "Free consultation"
    }
  ]
}

List WhatsApp Flow responses​

GET /v1/whatsapp-flows/responses

Lists WhatsApp Flow responses, newest first. With since (ISO date) the list is oldest first from that date, so paging never skips a new response.

Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
flowIdstring
Only responses to this flow.
clientIdstring
Client id.
contactIdstring
Only responses from this contact.
locationIdstring
Location (workspace) id. Get ids from GET /v1/locations.
sincestring
ISO date. Returns records from that date, oldest first, so paging never skips a new one.
pageinteger
Page number, from 1 (default 1).
limitinteger
Results per page (default 10, max 100).
Response 200
idstring
flowobject
clientobject

null when the response has no client

contactobject
locationobject
submittedAtstring
answersobject[]

Choice answers are shown as their titles

createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/whatsapp-flows/responses?limit=2" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "B9OXBfGPaZ",
    "flow": {
      "id": "vJduEYBNoE",
      "name": "Book a free consultation"
    },
    "client": {
      "id": "CsoHjs4Wkh",
      "name": "Sarah Pereira",
      "phone": "+6591282647",
      "email": "sarah.pereira@mail.example"
    },
    "contact": {
      "id": null,
      "name": "Sarah Pereira",
      "phone": "+6591282647"
    },
    "location": {
      "id": "Le6dWjQF9K",
      "title": "Serene Wellness Studio"
    },
    "submittedAt": "2026-10-29T06:43:33.044Z",
    "answers": [
      {
        "key": "main_goal",
        "title": "Main goal",
        "type": "RadioButtonsGroup",
        "value": "Ease muscle tension"
      },
      {
        "key": "current_challenge",
        "title": "Where are you now?",
        "type": "TextArea",
        "value": "Tight shoulders from desk work, worse in the evenings."
      },
      {
        "key": "meeting_format",
        "title": "How would you like to meet?",
        "type": "RadioButtonsGroup",
        "value": "In person"
      }
    ],
    "createdAt": "2026-10-29T11:43:33.054Z",
    "updatedAt": "2026-10-29T11:43:33.054Z"
  },
  {
    "id": "RYI0ZDAvDl",
    "flow": {
      "id": "vJduEYBNoE",
      "name": "Book a free consultation"
    },
    "client": {
      "id": "C06pEvnhxM",
      "name": "Kenji Sato",
      "phone": "+6591290566",
      "email": "kenji.sato@mail.example"
    },
    "contact": {
      "id": null,
      "name": "Kenji Sato",
      "phone": "+6591290566"
    },
    "location": {
      "id": "Le6dWjQF9K",
      "title": "Serene Wellness Studio"
    },
    "submittedAt": "2026-10-29T01:43:33.076Z",
    "answers": [
      {
        "key": "main_goal",
        "title": "Main goal",
        "type": "RadioButtonsGroup",
        "value": "Start yoga or Pilates"
      },
      {
        "key": "current_challenge",
        "title": "Where are you now?",
        "type": "TextArea",
        "value": "New to yoga, would like a gentle start twice a week."
      },
      {
        "key": "meeting_format",
        "title": "How would you like to meet?",
        "type": "RadioButtonsGroup",
        "value": "In person"
      }
    ],
    "createdAt": "2026-10-29T11:43:33.084Z",
    "updatedAt": "2026-10-29T11:43:33.084Z"
  }
]

Get a WhatsApp Flow response​

GET /v1/whatsapp-flows/responses/{responseId}

Gets a WhatsApp Flow response with its answers.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
responseIdstringrequired
Response 200
idstring
flowobject
clientobject

null when the response has no client

contactobject
locationobject
submittedAtstring
answersobject[]

Choice answers are shown as their titles

createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/whatsapp-flows/responses/B9OXBfGPaZ" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "B9OXBfGPaZ",
  "flow": {
    "id": "vJduEYBNoE",
    "name": "Book a free consultation"
  },
  "client": {
    "id": "CsoHjs4Wkh",
    "name": "Sarah Pereira",
    "phone": "+6591282647",
    "email": "sarah.pereira@mail.example"
  },
  "contact": {
    "id": null,
    "name": "Sarah Pereira",
    "phone": "+6591282647"
  },
  "location": {
    "id": "Le6dWjQF9K",
    "title": "Serene Wellness Studio"
  },
  "submittedAt": "2026-10-29T06:43:33.044Z",
  "answers": [
    {
      "key": "main_goal",
      "title": "Main goal",
      "type": "RadioButtonsGroup",
      "value": "Ease muscle tension"
    },
    {
      "key": "current_challenge",
      "title": "Where are you now?",
      "type": "TextArea",
      "value": "Tight shoulders from desk work, worse in the evenings."
    },
    {
      "key": "meeting_format",
      "title": "How would you like to meet?",
      "type": "RadioButtonsGroup",
      "value": "In person"
    }
  ],
  "createdAt": "2026-10-29T11:43:33.054Z",
  "updatedAt": "2026-10-29T11:43:33.054Z"
}
Last updated on