Send Message or Private Note
The send message endpoint allows you to send messages or private notes to existing tickets programmatically.
Endpoint
PUT /api/messageAuthentication
Requires API token authentication
Subject to rate limiting
Behavior
You can send two types of messages:
External messages: visible to the customer and delivered through the ticket's integration channel (e.g. email, Discord, Telegram).
Internal notes: private messages only visible to your support team inside the Mava dashboard.
If no messageType is specified, the message defaults to an External Message.
Request Body
ticketId
string
Yes
The ID of the ticket to send the message to
content
string
No*
The text content of the message
messageType
string
No
The type of message to send. Accepted values: ExternalMessage, InternalNote. Defaults to ExternalMessage
attachments
array
No*
A list of file attachments to include with the message
attachments[].fileName
string
Yes (if attachments)
The display name of the file
attachments[].url
string
Yes (if attachments)
The publicly accessible URL of the file
attachments[].fileType
string
Yes (if attachments)
The MIME type of the file (e.g. image/png, application/pdf)
*Either content or attachments must be provided.
Valid Values
messageType:"ExternalMessage","InternalNote"— Defaults to "ExternalMessage"
Response
Success (200)
Bad Request (400)
Returned when required fields are missing or the ticket is not found.
Unauthorized (401)
Returned when the API key is missing or invalid.
Too Many Requests (429)
Returned when the rate limit is exceeded. The API allows up to 90 requests per 30 seconds per API key.
Internal Server Error (500)
Code Examples
Curl
NodeJS
Schema
Sending an Internal Note
To send a message that is only visible internally to your team, set messageType to InternalNote:
Last updated