Message
All the endpoints that can be called on the Message controller.
All of the endpoints require the MESSAGE_CREATE permission.
Creates a new message.
The ticket must already exist. It will clear the ticket's cache before processing this data.
type: number
If you want to send a message in an already existing ticket.
type: ^([0-9]+|calllog|contactform)$
type: string = ' '
Nullable for contactforms and notes.
type: string = ' '
Must be a valid email address format.
type: string = ' '
Must be a valid email address format.
type: number = 0
Add this parameter if it is a reply to an existing message.
type: string = ' '
If this one is empty, it will use the value of the message parameter instead. Only relevant for emails.
type: string
The actual message.
type: number = null
If you want to forward existing files.
type: string 'Y-m-d H:i' = current time
A special parameter as it is a string that would be following the date format specified.
type: number = 0
The ID of the user who created this message.
type: ^open|pending|holding|solved|closed$ = null
Successful response
POST /api/v2/message HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 231
{
"ticketID": "text",
"type": "text",
"toAddress": "text",
"ccInput": "text",
"bccInput": "text",
"respondMessageID": "text",
"plaintext": "text",
"message": "text",
"forwardedFileIDs[]": "text",
"sendAt": "text",
"userID": "text",
"submitStatus": "text"
}Successful response
Creates a ticket and its accompanying message coming from a chatbot.
type: number
type: string
type: string
type: string
Successful response
POST /api/v2/message/chatbot HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 66
{
"brandID": "text",
"message": "text",
"subject": "text",
"from": "text"
}Successful response
Last updated