Set Livechat Appearance

Prev Next
Post
/api/v1/livechat/appearance

Update the livechat widget appearance settings. Permission required: view-livechat-manager

Changelog

Version Description
6.4.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters

An array of objects containing the _id and value of the settings to be updated. See Get LiveChat Appearance example response for the _id of each setting.

Example 1
[
  {
    "_id": "Livechat_title",
    "value": "Hello"
  },
  {
    "_id": "Livechat_show_agent_email",
    "value": false
  },
  {
    "_id": "Livechat_show_agent_info",
    "value": true
  },
  {
    "_id": "Livechat_title_color",
    "value": "#b427bed"
  }
]
Array of object
object
_id
string Required
value
boolean Required
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must be array [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "invalid-setting"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string