Socialboards
  • Developer hub
  • APIs
    • Ticket API
      • Getting Started
        • Guidelines and data privacy
      • Authorization
        • Access tokens
      • Categories
      • Custom Fields
      • Action Log
      • Notes
      • Replies
      • Tags
      • Tickets
      • Teammates
      • User Groups
      • Widgets
      • Webhooks
        • Getting Started
        • Create Endpoint
        • Configure the Webhooks
        • Testing your webhooks
      • Reference
        • Endpoints
          • Get Access Token v2
          • Get Full Community Category List
          • Get Subcategories by Parent Id
          • Get Category By Id
          • Get Full Community Custom Field List
          • Add Custom Field
          • Get Custom Field
          • Get All Teammates
          • Get All User Groups for Community
          • Update Custom Field
          • Delete Custom Field
          • Create Ticket
          • List Tickets
          • List Ticket Ids By Field Ids
          • Get Ticket by Id
          • Update Ticket Custom Field Value
          • Update Ticket Assignee
          • Get Ticket Log
          • Update Ticket Status
          • Update Ticket Category (Obsolete)
          • Update Ticket Category
          • Create Reply
          • List Replies
          • Add Note To Ticket
          • Update Note
          • Delete Note
          • List tags
          • Replace Ticket Tags
          • Replace Reply Tags
          • Get Widget Schedule List
        • API Request Result
        • Webhook Payload
        • Objects
          • Base Attachment
          • Category
          • Custom Field
          • Custom Field Id with Value
          • Custom Field Possible Value
          • Custom Field Value
          • Custom Times Widget Schedule
          • Note
          • Reply
          • Reply/Note Creator
          • Reply Properties
          • Schedule Time
          • Tag
          • Teammate
          • Ticket
          • Ticket Action Included Items
          • Ticket Creator
          • Ticket Id with Field Value
          • Ticket Log
          • Ticket Properties
          • User
          • User Group
          • Widget Schedule
        • Events
          • Ticket Creation
          • Ticket Status Change
          • Ticket Tags Change
          • Ticket Category Change
          • Reply Creation
          • Reply Update
          • Reply Deletion
          • Note Creation
          • Note Update
          • Note Deletion
        • Enumerations
          • Custom Field Types and Values Formats
          • Sentiment
          • Ticket Action Type
          • Ticket List Order By
          • Ticket Source
          • Ticket Status
          • User Role
          • Detailed Ticket Source
      • Glossary
    • External Chat API
      • Conversations Overview
      • Configure the Webhooks
      • Glossary
      • Reference
        • Endpoints
          • Create conversation
          • Add messages to conversation
          • Get conversation by id
          • List conversation messages
          • Get conversation queue information
          • Get takeover state
          • Change takeover state
          • Update conversation feedback
          • Update conversation latest url
          • Close conversation
        • Objects
          • Bot
          • Conversation
          • Conversation feedback
          • Conversation message
          • Conversation takeover
          • Conversation queue position
          • User
          • User Value
        • Events
          • Conversation created
          • Conversation Message Added
          • Conversation Takeover State Changed
          • Conversation Status Changed
        • Enumerations
          • Bot type
          • Order by
          • User status
          • Conversation Status
    • FAQ API
      • Glossary
      • Categories
      • FAQ Instances
      • Tags
      • Topics
      • Reference
        • Endpoints
          • List FAQ Instances
          • List Tags
          • List Categories
          • List Topics
          • Get Specific Topic
          • Add Vote to Topic
          • Increase View Count for Topic
          • Search Topics by Params
        • Objects
          • Attachment
          • Category
          • Instance
          • Tag
          • Topic
          • Topic Search Result
        • Enumerations
          • Localization Language
          • Template Type
          • Topic Downvote Reason
          • Topics Sort Options
    • Support Widget
      • Installation
      • Configuration options
      • Full script example
      • Javascript changelog
      • Widget schedule API
    • Reporting & Statistics
      • Data warehouse (DWH)
        • Entity relationship diagram (ERD)
        • Most used views and values
      • Reports and dashboards
  • Security
    • Introduction to Security
    • Data centers & network security
    • Product security features
    • Application security
    • Data Processing
    • Sub-Processors
      • 2023-04 Intility AS
        • Addendum 2023-4
  • Updates
    • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. APIs
  2. FAQ API
  3. Reference
  4. Objects

Instance

Example

{
    "activeTopicCount": 7,
    "bigLogoLink": null,
    "creationTime": "2023-12-19T14:27:42.1864607+00:00",
    "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,
    "isAccessByPasswordEnabled": false,
    "isChatEnabled": false,
    "isCookieMessageHidden": false,
    "isDefault": true,
    "isFooterHidden": false,
    "language": 2,
    "logoLink": null,
    "name": "publicapitests",
    "publishedTopicCount": 7,
    "stickyButtonColor1": "#f5f5f5",
    "stickyButtonColor2": "#f5f5f5",
    "stickyButtonColor3": "#f5f5f5",
    "stickyButtonTextColor1": "#231f1f",
    "stickyButtonTextColor2": "#231f1f",
    "stickyButtonTextColor3": "#231f1f",
    "templateType": "text_default",
    "twitterLink": null
}

Fields

Field
Type
Comments

activeTopicCount

integer

The total number of active topics in the FAQ

bigLogoLink

string

The URL for the large-sized FAQ logo

creationTime

string

Instance creation date. Represent datetime string in ISO 8601 format

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

isAccessByPasswordEnabled

boolean

If true, the FAQ will require a password from user for access

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

language

The localization language set for the FAQ instance

logoLink

string

The URL for the FAQ logo

name

string

The name of the FAQ

publishedTopicCount

integer

The total number of published topics in 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

Indicates the FAQ styling theme

twitterLink

string

Link to the customer Twitter account

PreviousCategoryNextTag

Last updated 1 year ago

Was this helpful?

enumeration

enumeration

Localization Language
​Template Type