Skip to main content
POST
Post a message to a conversation

Authorizations

x-api-key
string
header
required

Send the API key in the x-api-key header.

Path Parameters

id
string<uuid>
required
Example:

"57f2d879-20f8-4106-9abb-44fa099e0448"

Body

application/json
body
string
required

The note text.

Minimum string length: 1
Example:

"Escalating to the on-call engineer — customer reports the outage is ongoing."

isPrivate
enum<boolean>
required

Must be true: only private (internal) notes are supported in this version. false or omitting the flag is rejected. Public replies will be enabled through this same field in a future version.

Available options:
true
Example:

true

senderId
string

Platform user id. Newer ids are ovuid-<uuid>; legacy users may have bare (e.g. numeric) ids.

Minimum string length: 1
Example:

"ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"

Response

Created message

id
string
required
body
string | null
required
isPrivate
boolean | null
required