Update help hub settings

PATCH/workspaces/current/help-hubNeedsworkspace.settings

Partial: tabs merge one by one. Visitors get the change within a minute.

Authorization

secretKey

headerAuthorizationBearer <sk_…>

A secret API key from Settings → API keys. It acts with its creator's role.

Request Body

application/json

body

enabled?boolean

position?string

Value in"bottom-right""bottom-left"

label?string

Match^[^\u0000-\u001f\u007f]+$

Length1 <= length <= 40

accentColor?|null

backgroundColor?|null

textColor?|null

tabs?

Response Body

application/json

response

helpHub*

defaults*

Shell

curl -X PATCH 'https://app.cueston.com/api/workspaces/current/help-hub' \
  -H 'Content-Type: application/json' \
  -d '{}'curl -X PATCH 'https://app.cueston.com/api/workspaces/current/help-hub' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example ResponseSchema

JSON

{
  "helpHub": {
    "enabled": true,
    "position": "bottom-right",
    "label": "string",
    "accentColor": "string",
    "backgroundColor": "string",
    "textColor": "string",
    "tabs": {
      "assistant": true,
      "checklists": true,
      "announcements": true,
      "help": true
    }
  },
  "defaults": {
    "enabled": true,
    "position": "bottom-right",
    "label": "string",
    "accentColor": "string",
    "backgroundColor": "string",
    "textColor": "string",
    "tabs": {
      "assistant": true,
      "checklists": true,
      "announcements": true,
      "help": true
    }
  }
}{
  "helpHub": {
    "enabled": true,
    "position": "bottom-right",
    "label": "string",
    "accentColor": "string",
    "backgroundColor": "string",
    "textColor": "string",
    "tabs": {
      "assistant": true,
      "checklists": true,
      "announcements": true,
      "help": true
    }
  },
  "defaults": {
    "enabled": true,
    "position": "bottom-right",
    "label": "string",
    "accentColor": "string",
    "backgroundColor": "string",
    "textColor": "string",
    "tabs": {
      "assistant": true,
      "checklists": true,
      "announcements": true,
      "help": true
    }
  }
}