Skip to main content
PATCH
/
help-centers
/
{helpCenterId}
Update a help center
curl --request PATCH \
  --url https://helpcenter.thena.ai/help-centers/{helpCenterId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "isOnline": true,
  "isProtected": false,
  "name": "Thena Support Center",
  "defaultDomain": "support",
  "gaId": "G-XXXXXXXXXX",
  "shouldIndex": true,
  "socialImages": {
    "favicon": "https://assets.thena.io/favicon.ico",
    "openGraphImage": "https://assets.thena.io/og-image.jpg"
  },
  "logo": "https://assets.thena.io/logos/help-center-logo.png",
  "meta": {
    "title": "Thena Help Center - Get Support",
    "description": "Find help articles and documentation for Thena products",
    "image": "https://assets.thena.io/meta/help-center.jpg"
  }
}
'
import requests

url = "https://helpcenter.thena.ai/help-centers/{helpCenterId}"

payload = {
"isOnline": True,
"isProtected": False,
"name": "Thena Support Center",
"defaultDomain": "support",
"gaId": "G-XXXXXXXXXX",
"shouldIndex": True,
"socialImages": {
"favicon": "https://assets.thena.io/favicon.ico",
"openGraphImage": "https://assets.thena.io/og-image.jpg"
},
"logo": "https://assets.thena.io/logos/help-center-logo.png",
"meta": {
"title": "Thena Help Center - Get Support",
"description": "Find help articles and documentation for Thena products",
"image": "https://assets.thena.io/meta/help-center.jpg"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
isOnline: true,
isProtected: false,
name: 'Thena Support Center',
defaultDomain: 'support',
gaId: 'G-XXXXXXXXXX',
shouldIndex: true,
socialImages: {
favicon: 'https://assets.thena.io/favicon.ico',
openGraphImage: 'https://assets.thena.io/og-image.jpg'
},
logo: 'https://assets.thena.io/logos/help-center-logo.png',
meta: {
title: 'Thena Help Center - Get Support',
description: 'Find help articles and documentation for Thena products',
image: 'https://assets.thena.io/meta/help-center.jpg'
}
})
};

