Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Your personal access token from Settings → Profile, or a scoped API key (hc_…) created at Settings → Developer → API keys. Send it as Authorization: Bearer <token>.

Path Parameters

​
account_id
integer
required

Account ID

​
conversation_id
integer
required

Conversation display ID

Body

Message payload

​
content
string

Message text. A message needs text or an attachment.

Example:

"Hello from the HueChat API!"

​
message_type
default:outgoing

Defaults to outgoing. Numeric values map to incoming (0), outgoing (1), activity (2), and template (3). Channel and conversation permissions still apply.

Available options:
incoming,
outgoing,
activity,
template
​
private
boolean
default:false

Create an internal note when true.

​
content_type
string
default:text

Message content format, such as text.

​
content_attributes
object

Attributes for the selected content format.

​
additional_attributes
object
​
echo_id
string

Client correlation identifier.

​
source_id
string

External message identifier, where supported.

Response

OK

The response is of type object.