Skip to main content
PATCH
Update a help center

Authorizations

x-api-key
string
header
required

Enter your API key

Path Parameters

helpCenterId
string
required

Help Center ID in MongoDB ObjectId format

Example:

"507f1f77bcf86cd799439011"

Body

application/json

Help center update payload

isOnline
boolean

Whether the help center is online

Example:

true

isProtected
boolean

Whether the help center requires authentication to access

Example:

false

name
string

Name of the help center

Example:

"Thena Support Center"

defaultDomain
string

Default subdomain

Pattern: ^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$
Example:

"support"

gaId
string

Google Analytics ID

Example:

"G-XXXXXXXXXX"

shouldIndex
boolean

Whether to index the help center for search engines

Example:

true

socialImages
object

Social media images configuration

Example:
stylingConfiguration
object

Styling configuration

Help center logo URL

Example:

"https://assets.thena.io/logos/help-center-logo.png"

meta
object

Meta information for SEO

Example:

Response

200 - application/json

Updates a help center by ID

data
object
required

Help center data

message
string
required

Response message

Example:

"Help center updated successfully."