Update de instellingen van het helpcentrum met de Notiondesk API

Met de Notiondesk API kunt u de instellingen van uw helpcentrum vanuit de code wijzigen: zoekmachine-indexering, de paginatitel en -beschrijving in elke taal, AI-optimalisatie, het contactformulier en het wijzigingslogboek. Gebruik de API om dezelfde configuratie op meerdere helpcentra toe te passen of om instellingen onder versiebeheer te houden.

Talen en automatische vertaling hebben een eigen artikel: Beheer talen en automatische vertaling met de Notiondesk API . Kleuren, lettertypen en lay-out worden behandeld in De huisstijl en thema's van het helpcentrum aanpassen met de Notiondesk API .

Hoe het bijwerken van instellingen werkt

Elke route op deze pagina volgt dezelfde regels:

• Verzend alleen de wijzigingen. Een veld dat u niet invult, behoudt de huidige waarde.

• Het antwoord is 204 No Content , zonder inhoud, zelfs als er niets is veranderd. Lees de nieuwe status met GET /sites/{site_id}, zoals beschreven in Lees uw helpcentra met de Notiondesk API .

• Verzend JSON-booleans. Alleen true of false: de waarden 0 en "false" worden gelezen als true.

• Onbekende velden worden afgewezen met foutcode 400 validation_error, en er verandert niets.

• Herhaalpogingen zijn veilig met een Idempotency-Key. Zie Foutmeldingen, snelheidslimieten en herhaalpogingen van de Notiondesk-API afhandelen .

Indexering door zoekmachines, paginatitels en -beschrijvingen

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"}]}'

Elk object in items:

Een object wijzigt alleen de velden die het bevat, en een taal die u niet in items opneemt, behoudt zijn titel en beschrijving. items kan geen taal toevoegen of verwijderen.

Een fout in een van de talen wordt in het veldpad vermeld, bijvoorbeeld items[fr].page_title.

seo_indexing_enabled: false Vraag zoekmachines om te stoppen met het indexeren van uw volledige helpcentrum. Zie Voorkom dat zoekmachines uw helpcentrum crawlen en indexeren .

AI-optimalisatie

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}'

Uw plan moet AI-optimalisatie omvatten. Lees meer over de functie in ' AI-optimalisatie instellen' in uw helpcentrum en in 'Inleiding tot GEO/AI-optimalisatie' .

Contactformulier

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}'

• De API schakelt het formulier in of uit, meer niet. De adressen die inzendingen ontvangen, worden ingesteld in het dashboard. Een bericht met destination_emails wordt beantwoord met 400 validation_error en verandert niets.

• Het formulier blijft alleen actief als er een adres is opgeslagen. Als u het inschakelt voor een helpcentrum zonder adres, krijgt u de foutmelding 400 validation_error voor destination_emails. Stel eerst een adres in via het dashboard. Om het formulier uit te schakelen is geen adres nodig.

• Uw abonnement moet uitgebreide aanpassingsmogelijkheden bieden, zelfs om het formulier uit te schakelen.

Wijzigingslogboek

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"}]}'

Elk object in changelog_categories heeft een verplichte category_id, de id van een van uw verzamelingen en een optionele color van maximaal 255 tekens.

changelog_categories Vervangt de hele set. Een verzameling die je weglaat, is geen changelog-verzameling meer en verwijdert ze allemaal. Lees vanaf het begin als je er maar één wilt toevoegen. De set kan maximaal 100 verzamelingen bevatten.[]changelog_categoriesGET /sites/{site_id}

Je abonnement moet de changelog bevatten. Als e-mailabonnementen zijn ingeschakeld, maar je abonnement geen e-mailmeldingen meer bevat voor de changelog, wordt elke aanvraag naar deze route beantwoord met 403 permission_denied totdat "email_subscriptions_enabled": false wordt verzonden.

Lees meer in Wijzigingslogboeken instellen in uw helpcentrum en E-mailabonnementen voor uw wijzigingslogboeken inschakelen .

Fouten

Zie 'API-fouten, snelheidslimieten en herhaalpogingen afhandelen' voor de foutomvang en de andere codes.

Veelgestelde vragen

Wat volgt?

• Personaliseer de huisstijl en thema's van het helpcentrum met de Notiondesk API

• Beheer integraties met het helpcentrum via de Notiondesk API

• Beheer talen en automatische vertaling met de Notiondesk API