Knowledge base Settings

Listing knowledge base settings

GET https://api.groovehq.com/v1/kb/:knowledge_base_id/settings

Example Request

curl -i -X GET https://api.groovehq.com/v1/kb/4216430596/settings \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

{
    "settings": {
        "primary_color": "#145cec",
        "secondary_color": "#145cec",
        "primary_font_type": "IBM Plex Sans",
        "secondary_font_type": "IBM Plex Sans",
        "background_scaling": "tile",
        "authors_enabled": "t",
        "branding_disabled": "f",
        "ratings_enabled": "t",
        "help_count_enabled": "t",
        "contact_support_enabled": "t",
        "ratings_type": "emoji",
        "heading": "What are you looking for?",
        "subheading": "Get help straight from the team at Acme...",
        "search_input": "Search for answers...",
        "contact_support_mailbox_id": "0549243131",
        "published": true
    }
}

Updating knowledge base settings

PUT https://api.groovehq.com/v1/kb/:knowledge_base_id/settings

Parameters

Name	Type	Required	Default	Notes
authors_disabled	boolean	No	false	Whether the article and category authors are disabled.
background_image_url	string	No		The URL to the background image of the theme.
background_scaling	string	No	"static"	The background scaling, either stretch, tile, or static.
body_script	string	No		The JavaScript code injected into the body section of the page. Must be wrapped in a <script> tag.
branding_disabled	boolean	No	false	Whether to disable Groove branding. Available to customers with Pro plan only.
contact_support_enabled	boolean	No	true	Whether the contact support form is enabled.
contact_support_mailbox_id	string	No		The Mailbox ID to use in the contact support form.
favicon_image_url	string	No		The URL to the favicon image of the theme.
footer_logo_inverted	boolean	No	false	Whether the logo image colors are inverted.
head_script	string	No		The JavaScript code injected into the head section of the page. Must be wrapped in a <script> tag.
heading	string	No	"What are you looking for?"	The heading text of the theme.
help_count_enabled	boolean	No	true	Whether the article help counts are enabled.
logo_image_url	string	No		The URL to the logo image of the theme.
logo_size	string	No	"small"	The size of the logo image, either small, medium, or large.
menu_links	string	No		The JSON string of the main menu links of the theme. Must be an array of objects with key/value pairs: title and a valid HTTP url.
primary_color	string	No	"#145cec"	The Hex format primary color of the theme, used as the background color for the header and the mobile menu.
primary_font_type	string	No	"IBM Plex Sans"	The primary font of the theme, see Available fonts.
ratings_enabled	boolean	No	true	Whether the article ratings are enabled.
ratings_type	string	No	"emoji"	The ratings faces type, either emoji or upvote.
search_input	string	No	"Search for answers..."	The search input placeholder text of the theme.
secondary_color	string	No	"#145cec"	The Hex format secondary color of the theme, used for links and buttons.
subheading	string	No	"Get help straight from our team..."	The subheading text of the theme.
timestamps_disabled	boolean	No	false	Whether the article and category updated timestamps are disabled.

Available fonts

The following fonts are available for the theme:

IBM Plex Sans
Playfair Display
Roboto
Source Sans Pro
Poppins
PT Sans
PT Serif
Lato

Example Request

curl -i -X PUT https://api.groovehq.com/v1/kb/4216430596/settings \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
        "settings": {
            "subheading": "To the moon and back",
            "ratingsType": "upvote"
        }
    }'

Example Response

Status: 200 OK

{
    "settings": {
        "primary_color": "#145cec",
        "secondary_color": "#145cec",
        "primary_font_type": "IBM Plex Sans",
        "secondary_font_type": "IBM Plex Sans",
        "background_scaling": "tile",
        "authors_enabled": "t",
        "branding_disabled": "f",
        "ratings_enabled": "t",
        "help_count_enabled": "t",
        "contact_support_enabled": "t",
        "ratings_type": "upvote",
        "heading": "What are you looking for?",
        "subheading": "To the moon and back",
        "search_input": "Search for answers...",
        "contact_support_mailbox_id": "0549243131",
        "published": false
    }
}

Publishing knowledge base settings

PUT https://api.groovehq.com/v1/kb/:knowledge_base_id/settings/publish

Example Request

curl -i -X PUT https://api.groovehq.com/v1/kb/4216430596/settings/publish \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

{
    "settings": {
        "primary_color": "#145cec",
        "secondary_color": "#145cec",
        "primary_font_type": "IBM Plex Sans",
        "secondary_font_type": "IBM Plex Sans",
        "background_scaling": "tile",
        "authors_enabled": "t",
        "branding_disabled": "f",
        "ratings_enabled": "t",
        "help_count_enabled": "t",
        "contact_support_enabled": "t",
        "ratings_type": "upvote",
        "heading": "What are you looking for?",
        "subheading": "To the moon and back",
        "search_input": "Search for answers...",
        "contact_support_mailbox_id": "0549243131",
        "published": true
    }
}

Reverting knowledge base settings

PUT https://api.groovehq.com/v1/kb/:knowledge_base_id/settings/revert

Example Request

curl -i -X PUT https://api.groovehq.com/v1/kb/4216430596/settings/revert \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

{
    "settings": {
        "primary_color": "#145cec",
        "secondary_color": "#145cec",
        "primary_font_type": "IBM Plex Sans",
        "secondary_font_type": "IBM Plex Sans",
        "background_scaling": "tile",
        "authors_enabled": "t",
        "branding_disabled": "f",
        "ratings_enabled": "t",
        "help_count_enabled": "t",
        "contact_support_enabled": "t",
        "ratings_type": "upvote",
        "heading": "What are you looking for?",
        "subheading": "To the moon and back",
        "search_input": "Search for answers...",
        "contact_support_mailbox_id": "0549243131",
        "published": true
    }
}

Resetting knowledge base settings to its defaults

PUT https://api.groovehq.com/v1/kb/:knowledge_base_id/settings/reset

Example Request

curl -i -X PUT https://api.groovehq.com/v1/kb/4216430596/settings/reset \
    -H "Authorization: Bearer $GROOVE_API_KEY" \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

{
    "settings": {
        "primary_color": "#145cec",
        "secondary_color": "#145cec",
        "primary_font_type": "IBM Plex Sans",
        "secondary_font_type": "IBM Plex Sans",
        "background_scaling": "tile",
        "authors_enabled": "t",
        "branding_disabled": "f",
        "ratings_enabled": "t",
        "help_count_enabled": "t",
        "contact_support_enabled": "t",
        "ratings_type": "emoji",
        "heading": "What are you looking for?",
        "subheading": "Get help straight from the team at Acme...",
        "search_input": "Search for answers...",
        "published": true
    }
}