Actualiza la configuración del centro de ayuda con la API Notiondesk

La API Notiondesk permite modificar la configuración del centro de ayuda mediante código: indexación en buscadores, título y descripción de la página en cada idioma, optimización mediante IA, formulario de contacto y registro de cambios. Úsela para aplicar la misma configuración a varios centros de ayuda o para mantener la configuración bajo control de versiones.

Los idiomas y la traducción automática tienen su propio artículo: Administrar idiomas y traducción automática con la API Notiondesk . Los colores, las fuentes y el diseño se encuentran en Personalizar la imagen de marca y los temas del centro de ayuda con la API Notiondesk .

Cómo funcionan las actualizaciones de configuración

Todas las rutas de esta página siguen las mismas reglas:

• Envía solo los cambios que realices. Los campos que omitas conservarán su valor actual.

• La respuesta es 204 No Content , sin cuerpo, incluso cuando nada ha cambiado. Lea el nuevo estado con GET /sites/{site_id}, como se describe en Lea sus centros de ayuda con la API Notiondesk .

• Enviar valores booleanos JSON. Solo true o false: los valores 0 y "false" se leen como true.

• Los campos desconocidos se rechazan con 400 validation_error y no cambia nada.

• Los reintentos son seguros con un Idempotency-Key. Consulte Manejo de errores de API, límites de velocidad y reintentos en Notiondesk .

Indexación en motores de búsqueda, títulos y descripciones 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 en items:

Un objeto solo cambia los campos que contiene, y un idioma que no se incluya en items conserva su título y descripción. items no puede agregar ni eliminar un idioma.

Un error en un idioma lo nombra en la ruta del campo, por ejemplo items[fr].page_title.

seo_indexing_enabled: false solicita a los motores de búsqueda que dejen de indexar todo tu centro de ayuda. Consulta Cómo evitar que los motores de búsqueda rastreen e indexen tu centro de ayuda .

Optimización 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}'

Tu plan debe incluir la optimización mediante IA. Descubre qué hace cada función en la sección "Configuración de la optimización mediante IA" de tu centro de ayuda y en la "Introducción a la optimización mediante GEO/IA" .

Formulario de contacto

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

• La API activa o desactiva el formulario, nada más. Las direcciones que reciben los envíos se configuran en el panel de control. Un cuerpo con destination_emails responde con 400 validation_error y no cambia nada.

• El formulario solo permanece activo si se ha guardado una dirección. Si se activa para un centro de ayuda sin dirección, se produce el error 400 validation_error para destination_emails. Primero, configure una dirección en el panel de control. Para desactivar el formulario no se necesita una dirección.

• Tu plan debe incluir opciones de personalización avanzadas, incluso para desactivar el formulario.

Registro de cambios

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 en changelog_categories tiene un category_id obligatorio, el id de una de sus colecciones y un color opcional de hasta 255 caracteres.

changelog_categories Reemplaza todo el conjunto. Si omites una colección, deja de ser una colección de registro de cambios y se eliminan todas. Lee desde la primera si solo quieres añadir una. El conjunto admite hasta 100 colecciones.[]changelog_categoriesGET /sites/{site_id}

Tu plan debe incluir el registro de cambios. Si las suscripciones por correo electrónico están activadas, pero tu plan ya no incluye notificaciones por correo electrónico del registro de cambios, cada solicitud a esta ruta responderá 403 permission_denied hasta que envíe "email_subscriptions_enabled": false.

Para obtener más información, consulta Configuración de registros de cambios en tu centro de ayuda y Cómo habilitar las suscripciones por correo electrónico para tus registros de cambios .

Errores

Consulte Handle Notiondesk Errores de API, límites de velocidad y reintentos para obtener el envoltorio de error y los demás códigos.

Preguntas frecuentes

¿Qué sigue?

• Personaliza la imagen de marca y los temas del centro de ayuda con la API Notiondesk

• Gestiona las integraciones del centro de ayuda con la API Notiondesk

• Gestiona idiomas y traducción automática con la API Notiondesk