Skip to main content
POST
Fire a proactive message on demand

Authorizations

api_access_token
string
header
required

All API requests must include the api_access_token header with a valid agent or administrator token.

Path Parameters

account_id
integer
required

Numeric ID of the account

Body

application/json
conversation_id
integer
required

Target conversation id (caller must have access)

content
string
required

Message body (or template body)

content_type
string
default:text

text (default), input_select, template, etc.

content_attributes
object

Template/interactive payload (template name, params, buttons)

event_type
string
default:manual

Log label (default 'manual', e.g. tracking, promo)

Response

Message queued or sent

id
integer

Proactive event id

status
string

sent or deferred (deferred = queued past quiet hours)

conversation_id
integer

Target conversation id