Skip to main content
POST
Create a message

Authorizations

Authorization
string
header
required

Your v3 API key, e.g. ask_live_…

Headers

X-Subaccount-Id
string

Target subaccount for the request. Required unless the API key is authorized for exactly one subaccount (then it defaults to that one). Alternatively pass subaccount_id (or legacy location_id) in the request body. Omitting it on a multi-subaccount key returns 400 subaccount_required.

Body

application/json
conversation_id
string
required
Minimum string length: 1
content
string
required
Required string length: 1 - 8000
channel
enum<string>

Defaults to the conversation's last channel, else CUSTOM.

Available options:
SMS,
EMAIL,
VOICE,
WHATSAPP,
WEBCHAT,
FACEBOOK,
INSTAGRAM,
GMB,
LIVE_CHAT,
CUSTOM
type
enum<string>

Message type. Defaults to TEXT.

Available options:
TEXT,
IMAGE,
VIDEO,
AUDIO,
FILE,
LOCATION,
CONTACT,
SYSTEM,
TOOL_CALL,
TOOL_RESULT,
FUNCTION_CALL,
FUNCTION_RESULT
subaccount_id
string

Target subaccount id. Prefer the X-Subaccount-Id header; this body field is a fallback.

location_id
string

Alias for subaccount_id (GHL location id).

Response

Success

data
object
required
request_id
string
required
error
null