---
title: "Send WhatsApp Flow"
method: POST
path: "/v1/bots/{botId}/users/{userId}/flow_message"
tags: ["Messages"]
---

# Send WhatsApp Flow

`POST /v1/bots/{botId}/users/{userId}/flow_message`

Send a WhatsApp message with a button that opens a WhatsApp Flow. The Flow must already exist in Jelou for the target bot (referenced by its slug in `parameters.flow_name`). Only available for bots on WhatsApp Cloud API, Gupshup CAPI or Aldeamo providers.

## Path parameters

- `botId` string, required
- `userId` string, required

## Query parameters

- `type` string

## Request body

- FlowMessageRequest
  - `title` string, required — Header shown above the Flow button.
  - `text` string, required — Body text shown above the Flow button.
  - `caption` string, required — Footer text shown below the Flow button.
  - `parameters` FlowParameters, required
    - `flow_name` string, required — Slug (name) of the WhatsApp Flow created in Jelou for this bot.
    - `flow_cta` string, required — Text shown on the button that opens the Flow (max 30 characters).
    - `flow_action_payload` object, required — Navigation payload sent to the Flow when it opens.
      - `screen` string, required — Id of the initial Flow screen to render.
      - `data` object — Optional data to prefill into the initial Flow screen.
  - `payload` object — Optional extra context cached and returned with the Flow reply.

## Response `200`

Flow message sent

- object

## Other responses

- `400` — Bad request - Invalid format or missing required fields
- `401` — Unauthorized - Invalid authentication credentials
- `404` — Not found - Resource not found

---

[API](https://skmtc.net/jelou/apis/jelou-api.md) · [All operations](https://skmtc.net/jelou/apis/jelou-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jelou/jelou-api/revisions/845ce127d94a/schema)