Aktualisieren Sie die Einstellungen des Hilfecenters mit der Notiondesk API

Die Notiondesk API ermöglicht es Ihnen, die Einstellungen Ihres Hilfecenters direkt im Code zu ändern: Suchmaschinenindexierung, Seitentitel und -beschreibung in jeder Sprache, KI-Optimierung, Kontaktformular und Änderungsprotokoll. Nutzen Sie sie, um dieselbe Konfiguration auf mehrere Hilfecenter anzuwenden oder Einstellungen versionskontrolliert zu verwalten.

Sprachen und automatische Übersetzung werden in einem eigenen Artikel behandelt: Sprachen und automatische Übersetzung mit der Notiondesk-API verwalten . Farben, Schriftarten und Layout finden Sie unter „Anpassen des Hilfecenter-Brandings und der Designs mit der Notiondesk-API“ .

So funktionieren Einstellungsaktualisierungen

Alle Routen auf dieser Seite folgen denselben Regeln:

• Senden Sie nur die geänderten Daten. Felder, die Sie auslassen, behalten ihren aktuellen Wert.

• Die Antwort lautet 204 No Content , ohne Inhalt, selbst wenn sich nichts geändert hat. Lesen Sie den neuen Status mit GET /sites/{site_id}, wie in „Hilfezentren mit der Notiondesk-API lesen“ beschrieben.

• Senden Sie JSON-Boolesche Werte. Nur true oder false: Die Werte 0 und "false" werden als true gelesen.

• Unbekannte Felder werden mit dem Fehlercode 400 validation_error zurückgewiesen , und es ändert sich nichts.

• Wiederholungsversuche sind mit einem Idempotency-Key sicher . Siehe API-Fehlerbehandlung Notiondesk, Ratenbegrenzungen und Wiederholungsversuche .

Suchmaschinenindexierung, Seitentitel und -beschreibungen

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/content" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"seo_indexing_enabled": true, "items": [{"locale": "fr", "page_title": "Centre d aide Example", "page_description": "Toutes les réponses sur Example"}]}'

Jedes Objekt in items:

Ein Objekt ändert nur die darin enthaltenen Felder, und eine Sprache, die Sie in items weglassen, behält ihren Titel und ihre Beschreibung. items kann keine Sprache hinzufügen oder entfernen.

Ein Fehler in einer Sprache benennt es im Feldpfad, zum Beispiel items[fr].page_title.

seo_indexing_enabled: false Fordert Suchmaschinen auf, die Indexierung Ihres gesamten Hilfecenters einzustellen. Siehe Verhindern, dass Suchmaschinen Ihr Hilfecenter crawlen und indexieren .

KI-Optimierung

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

Ihr Plan muss die KI-Optimierung beinhalten. Erfahren Sie mehr über die einzelnen Funktionen in der Hilfe unter „KI-Optimierung einrichten“ und in der Einführung zur Geo-/KI-Optimierung .

Kontaktformular

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

• Die API aktiviert oder deaktiviert das Formular, mehr nicht. Die Adressen, an die die Formulareinsendungen gesendet werden, werden im Dashboard festgelegt. Ein Formulartext mit dem Inhalt destination_emails führt zu einem 400-Fehlercode validation_error und ändert nichts.

• Das Formular bleibt nur mit einer gespeicherten Adresse aktiv. Wenn Sie es für ein Hilfecenter ohne Adresse aktivieren, erhalten Sie die Fehlermeldung 400 validation_error für destination_emails. Legen Sie daher zuerst eine Adresse im Dashboard fest. Zum Deaktivieren des Formulars ist keine Adresse erforderlich.

• Ihr Plan muss erweiterte Anpassungsmöglichkeiten beinhalten, sogar die Möglichkeit, das Formular zu deaktivieren.

Änderungsprotokoll

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/changelog" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "reactions_enabled": true, "changelog_categories": [{"category_id": "2984612035", "color": "blue_sky"}]}'

Jedes Objekt in changelog_categories hat ein obligatorisches category_id, das id einer Ihrer Sammlungen und ein optionales color von bis zu 255 Zeichen.

changelog_categories Ersetzt das gesamte Set. Eine weggelassene Sammlung verliert ihre Funktion als Änderungsprotokollsammlung und entfernt alle darin enthaltenen Sammlungen. Lesen Sie die Liste von Anfang an, wenn Sie nur eine Sammlung hinzufügen möchten. Das Set kann bis zu 100 Sammlungen enthalten.[]changelog_categoriesGET /sites/{site_id}

Ihr Tarif muss das Änderungsprotokoll beinhalten. Wenn E-Mail-Abonnements aktiviert sind, Ihr Tarif aber keine E-Mail-Benachrichtigungen über Änderungsprotokolle mehr umfasst, antwortet jede Anfrage an diese Route mit dem Fehlercode 403 permission_denied, bis der Fehlercode "email_subscriptions_enabled": false gesendet wird.

Mehr dazu erfahren Sie unter Einrichten von Änderungsprotokollen in Ihrem Hilfecenter und Aktivieren von E-Mail-Abonnements für Ihre Änderungsprotokolle .

Fehler

Siehe Handle Notiondesk API errors, rate limits, and retries für den Fehlerumschlag und die anderen Codes.

Häufig gestellte Fragen

Was kommt als Nächstes?

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

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

• Sprachen und automatische Übersetzung mit der Notiondesk API verwalten.