Aggiorna le impostazioni del centro assistenza con l'API Notiondesk

Aggiorna le impostazioni del centro assistenza Notiondesk tramite l'API REST: indicizzazione SEO, titoli delle pagine, esportazione di llms.txt e markdown, modulo di contatto e registri delle modifiche.

6 min di lettura

L'API Notiondesk consente di modificare le impostazioni del centro assistenza tramite codice: indicizzazione nei motori di ricerca, titolo e descrizione della pagina in ogni lingua, ottimizzazione AI, modulo di contatto e registro delle modifiche. Utilizzala per applicare la stessa configurazione a più centri assistenza o per tenere le impostazioni sotto controllo di versione.

Metodo Sentiero Ambito di applicazione Modifiche
PATCH/sites/{site_id}/settings/contentwriteIndicizzazione nei motori di ricerca, titolo e descrizione della pagina per lingua
PATCH/sites/{site_id}/settings/ai-optimizationwritellms.txt, esportazione markdown e menu contestuale AI
PATCH/sites/{site_id}/settings/contact-formwriteSe il modulo di contatto viene visualizzato
PATCH/sites/{site_id}/settings/changelogwriteIl registro delle modifiche e le relative opzioni

Le lingue e la traduzione automatica hanno un articolo dedicato: Gestisci lingue e traduzione automatica con l'API Notiondesk . Colori, caratteri e layout sono descritti in Personalizza il branding e i temi del centro assistenza con l'API Notiondesk .

Come funzionano gli aggiornamenti delle impostazioni

Ogni percorso in questa pagina segue le stesse regole:

  • Invia solo i dati modificati. Un campo lasciato vuoto manterrà il suo valore corrente.
  • Invia valori booleani JSON. Solo true o false: i valori 0 e "false" vengono letti come true.
  • I campi sconosciuti vengono rifiutati con il codice 400 validation_error e non cambia nulla.

Indicizzazione nei motori di ricerca, titoli e descrizioni delle pagine

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"}]}'
Campo Tipo Note Rileggi come
seo_indexing_enabledbooleano Se i motori di ricerca possono indicizzare il centro assistenzaseo_indexing_enabled
itemselenco di oggetti Un oggetto per lingua da modificaresetting_content_items

Ogni oggetto in items:

Campo Tipo Note
localecorda Obbligatorio. Una lingua supportata dal centro assistenza, al massimo una volta nell'elenco.
page_titlestringa o null Fino a 255 caratteri. null lo cancella
page_descriptionstringa o null Fino a 255 caratteri. null lo cancella

Un oggetto modifica solo i campi che contiene e una lingua che si omette da items mantiene il suo titolo e la sua descrizione. items non può aggiungere o rimuovere una lingua.

Un errore in una lingua lo specifica nel percorso del campo, ad esempio items[fr].page_title.

seo_indexing_enabled: false chiede ai motori di ricerca di interrompere l'indicizzazione dell'intero centro assistenza. Vedi Impedire ai motori di ricerca di eseguire la scansione e l'indicizzazione del centro assistenza .

ottimizzazione dell'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}'
Campo Tipo Rileggi come
llms_txt_enabledbooleano: indica se il centro assistenza pubblica llms.txtllms_txt_enabled
markdown_export_enabledbooleano: indica se gli articoli possono essere letti come markdownmarkdown_export_enabled
ai_contextual_menu_enabledbooleano: indica se gli articoli mostrano il menu contestuale dell'IAai_contextual_menu_enabled

Il tuo piano deve includere l'ottimizzazione AI. Scopri a cosa serve ogni funzionalità in "Configurazione dell'ottimizzazione AI" nel tuo centro assistenza e in "Introduzione all'ottimizzazione GEO/AI" .

