GET THEME

Query chat themes by theme ID

QUERY

GET https://api.eyelevel.ai/v1/partner/theme/:apiKey/:themeId

Path Parameters

Name	Type	Description
apiKey	string	EyeLevel customer key
themeId	integer	Theme ID

200

{
    "theme": { 
        "themeId":            INTEGER IDENTIFIER,
        "name":               "STRING",
        "iconUrl":            "STRING",
        "logoUrl":            "STRING",
        "header":             "STRING",
        "responseBackground": "STRING",
        "chatBackground":     "STRING",
        "responseText":       "STRING",
        "mainText":           "STRING",
        "headerText":         "STRING",
        "button":             "STRING",
        "buttonBackground":   "STRING",
        "bubbleBackground":   "STRING",
        "bubble":             "STRING",
        "bubbleIconUrl":      "STRING",
        "advancedCSS":        "STRING",
        "timing":             FLOAT,
        "updated":            DATETIME
    }
}

Response

{
    "theme": { 
        "themeId":            INTEGER IDENTIFIER,
        "name":               "STRING",
        "iconUrl":            "STRING",
        "logoUrl":            "STRING",
        "header":             "STRING",
        "responseBackground": "STRING",
        "chatBackground":     "STRING",
        "responseText":       "STRING",
        "mainText":           "STRING",
        "headerText":         "STRING",
        "button":             "STRING",
        "buttonBackground":   "STRING",
        "bubbleBackground":   "STRING",
        "bubble":             "STRING",
        "bubbleIconUrl":      "STRING",
        "advancedCSS":        "STRING",
        "timing":             FLOAT,
        "updated":            DATETIME
    }
}

themeId

The unique integer identifier for the theme which is generated while creating the theme.

name

The human readable name for the theme.

iconUrl

The URL for the hosted image.

logoUrl

The URL for the hosted image.

header

The header bar background color.

responseBackground

The background of the user chat text bubble.

chatBackground

The background color of the main chat window.

responseText

The secondary text color, including user chat text.

mainText

The primary text color, including server chat text.

headerText

A human readable string that is displayed in the header bar of the chat experience. If logoUrl is set, headerText is not applicable.

button

Button text and border color.

buttonBackground

Button background color.

bubbleBackground

Chat bubble background color. A chat bubble will only appear for website integrations.

bubble

Chat bubble icon color. A chat bubble will only appear for website integrations.

bubbleIconUrl

The URL for the hosted image. If bubbleIconUrl is set, bubble color is not applicable.

advancedCSS

A string containing CSS information that will be applied without validation to chat experience and bubble.

timing

The number of seconds before an alert appears beside the chat bubble. This attribute only applies to website chats.

Objects

pageTHEME