Passen Sie das Branding und die Designs Ihres Hilfecenters mit der Notiondesk API an.

Die Notiondesk-API ermöglicht es Ihnen, das Branding Ihres Hilfecenters zu lesen und zu ändern: Farben, Schriftarten, Layout, Kopf- und Fußzeile, Links, Such- und Feedback-Anzeige sowie Design. Nutzen Sie sie, um ein einheitliches Branding für mehrere Hilfecenter zu verwenden oder um Ihr Branding im Code neben dem Rest Ihres Designsystems zu verwalten.

Das Branding ist auf jeder öffentlichen Seite sichtbar, daher benötigt man für dessen Aktualisierung den Bereich admin, nicht write. Nur ein vom Workspace-Inhaber oder Administrator erstellter Schlüssel enthält den Bereich admin.

Um das Branding stattdessen im Dashboard zu ändern, lesen Sie den Abschnitt "Farben und Schriftarten Ihres Hilfecenters anpassen" .

Was die API nicht ändert

Diese bleiben nur im Dashboard sichtbar. Die Leseroute gibt sie nicht zurück, und eine Aktualisierung, die einen davon nennt, antwortet mit dem Fehlercode 400 validation_error:

• Benutzerdefiniertes CSS und benutzerdefiniertes JavaScript. Siehe „Hilfecenter mit benutzerdefiniertem CSS anpassen “.

• Logos (hell und dunkel), Footer-Logos (hell und dunkel), Favicon, Social-Media-Bild und Header-Bilder (hell und dunkel).

Lesen Sie Ihre Markenidentität

Die Antwort enthält exakt die Felder, die das Update akzeptiert, und zwar unter denselben Namen. Ein verkürztes Beispiel:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "colors": {
    "primary": "#2563eb",
    "text": "#111827",
    "link": "#2563eb",
    "link_hover": "#1d4ed8",
    "header": "#2563eb",
    "header_text": "#ffffff",
    "background": "#ffffff",
    "footer_background": ""
  },
  "appearance": null,
  "layout_collection": "column_2",
  "layout_article": "column_1",
  "footer_layout": "compact",
  "primary_font": "Inter",
  "header_links": [{"title": "Docs", "url": "https://example.com/docs"}],
  "footer_links": [{"title": "Product", "links": [{"title": "Pricing", "url": "https://example.com/pricing"}]}],
  "show_powered_by_badge": false,
  "theme": null
}

• Eine Farbe, die nie festgelegt wurde, wird als "" angezeigt. colors.dark enthält die Farben für den Dunkelmodus und fehlt, wenn das Hilfecenter keine dunkle Farbpalette besitzt.

• Eine leere Liste wird als [] angezeigt.

• theme ist das code des aktuellen Themas oder null.

Aktualisieren Sie Ihr Branding

Die Route beantwortet 204 No Content. Lesen Sie die Beschriftung erneut, um die Änderung zu bestätigen.

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"primary_font": "Inter", "colors": {"primary": "#2563eb"}, "header_links": [{"title": "Docs", "url": "https://example.com/docs"}]}'

• Ein Feld, das Sie weglassen, behält seinen Wert. Auch eine Farbe, die Sie innerhalb von colors weglassen, behält ihren Wert.

• Eine von Ihnen gesendete Liste ersetzt die gesamte gespeicherte Liste, und [] leert sie.

• Farben werden als #rrggbb Hexadezimalwerte oder "" angegeben. Kurzformen wie #fff werden nicht akzeptiert.

• Sende JSON-Boolesche Werte. Die Werte 0 und "false" werden als true gelesen, und null als false.

Jede akzeptierte Aktualisierung aktualisiert das gesamte Hilfecenter: Notiondesk löscht den Cache und erstellt jede Seite neu, unabhängig von den Änderungen durch die Aktualisierung. Senden Sie alle Änderungen in einer einzigen Anfrage, nicht in einer Anfrage pro Feld.

Sichere Updates: lesen, ändern, zurücksenden

