Send Offline Livechat Message

Post
/api/v1/livechat/offline.message

Send the offline message when no agent is available to attend the omnichannel conversation.

Body parameters
Example 1
{
  "name": "Livechat Visitor",
  "email": "[email protected]",
  "message": "I need help",
  "department": "Support",
  "host": "null"
}
object
name
string Required

Message name.

email
string Required

The visitor email.

message
string Required

Message text.

department
string Required

The department name.

host
string Required

The username of the agent.

Responses
200
Success Example
{
  "message": "Livechat offline message sent",
  "success": true
}
object
message
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'name' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string