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

Met de Notiondesk API kunt u de huisstijl van uw helpcentrum lezen en wijzigen: kleuren, lettertypen, lay-out, kop- en voettekst, links, weergave van zoekresultaten en feedback, en thema. Gebruik de API om dezelfde huisstijl in meerdere helpcentra te implementeren, of om uw huisstijl in de code te behouden, naast de rest van uw ontwerpsysteem.

De branding is zichtbaar op elke openbare pagina, dus voor het bijwerken ervan is de scope admin vereist, niet write. Alleen een sleutel die is aangemaakt door een workspace-eigenaar of beheerder heeft de scope admin.

Om de huisstijl in het dashboard te wijzigen, raadpleegt u 'De kleuren en lettertypen van uw helpcentrum aanpassen' .

Wat de API niet verandert

Deze blijven alleen zichtbaar op het dashboard. De leesroute retourneert ze niet, en een update die er een benoemt, geeft als antwoord 400 validation_error:

• Aangepaste CSS en aangepaste JavaScript. Zie Uw helpcentrum aanpassen met aangepaste CSS ;

• Logo's (licht en donker), voettekstlogo's (licht en donker), favicon, afbeelding voor sociale media en headerafbeeldingen (licht en donker).

Lees je merkidentiteit.

Het antwoord bevat precies de velden die de update accepteert, onder dezelfde namen. Een verkort voorbeeld:

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
}

• Een kleur die nooit is ingesteld, wordt weergegeven als "". colors.dark bevat de kleuren voor de donkere modus en ontbreekt wanneer het helpcentrum geen donker kleurenpalet heeft.

• Een lijst die niets bevat, heeft de waarde [].

• theme is de code van het huidige thema, of null.

Vernieuw uw merkidentiteit.

De route geeft 204 No Content aan. Lees de informatie over de wijziging nogmaals om deze te bevestigen.

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

• Een veld dat je weglaat, behoudt zijn waarde. Binnen colors behoudt een kleur die je weglaat ook zijn waarde.

• Een lijst die je verzendt, vervangt de hele opgeslagen lijst en [] maakt deze leeg.

• Kleuren zijn #rrggbb hexadecimale waarden, of "". Verkorte vormen zoals #fff worden afgewezen.

• Verzend JSON-booleans. De waarden 0 en "false" worden gelezen als true, en null als false.

Elke geaccepteerde update vernieuwt het hele helpcentrum: Notiondesk wist de cachepagina's en herbouwt elke pagina, ongeacht de wijzigingen die de update heeft aangebracht. Verstuur elke wijziging in één verzoek, niet één verzoek per veld.

Veilige updates: lezen, wijzigen, terugsturen

De veiligste manier om de huisstijl bij te werken, is door de tekst die je hebt gelezen terug te sturen, met jouw wijzigingen erin verwerkt. Een veld dat met de huidige waarde wordt teruggestuurd, wordt geaccepteerd in elk abonnement, dus deze methode zorgt er nooit voor dat een limiet voor velden die je niet hebt aangepast, wordt overschreden.

Een teruggestuurde body kan in twee gevallen nog steeds worden geweigerd. Corrigeer de waarde in het dashboard of laat dat veld weg uit de body:

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);

• een opgeslagen kleur in een verkorte vorm, zoals #fff;

• een opgeslagen lijst die langer is dan de onderstaande limieten.

Velden die u kunt wijzigen

Links zijn objecten met een title en een url. Linkgroepen in de voettekst zijn objecten met een title en een links lijst. Vertalingen zijn objecten met een locale en de vertaalde links, groups of value.

Planlimieten

Als je een van deze opties wijzigt in een abonnement zonder die functie, krijg je de foutmelding 403 permission_denied. In het bericht wordt de functie wel genoemd, maar er wordt verder niets geschreven.

Zonder geavanceerde aanpassingen behouden de kleuren in de voettekst hun opgeslagen waarde zonder fouten. Zonder een ingeschakelde AI-chatbot behouden ai_search_display_mode, ai_search_aside_position en ai_search_enabled: true ook hun opgeslagen waarde.

Lijstlimieten

• Elke lijst kan maximaal 100 items bevatten, en dat geldt ook voor elke links of groups lijst daarin.

• Alle lijsten samen kunnen maximaal 3000 items bevatten, inclusief geneste items en de opgeslagen lijsten die uw body niet weergeeft.

Met de contactknop wordt het contactformulier geactiveerd.

Hoewel show_contact_us_button true is op een abonnement met geavanceerde aanpassingsmogelijkheden, wordt bij elke brandingupdate het contactformulier van het helpcentrum ingeschakeld, net zoals bij het opslaan in het dashboard. Zie het gedeelte over het contactformulier in ' Helpcentruminstellingen bijwerken met de Notiondesk API' .

Kies een thema

De lijst bevat altijd alle thema's in één reactie, in de volgorde waarin ze worden weergegeven. Pas er een toe door de bijbehorende code als theme te verzenden:

Het instellen van een thema vereist geavanceerde aanpassingen. Het verzenden van "theme": null laat het thema ongewijzigd.

Fouten

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

Foutmeldingen in velden geven de waarde aan, bijvoorbeeld colors.primary of footer_links[0].links. Zie Foutmeldingen, snelheidslimieten en herhaalpogingen in de API afhandelen voor Notiondesk .

Veelgestelde vragen

Wat volgt?

• Update de instellingen van het helpcentrum met de Notiondesk API

• Beheer integraties met het helpcentrum via de Notiondesk API

• Automatiseer veelvoorkomende helpcentrumtaken met de Notiondesk API