Skip to main content
POST
Trigger Bot Flow
Starts a specific Keyword Replies flow for a phone number — useful for kicking off a conversation from your own system instead of waiting for the user to message first.
Where to find bot_flow_unique_id: open Chatbot Manager → Automation → Keyword Replies — it’s the Unique ID column shown next to each flow. See Finding Your IDs & API Token for a screenshot.

Body

application/x-www-form-urlencoded
apiToken
string
required

Your ChatSyncs API key (not a WhatsApp/Meta access token). Where to find it.

Example:

"API-KEY"

phone_number_id
string
required

The WhatsApp account's phone number ID. Where to find it.

Example:

"PHONE-NUMBER-ID"

bot_flow_unique_id
string
required

The Bot Flow's unique ID to trigger. Where to find it.

Example:

"BOT-FLOW-UNIQUE-ID"

phone_number
string
required

The subscriber's phone number, with country code, digits only.

Example:

"PHONE-NUMBER"

Response

200 - application/json

Standard ChatSyncs response. status is "1" on success and "0" on failure.

status
string

"1" = success, "0" = failure.

message
string

Human-readable result message.