Skip to main content
POST
/
v1
/
bots
/
{botId}
/
users
/
{userId}
/
flow_message
curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/users/593987654321/flow_message \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Hello",
    "text": "Complete this flow to get started",
    "caption": "Jelou",
    "parameters": {
      "flow_name": "welcome_flow",
      "flow_cta": "Start Flow",
      "flow_action_payload": {
        "screen": "RECOMMEND"
      }
    }
  }'

{}
The WhatsApp Flow must already exist in Jelou for the target bot. Reference it by its slug in parameters.flow_name. Both the botId and the recipient’s phone number (userId, without the + sign) go in the URL path. Available only for bots on WhatsApp Cloud API, Gupshup CAPI or Aldeamo providers.
curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/users/593987654321/flow_message \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Hello",
    "text": "Complete this flow to get started",
    "caption": "Jelou",
    "parameters": {
      "flow_name": "welcome_flow",
      "flow_cta": "Start Flow",
      "flow_action_payload": {
        "screen": "RECOMMEND"
      }
    }
  }'

​
Best Practices

Complex Flows: Use flow buttons for complex multi-step interactions that require form inputs, selections, or guided experiences. Flows provide a native WhatsApp experience without leaving the chat.

​
Use Cases

  • Registration forms or surveys
  • Multi-step purchase processes
  • Guided configurations
  • Complex interactive experiences

Authorizations

​
Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Path Parameters

​
botId
string
required

Identifier of the bot whose WhatsApp channel sends the message.

​
userId
string
required

Recipient's phone number, without the + sign.

Query Parameters

​
type
string

Type of WhatsApp Flow to send. Defaults to the standard flow type.

Body

application/json
​
title
string
required

Header shown above the Flow button.

Example:

"Hello"

​
text
string
required

Body text shown above the Flow button.

Example:

"Complete this flow to get started"

​
caption
string
required

Footer text shown below the Flow button.

Example:

"Jelou"

​
parameters
object
required
​
payload
object

Optional extra context cached and returned with the Flow reply.

Response

Flow message sent

The response is of type object.