Die sicherste Methode zur Aktualisierung des Brandings besteht darin, die gelesenen Daten mit Ihren Änderungen zurückzusenden. Ein Feld mit seinem aktuellen Wert wird in jedem Tarif akzeptiert, sodass dieses Vorgehen niemals zu einem Tariflimit für Felder führt, die Sie nicht bearbeitet haben.

Ein zurückgesendeter Body kann in zwei Fällen weiterhin abgelehnt werden. Korrigieren Sie den Wert im Dashboard oder lassen Sie dieses Feld aus dem Body weg:

const url = "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize";
const headers = {
  Authorization: `Bearer ${process.env.NOTIONDESK_API_KEY}`,
  "nd-version": "2026-10-16",
  "Content-Type": "application/json",
};

const branding = await (await fetch(url, { headers })).json();
branding.colors.primary = "#7c3aed";
branding.colors.link = "#7c3aed";

const response = await fetch(url, { method: "PATCH", headers, body: JSON.stringify(branding) });
console.log(response.status);

• eine gespeicherte Farbe in Kurzform wie z. B. #fff;

• eine gespeicherte Liste, die länger ist als die unten aufgeführten Grenzwerte.

Felder, die Sie ändern können

Links sind Objekte mit den Attributen title und url. Linkgruppen in der Fußzeile sind Objekte mit den Attributen title und links. Übersetzungen sind Objekte mit dem Attribut locale und dem übersetzten Attribut links, groups oder value.

Planbeschränkungen

Wenn man eine dieser Optionen in einem Tarif ändert, der diese Funktion nicht enthält, erhält man die Fehlermeldung 403 permission_denied. In der Meldung wird die Funktion genannt, und es wird nichts weiter ausgegeben.

Ohne erweiterte Anpassungen behalten die Farben der Fußzeile ihre gespeicherten Werte fehlerfrei bei. Auch ohne aktivierten KI-Chatbot behalten ai_search_display_mode, ai_search_aside_position und ai_search_enabled: true ihre gespeicherten Werte.

Listenbeschränkungen

• Jede Liste enthält bis zu 100 Einträge, ebenso wie jede darin enthaltene links- oder groups-Liste.

• Alle Listen zusammen enthalten bis zu 3.000 Einträge, wobei verschachtelte Einträge und die vom System gespeicherten Listen nicht mitgezählt werden.

Durch den Kontakt-Button wird das Kontaktformular aktiviert.

Bei einem Plan mit erweiterten Anpassungsmöglichkeiten entspricht show_contact_us_button zwar true, jedoch wird bei jeder Aktualisierung des Brandings das Kontaktformular des Hilfecenters aktiviert, ebenso wie beim Speichern im Dashboard. Weitere Informationen finden Sie im Abschnitt „Kontaktformular“ unter „Hilfecenter-Einstellungen mit der Notiondesk-API aktualisieren“ .

Wähle ein Thema

Die Liste enthält stets alle Designs in einer Antwort, in der Reihenfolge ihrer Anzeige. Wenden Sie ein Design an, indem Sie dessen code als theme senden:

Für die Festlegung eines Designs sind erweiterte Anpassungen erforderlich. Das Senden von "theme": null ändert nichts am Design.

Fehler

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/themes" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "code": "ocean",
      "name": "Ocean",
      "description": "A calm, airy theme",
      "preview_image_url": "https://example.com/ocean.png",
      "layout": "default"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/customize" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"theme": "ocean"}'

Feldfehler benennen den Wert, zum Beispiel colors.primary oder footer_links[0].links. Siehe Umgang mit Notiondesk-API-Fehlern, Ratenbegrenzungen und Wiederholungsversuchen .

Häufig gestellte Fragen

Was kommt als Nächstes?

• Aktualisieren Sie die Einstellungen des Hilfecenters mit der Notiondesk API

• Verwalten Sie Help-Center-Integrationen mit der Notiondesk API

• Automatisieren Sie häufige Aufgaben im Hilfecenter mit der Notiondesk API