fetch('https://helpcenter.thena.ai/help-centers/{helpCenterId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://helpcenter.thena.ai/help-centers/{helpCenterId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'isOnline' => true,
'isProtected' => false,
'name' => 'Thena Support Center',
'defaultDomain' => 'support',
'gaId' => 'G-XXXXXXXXXX',
'shouldIndex' => true,
'socialImages' => [
'favicon' => 'https://assets.thena.io/favicon.ico',
'openGraphImage' => 'https://assets.thena.io/og-image.jpg'
],
'logo' => 'https://assets.thena.io/logos/help-center-logo.png',
'meta' => [
'title' => 'Thena Help Center - Get Support',
'description' => 'Find help articles and documentation for Thena products',
'image' => 'https://assets.thena.io/meta/help-center.jpg'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://helpcenter.thena.ai/help-centers/{helpCenterId}"

payload := strings.NewReader("{\n \"isOnline\": true,\n \"isProtected\": false,\n \"name\": \"Thena Support Center\",\n \"defaultDomain\": \"support\",\n \"gaId\": \"G-XXXXXXXXXX\",\n \"shouldIndex\": true,\n \"socialImages\": {\n \"favicon\": \"https://assets.thena.io/favicon.ico\",\n \"openGraphImage\": \"https://assets.thena.io/og-image.jpg\"\n },\n \"logo\": \"https://assets.thena.io/logos/help-center-logo.png\",\n \"meta\": {\n \"title\": \"Thena Help Center - Get Support\",\n \"description\": \"Find help articles and documentation for Thena products\",\n \"image\": \"https://assets.thena.io/meta/help-center.jpg\"\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://helpcenter.thena.ai/help-centers/{helpCenterId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"isOnline\": true,\n \"isProtected\": false,\n \"name\": \"Thena Support Center\",\n \"defaultDomain\": \"support\",\n \"gaId\": \"G-XXXXXXXXXX\",\n \"shouldIndex\": true,\n \"socialImages\": {\n \"favicon\": \"https://assets.thena.io/favicon.ico\",\n \"openGraphImage\": \"https://assets.thena.io/og-image.jpg\"\n },\n \"logo\": \"https://assets.thena.io/logos/help-center-logo.png\",\n \"meta\": {\n \"title\": \"Thena Help Center - Get Support\",\n \"description\": \"Find help articles and documentation for Thena products\",\n \"image\": \"https://assets.thena.io/meta/help-center.jpg\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://helpcenter.thena.ai/help-centers/{helpCenterId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"isOnline\": true,\n \"isProtected\": false,\n \"name\": \"Thena Support Center\",\n \"defaultDomain\": \"support\",\n \"gaId\": \"G-XXXXXXXXXX\",\n \"shouldIndex\": true,\n \"socialImages\": {\n \"favicon\": \"https://assets.thena.io/favicon.ico\",\n \"openGraphImage\": \"https://assets.thena.io/og-image.jpg\"\n },\n \"logo\": \"https://assets.thena.io/logos/help-center-logo.png\",\n \"meta\": {\n \"title\": \"Thena Help Center - Get Support\",\n \"description\": \"Find help articles and documentation for Thena products\",\n \"image\": \"https://assets.thena.io/meta/help-center.jpg\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "orgId": "EWWESHH5ED",
    "name": "Thena Support Center",
    "defaultDomain": "support.thena.ai",
    "orgDomain": "thena.ai",
    "isOnline": true,
    "isProtected": false,
    "shouldIndex": true,
    "createdBy": "UWW7PBBOPJ",
    "socialImages": {
      "favicon": "https://example.com/favicon.ico",
      "openGraphImage": "https://example.com/open-graph.jpg"
    },
    "stylingConfiguration": {
      "body": {
        "bgColor": "#FFFFFF",
        "textColor": "#000000",
        "actionColor": "#000000",
        "designStyle": "card",
        "radius": 10,
        "pFont": "default",
        "sFont": "default",
        "displayAuthors": true
      },
      "header": {
        "logo": "https://example.com/logo.png",
        "title": "Thena Support Center",
        "links": [
          {
            "name": "Home",
            "url": "https://example.com"
          }
        ],
        "showBg": true,
        "bgColor": "#FFFFFF",
        "color": "#000000"
      },
      "hero": {
        "message": "Welcome to Thena Support Center",
        "background": {
          "type": "color",
          "color": "#FFFFFF"
        },
        "color": "#000000",
        "height": 245,
        "search": {
          "len": "long",
          "align": "left",
          "justify": "bottom",
          "radius": 10,
          "placeholderText": "Search..."
        }
      },
      "bodyBlocks": {
        "collection": {
          "layout": "one-column",
          "style": "classic"
        }
      },
      "collection": {
        "displayDescription": true
      },
      "article": {
        "displayTableOfContent": true,
        "displayRelatedArticle": true
      },
      "footer": {
        "logo": "https://example.com/logo.png",
        "layout": "simple",
        "text": "© 2024 Thena Support Center",
        "bgColor": "#FFFFFF",
        "color": "#000000",
        "socialLinks": [
          {
            "type": "facebook",
            "url": "https://www.facebook.com/thena.ai"
          },
          {
            "type": "twitter",
            "url": "https://www.twitter.com/thena.ai"
          }
        ],
        "links": [
          {
            "columnName": "Contact",
            "data": [
              {
                "name": "Support",
                "url": "https://example.com/support"
              }
            ]
          }
        ]
      }
    },
    "aiData": {
      "assistants": [
        {
          "name": "Assistant 1",
          "assistantId": "123",
          "vectorId": "456",
          "assistantType": "default"
        }
      ]
    },
    "meta": {
      "title": "Thena Support Center",
      "description": "Thena Support Center",
      "image": "https://example.com/image.jpg"
    },
    "logo": "https://example.com/logo.png",
    "customDomain": "support.thena.ai",
    "gaId": "UA-1234567890"
  },
  "message": "Help center updated successfully."
}

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:
{
"favicon": "https://assets.thena.io/favicon.ico",
"openGraphImage": "https://assets.thena.io/og-image.jpg"
}
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:
{
"title": "Thena Help Center - Get Support",
"description": "Find help articles and documentation for Thena products",
"image": "https://assets.thena.io/meta/help-center.jpg"
}

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."