v1

latestOpenAPI 3.1.02026-07-26327152.4 KB

Messages

Send WhatsApp Flow

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.

post/v1/bots/{botId}/users/{userId}/flow_message

Path parameters

botIdstring required

Identifier of the bot whose WhatsApp channel sends the message.

userIdstring required

Recipient's phone number, without the + sign.

Query parameters

typestring

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

Request body

titlestring required

Header shown above the Flow button.

textstring required

Body text shown above the Flow button.

captionstring required

Footer text shown below the Flow button.

payloadobject

Optional extra context cached and returned with the Flow reply.

Example request

{
  "title": "Hello",
  "text": "Complete this flow to get started",
  "caption": "Jelou",
  "parameters": {
    "flow_name": "welcome_flow",
    "flow_cta": "Open form",
    "flow_action_payload": {
      "screen": "RECOMMEND"
    }
  }
}

Response

Flow message sent

object required