Skip to main content
The Send Flow endpoint triggers a configured automation flow for a specific contact. You provide the flowId of the flow you want to run, and optionally an inboxId to specify which channel the flow should execute on. If inboxId is omitted, ChatbotX uses the contact’s last active channel. A successful request returns HTTP 204 No Content.
POST /api/v1/contacts/{identifier}/flows

Path Parameters

string
required
A contact lookup string. Minimum length: 1 character.

Request Body

string
required
The ID of the flow to trigger. Must be a numeric string matching the pattern \d+. Call GET /api/v1/flows to list available flow IDs in your Workspace.
string
The inbox (channel) to execute the flow on. If omitted, ChatbotX uses the contact’s last active channel. Must be a numeric string matching \d+.

Code Examples

Response

A successful request returns HTTP 204 No Content with no response body, confirming that the flow has been triggered for the contact.
To find the correct flowId, call GET /api/v1/flows to list all flows in your Workspace. To find the correct inboxId, call GET /api/v1/channels.