For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
AcademyContact SalesHelp CenterDashboard
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
  • Get Started
    • Introduction
    • Authentication
  • Resources
    • Dynamic Prompt Injection
    • Outbound Number Pooling
    • Timezones
  • Platform API
      • POSTCreate a chat
      • GETList chats
      • GETGet a chat
      • DELDelete a chat
      • POSTSend a message in a chat
      • POSTStart an outbound chat conversation
LogoLogo
AcademyContact SalesHelp CenterDashboard
Platform APIChat

Start an outbound chat conversation

||View as Markdown|
POST
/chat/outbound
POST
/v2/chat/outbound
$curl -X POST https://api.synthflow.ai/v2/chat/outbound \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "agent_id": "2a886b7d-d52d-4f8b-8ea0-19d3edc79214",
>  "channel": "whatsapp",
>  "to_number": "+15559876543",
>  "from_number": "+15551234567",
>  "initial_message": "Hi! How can I help you today?"
>}'
1{
2  "status": "ok",
3  "response": {
4    "conversation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5  }
6}
Create a new outbound WhatsApp or SMS conversation for a chat agent.
Was this page helpful?
Previous

Create a simulation case

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
agent_idstringRequiredformat: "uuid"
The ID of the chat agent that will handle the conversation.
channelenumRequired
Outbound messaging channel.
Allowed values:
to_numberstringRequired
Recipient phone number in E.164 format.
from_numberstringRequired
Twilio sender phone number in E.164 format.
initial_messagestringOptional

Freeform opening message. For WhatsApp, this is only valid within the 24-hour customer service window.

templateobjectOptional

Approved Twilio Content Template for WhatsApp outbound messages. Required outside the 24-hour customer service window, optional within it.

custom_variablesmap from strings to anyOptional
Custom prompt variables to inject into the agent configuration for this conversation.

Response

200
statusstring
Whether the request was successful.
responseobject

Errors

400
Bad Request Error