Instance

Example

{
    "availableLanguages": [
        "english"
    ],
    "bigLogoLink": null,
    "creationTime": "2023-12-19T14:27:42.1864607+00:00",
    "currentLanguage": "english",
    "customCss": null,
    "customerWebsiteLink": null,
    "defaultFormLink": "//form.socialboards.com/southsideblueroyaljewelry",
    "displayName": "southsideblueroyaljewelry",
    "facebookLink": null,
    "faviconLink": null,
    "footerContent": null,
    "formLink": null,
    "googleAnalyticsCode": null,
    "googleTagManagerCode": null,
    "headerSubTitle": null,
    "headerTitle": "How can we help?",
    "instagramLink": null,
    "isChatEnabled": false,
    "isCookieMessageHidden": false,
    "isDefault": true,
    "isFooterHidden": false,
    "logoLink": null,
    "name": "publicapitests",
    "stickyButtonColor1": "#f5f5f5",
    "stickyButtonColor2": "#f5f5f5",
    "stickyButtonColor3": "#f5f5f5",
    "stickyButtonTextColor1": "#231f1f",
    "stickyButtonTextColor2": "#231f1f",
    "stickyButtonTextColor3": "#231f1f",
    "templateType": "text_default",
    "twitterLink": null
}

Fields

Field	Type	Comments
availableLanguages	array of Localization Language enumeration	All available and enabled localization languages in FAQ instance
bigLogoLink	string	The URL for the large-sized FAQ logo
creationTime	string	Instance creation date. Represent datetime string in ISO 8601 format
currentLanguage	Localization Language enumeration	The localization language set for the FAQ instance
customCss	string	Represents custom CSS rules applied to FAQ Page
customerWebsiteLink	string	Link to the customer website
defaultFormLink	string	The default form link attached to the FAQ Instance
displayName	string	The displayed name of the FAQ
facebookLink	string	Link to the customer Facebook account
faviconLink	string	The URL of the icon for the FAQ
footerContent	string	Custom HTML footer content
formLink	string	Overridden form link by user
googleAnalyticsCode	string	Google Analytics UA code
googleTagManagerCode	string	Google Tag Manager GTM code
headerSubTitle	string	The additional text accompanying the main FAQ header title
headerTitle	string	The main title of the FAQ
instagramLink	string	Link to the customer Instagram account
isChatEnabled	boolean	If true , chat widget will be displayed on the FAQ page
isCookieMessageHidden	boolean	If true, the cookie consent message will be hidden on the FAQ page
isDefault	boolean	If true, indicates the FAQ Instance is used as the default FAQ page for the community
isFooterHidden	boolean	If true, indicates the footer should be hidden
logoLink	string	The URL for the FAQ logo
name	string	The name of the FAQ
stickyButtonColor1	string	The background color for the first FAQ sticky category button
stickyButtonColor2	string	The background color for the second FAQ sticky category button
stickyButtonColor3	string	The background color for the third FAQ sticky category button
stickyButtonTextColor1	string	The text color for the first FAQ sticky category button
stickyButtonTextColor2	string	The text color for the second FAQ sticky category button
stickyButtonTextColor3	string	The text color for the third FAQ sticky category button
templateType	​Template Type enumeration	Indicates the FAQ styling theme
twitterLink	string	Link to the customer Twitter account