Modulo di contatto

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}'
Campo Tipo Rileggi come
enabledbooleano: indica se il centro assistenza mostra il modulo di contattocontact_form_enabled
  • L'API attiva o disattiva il modulo, niente di più. Gli indirizzi che ricevono le richieste sono impostati nella dashboard. Un corpo con destination_emails risponde con un codice 400 validation_error e non cambia nulla.
  • Il modulo rimane attivo solo se è memorizzato un indirizzo. Attivandolo per un centro assistenza senza indirizzo, viene visualizzato il messaggio di errore 400 validation_error per destination_emails. Impostare prima un indirizzo nella dashboard. Per disattivare il modulo non è necessario specificare un indirizzo.
  • Il tuo piano deve includere opzioni di personalizzazione avanzate, fino alla possibilità di disattivare completamente il modulo.

Registro delle modifiche

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"}]}'
Campo Tipo Note Rileggi come
enabledbooleano Se il registro delle modifiche viene pubblicatochangelog_enabled
email_subscriptions_enabledbooleano Se i lettori possono iscriversi alle email del registro delle modifiche. true necessita di un piano con notifiche email del registro delle modifichechangelog_email_subscriptions_enabled
reactions_enabledbooleano Se i lettori possono reagire alle voci del registro delle modifichechangelog_reactions_enabled
email_subject_patterncorda Oggetto delle email di registro delle modifiche, fino a 255 caratteri. Non può essere cancellato: null e "" lo lasciano invariatochangelog_email_subject_pattern
changelog_categorieselenco di oggetti La raccolta completa dei registri delle modifichechangelog_categories

Ogni oggetto in changelog_categories ha un category_id obbligatorio, il id di una delle tue collezioni e un color facoltativo di massimo 255 caratteri.

changelog_categories Sostituisce l'intero set. Una raccolta che si esclude smette di essere una raccolta di registro delle modifiche e le rimuove tutte. Leggere dall'inizio quando si desidera aggiungere solo un elemento. Il set può contenere fino a 100 raccolte.[]changelog_categoriesGET /sites/{site_id}

Il tuo piano deve includere il registro delle modifiche. Se le iscrizioni via email sono attive ma il tuo piano non include più le notifiche email del registro delle modifiche, ogni richiesta a questa rotta risponde con 403 permission_denied finché non invia "email_subscriptions_enabled": false.

Per saperne di più, consulta le guide "Configurare i registri delle modifiche nel centro assistenza" e "Come abilitare le iscrizioni via email per i registri delle modifiche" .

Errori

Stato Quandocode
400 Un valore non è valido o è troppo lungo, una lingua o una raccolta non è nota o è ripetuta, sono presenti più di 100 raccolte di registro delle modifiche, è stato inviato destination_emails, il modulo di contatto rimarrebbe attivo senza un indirizzo oppure il corpo contiene un campo sconosciutovalidation_error
403 La chiave non ha l'ambito writeinsufficient_scope
403 Il tuo piano non include la funzionalità (ottimizzazione AI, personalizzazione avanzata, registro delle modifiche o notifiche e-mail del registro delle modifiche) oppure il creatore della chiave non può modificare questo centro assistenzapermission_denied
404 Il centro assistenza non è presente nel tuo spazio di lavoronot_found

Consultare la sezione "Errori API, limiti di frequenza e tentativi" dell'handle Notiondesk per informazioni sull'intestazione dell'errore e sugli altri codici.

Domande frequenti

Come faccio a confermare una modifica alle impostazioni?

Leggi GET /sites/{site_id}. La colonna "Leggi come" di ciascun campo sopra riportata indica dove appare il nuovo valore.

Posso modificare gli indirizzi email del modulo di contatto tramite API?

No. Impostali nella dashboard. L'API si limita ad attivare o disattivare il modulo.

Posso attivare la ricerca MCP tramite API?

No. Attiva la ricerca MCP nella dashboard. L'API mostra il suo stato in mcp_search_enabled. Vedi Abilita la ricerca MCP .

Posso modificare la modalità di accesso al centro assistenza tramite API?

No. L'accesso pubblico, tramite password e per gli ospiti è impostato nella dashboard. L'API mostra la modalità corrente in access_mode.

Cosa succederà dopo?

Articoli correlati

Questa pagina è stata utile?

Still need help? Ask us