Mettez à jour les paramètres du centre d'aide avec l'API Notiondesk

L'API Notiondesk vous permet de modifier les paramètres de votre centre d'aide directement dans le code : indexation par les moteurs de recherche, titre et description de la page dans chaque langue, optimisation par IA, formulaire de contact et journal des modifications. Utilisez-la pour appliquer la même configuration à plusieurs centres d'aide ou pour gérer les versions de vos paramètres.

Les langues et la traduction automatique font l'objet d'un article dédié : Gérer les langues et la traduction automatique avec l'API Notiondesk . Les couleurs, les polices et la mise en page sont traitées dans Personnaliser l'image de marque et les thèmes du centre d'aide avec l'API Notiondesk .

Comment fonctionnent les mises à jour des paramètres

Chaque itinéraire sur cette page suit les mêmes règles :

• N'envoyez que les données modifiées. Un champ non renseigné conserve sa valeur actuelle.

• La réponse est 204 No Content , sans corps, même si rien n'a changé. Lisez le nouvel état avec GET /sites/{site_id}, comme décrit dans la section « Lire vos centres d'aide avec l'API Notiondesk » .

• Envoyer des booléens JSON. true ou false uniquement : les valeurs 0 et "false" sont lues comme true.

• Les champs inconnus sont rejetés avec le code 400 validation_error, et rien ne change.

• Les nouvelles tentatives sont sécurisées avec un Idempotency-Key. Voir Gestion des erreurs d'API, des limites de débit et des nouvelles tentatives Notiondesk .

Indexation par les moteurs de recherche, titres et descriptions des pages

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

Chaque objet dans items:

Un objet ne modifie que les champs qu'il contient, et une langue que vous omettez de items conserve son titre et sa description. items ne peut ni ajouter ni supprimer de langue.

Une erreur dans une langue la nomme dans le chemin du champ, par exemple items[fr].page_title.

seo_indexing_enabled: false demande aux moteurs de recherche de cesser d'indexer l'intégralité de votre centre d'aide. Voir Empêcher les moteurs de recherche d'explorer et d'indexer votre centre d'aide .

Optimisation par IA

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

Votre plan doit inclure l'optimisation par IA. Découvrez le rôle de chaque fonctionnalité dans la section « Configuration de l'optimisation par IA » de votre centre d'aide et dans l'introduction à l'optimisation GEO/IA .

Formulaire de contact

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

• L'API active ou désactive le formulaire, rien de plus. Les adresses de réception des soumissions sont définies dans le tableau de bord. Un corps de requête contenant destination_emails renvoie une erreur 400 validation_error sans aucune modification.

• Le formulaire reste actif uniquement si une adresse est enregistrée. L'activer pour un centre d'assistance sans adresse renvoie l'erreur 400 validation_error pour destination_emails. Veuillez d'abord définir une adresse dans le tableau de bord. Pour désactiver le formulaire, aucune adresse n'est requise.

• Votre plan doit inclure des options de personnalisation avancées, permettant même de désactiver le formulaire.

Journal des modifications

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

Chaque objet dans changelog_categories possède un category_id obligatoire, le id de l'une de vos collections, et un color facultatif de jusqu'à 255 caractères.

changelog_categories Remplace l'ensemble complet. Une collection non incluse cesse d'être une collection de journal des modifications et toutes les autres sont supprimées. Consultez la première section si vous souhaitez n'en ajouter qu'une. L'ensemble peut contenir jusqu'à 100 collections.[]changelog_categoriesGET /sites/{site_id}

Votre forfait doit inclure le journal des modifications. Si les abonnements par e-mail sont activés mais que votre forfait n'inclut plus les notifications par e-mail du journal des modifications, chaque requête adressée à cette route répondra par 403 permission_denied jusqu'à l'envoi de "email_subscriptions_enabled": false.

Pour en savoir plus, consultez la section « Configuration des journaux de modifications dans votre centre d’aide » et « Comment activer les abonnements par e-mail pour vos journaux de modifications » .

Erreurs

Consultez la section « Gérer les erreurs d’API Notiondesk, les limites de débit et les nouvelles tentatives » pour connaître l’enveloppe d’erreur et les autres codes.

Questions fréquentes

Et ensuite ?

• Personnalisez l'image de marque et les thèmes du centre d'aide avec l'API Notiondesk

• Gérez les intégrations du centre d'aide avec l'API Notiondesk

• Gérez les langues et la traduction automatique avec l'API Notiondesk