Atualize as configurações da central de ajuda com a API Notiondesk

A API Notiondesk permite que você altere as configurações da sua central de ajuda por meio de código: indexação em mecanismos de busca, título e descrição da página em cada idioma, otimização por IA, formulário de contato e registro de alterações. Use-a para aplicar a mesma configuração a várias centrais de ajuda ou para manter as configurações sob controle de versão.

Idiomas e tradução automática têm seu próprio artigo: Gerencie idiomas e tradução automática com a API Notiondesk . Cores, fontes e layout estão em Personalizar a identidade visual e os temas da central de ajuda com a API Notiondesk .

Como funcionam as atualizações de configurações

Todas as rotas nesta página seguem as mesmas regras:

• Envie apenas as alterações feitas. Um campo omitido manterá seu valor atual.

• A resposta é 204 No Content , sem corpo, mesmo quando nada mudou. Leia o novo estado com GET /sites/{site_id}, conforme descrito em Leia seus centros de ajuda com a API Notiondesk .

• Enviar valores booleanos JSON. Somente true ou false: os valores 0 e "false" são lidos como true.

• Campos desconhecidos são rejeitados com 400 validation_error, e nada muda.

• As novas tentativas são seguras com um Idempotency-Key. Consulte Handle Notiondesk erros de API, limites de taxa e novas tentativas .

Indexação em mecanismos de busca, títulos e descrições de páginas

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

Cada objeto em items:

Um objeto altera apenas os campos que contém, e um idioma que você omite de items mantém seu título e descrição. items não pode adicionar ou remover um idioma.

Um erro em um idioma o nomeia no caminho do campo, por exemplo, items[fr].page_title.

seo_indexing_enabled: false Solicita aos mecanismos de busca que parem de indexar toda a sua central de ajuda. Consulte Impedir que os mecanismos de busca rastreiem e indexem sua central de ajuda .

Otimização de 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}'

Seu plano deve incluir otimização por IA. Saiba mais sobre a função de cada recurso em Configurando a otimização por IA na sua central de ajuda e em Introdução à otimização GEO/IA .

Formulário de contato

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

• A API ativa ou desativa o formulário, nada mais. Os endereços que recebem os envios são definidos no painel de controle. Um corpo com destination_emails responde com 400 validation_error e não altera nada.

• O formulário permanece ativo apenas se houver um endereço cadastrado. Ativá-lo para uma central de ajuda sem endereço resultará na resposta 400 validation_error para destination_emails. Primeiro, defina um endereço no painel de controle. Desativar o formulário não requer um endereço.

• Seu plano deve incluir opções avançadas de personalização, inclusive para desativar o formulário.

Registro de alterações

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

Cada objeto em changelog_categories tem um category_id obrigatório, o id de uma de suas coleções e um color opcional de até 255 caracteres.

changelog_categories Substitui todo o conjunto. Uma coleção que você omite deixa de ser uma coleção de changelog e remove todas as outras. Leia a partir da primeira quando quiser adicionar apenas uma. O conjunto comporta até 100 coleções.[]changelog_categoriesGET /sites/{site_id}

Seu plano deve incluir o registro de alterações. Se as assinaturas de e-mail estiverem ativadas, mas seu plano não incluir mais notificações de e-mail sobre alterações, todas as solicitações para esta rota responderão com 403 permission_denied até que enviem "email_subscriptions_enabled": false.

Saiba mais em Como configurar registros de alterações na sua central de ajuda e Como ativar assinaturas de e-mail para seus registros de alterações .

Erros

Consulte a seção sobre erros da API Handle Notiondesk, limites de taxa e novas tentativas para obter informações sobre o envelope do erro e os demais códigos.

Perguntas frequentes

O que vem a seguir?

• Personalize a identidade visual e os temas da central de ajuda com a API Notiondesk

• Gerencie as integrações da central de ajuda com a API Notiondesk

• Gerencie idiomas e tradução automática com a API Notiondesk