Get Livechat Appearance
- Print
- DarkLight
- PDF
Get Livechat Appearance
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/appearance
Get the settings about the widget appearance. 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
Responses
200
OK
Example 1
{
"appearance": [
{
"_id": "Livechat_conversation_finished_message",
"type": "string",
"group": "Omnichannel",
"public": true,
"i18nLabel": "Conversation_finished_message",
"packageValue": "",
"valueSource": "packageValue",
"hidden": false,
"blocked": false,
"sorter": 16,
"i18nDescription": "Livechat_conversation_finished_message_Description",
"autocomplete": true,
"ts": "2021-12-03T16:21:59.851Z",
"_updatedAt": "2021-12-03T16:21:59.851Z",
"createdAt": "2021-12-03T16:21:59.851Z",
"value": "CLOSE!!!",
"secret": false,
"section": "Livechat",
"enterprise": false,
"requiredOnWizard": false,
"env": false,
"enableQuery": "{\"_id\":\"Livechat_enabled\",\"value\":true}"
},
{
"_id": "Livechat_conversation_finished_text",
"_updatedAt": "2023-02-06T17:25:35.940Z",
"autocomplete": true,
"blocked": false,
"createdAt": "2021-12-03T16:21:59.861Z",
"group": "Omnichannel",
"hidden": false,
"i18nDescription": "Livechat_conversation_finished_text_Description",
"i18nLabel": "Conversation_finished_text",
"multiline": true,
"packageValue": "",
"public": true,
"secret": false,
"sorter": 17,
"ts": "2021-12-03T16:21:59.861Z",
"type": "string",
"value": "BYE!!!",
"valueSource": "packageValue",
"section": "Livechat",
"enterprise": false,
"requiredOnWizard": false,
"env": false,
"enableQuery": "{\"_id\":\"Livechat_enabled\",\"value\":true}"
},
{
"_id": "Livechat_display_offline_form",
"type": "boolean",
"group": "Omnichannel",
"public": true,
"section": "Livechat",
"i18nLabel": "Display_offline_form",
"packageValue": true,
"valueSource": "packageValue",
"hidden": false,
"blocked": false,
"sorter": 4,
"i18nDescription": "Livechat_display_offline_form_Description",
"ts": "2021-10-27T22:25:42.892Z",
"_updatedAt": "2021-10-27T22:25:42.892Z",
"createdAt": "2021-10-27T22:25:42.892Z",
"value": true,
"autocomplete": true,
"secret": false,
"enterprise": false,
"requiredOnWizard": false,
"env": false,
"enableQuery": "{\"_id\":\"Livechat_enabled\",\"value\":true}"
},
{
"_id": "Livechat_email_field_registration_form",
"type": "boolean",
"group": "Omnichannel",
"public": true,
"i18nLabel": "Show_email_field",
"packageValue": true,
"valueSource": "packageValue",
"hidden": false,
"blocked": false,
"sorter": 20,
"i18nDescription": "Livechat_email_field_registration_form_Description",
"autocomplete": true,
"ts": "2021-12-03T16:21:59.926Z",
"_updatedAt": "2021-12-03T16:21:59.926Z",
"createdAt": "2021-12-03T16:21:59.926Z",
"value": true,
"secret": false,
"section": "Livechat",
"enterprise": false,
"requiredOnWizard": false,
"env": false,
"enableQuery": "{\"_id\":\"Livechat_enabled\",\"value\":true}"
},
{
"_id": "Livechat_show_agent_info",
"_updatedAt": "2023-08-10T13:27:26.422Z",
"autocomplete": true,
"blocked": false,
"createdAt": "2021-12-03T16:21:59.833Z",
"group": "Omnichannel",
"hidden": false,
"i18nDescription": "Livechat_show_agent_info_Description",
"i18nLabel": "Show_agent_info",
"packageValue": true,
"public": true,
"secret": false,
"sorter": 14,
"ts": "2021-12-03T16:21:59.833Z",
"type": "boolean",
"value": false,
"valueSource": "packageValue",
"section": "Livechat",
"enterprise": false,
"requiredOnWizard": false,
"env": false,
"enableQuery": "{\"_id\":\"Livechat_enabled\",\"value\":true}"
},
{
"_id": "Livechat_title",
"type": "string",
"group": "Omnichannel",
"public": true,
"packageValue": "Rocket.Chat",
"valueSource": "packageValue",
"hidden": false,
"blocked": false,
"sorter": 0,
"i18nLabel": "Livechat_title",
"i18nDescription": "Livechat_title_Description",
"ts": "2021-10-27T22:25:42.874Z",
"_updatedAt": "2023-09-01T17:17:39.628Z",
"createdAt": "2021-10-27T22:25:42.874Z",
"value": "Hello",
"autocomplete": true,
"secret": false,
"section": "Livechat",
"enterprise": false,
"requiredOnWizard": false,
"env": false,
"enableQuery": "{\"_id\":\"Livechat_enabled\",\"value\":true}"
},
{
"_id": "Livechat_title_color",
"type": "color",
"group": "Omnichannel",
"public": true,
"packageValue": "#C1272D",
"valueSource": "packageValue",
"hidden": false,
"blocked": false,
"sorter": 1,
"i18nLabel": "Livechat_title_color",
"i18nDescription": "Livechat_title_color_Description",
"ts": "2021-10-27T22:25:42.882Z",
"_updatedAt": "2023-03-30T12:19:01.124Z",
"createdAt": "2021-10-27T22:25:42.882Z",
"value": "#b427be",
"autocomplete": true,
"editor": "color",
"secret": false,
"section": "Livechat",
"enterprise": false,
"requiredOnWizard": false,
"env": false,
"packageEditor": "color",
"enableQuery": "{\"_id\":\"Livechat_enabled\",\"value\":true}"
}
],
"success": true
}object
appearance
Array of object
object
_id
string
type
string
group
string
public
boolean
i18nLabel
string
packageValue
boolean
valueSource
string
hidden
boolean
blocked
boolean
sorter
integer
i18nDescription
string
autocomplete
boolean
ts
string
_updatedAt
string
createdAt
string
value
boolean
secret
boolean
section
string
enterprise
boolean
requiredOnWizard
boolean
env
boolean
enableQuery
string
editor
string
packageEditor
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?