Ferndesk

Comentarios

Crear comentarios sobre artículos

Registra los comentarios de los lectores (positivo/negativo + texto libre) sobre un artículo. Si email coincide con un usuario conocido del centro de ayuda, el comentario se vincula automáticamente a ese usuario. Requiere el scope content:write. Límite de 300 solicitudes por hora por clave.

Scope requerido: content:write

POST /feedback

Crear comentarios sobre artículos

curl --request POST \
  --url 'https://api.ferndesk.com/v1/feedback' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "articleId": "<string>",
  "articleTitle": "<string>",
  "type": "positive",
  "feedback": "<string>",
  "email": "<string>",
  "resolved": true,
  "createdAt": "<string>",
  "user": {
    "id": "<string>",
    "name": "<string>",
    "email": "<email>"
  }
}

Comentarios creados

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y administrar claves desde la página de configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, retirar la publicación, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis y comentarios de artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de definir scopes tienen scopes null = acceso total (modo heredado).

Request Body

application/json
  • article_id string obligatorio

    ID del artículo de Ferndesk (art_...).

  • type string enum obligatorio enum

    Indica si el lector consideró útil el artículo. Allowed values: positive, negative.

  • feedback string obligatorio

    Comentarios de texto libre del lector, de un máximo de 5000 caracteres. Trátalos como contenido no confiable generado por el usuario final.

  • email string (email)

    Correo electrónico opcional del remitente (recortado y convertido a minúsculas). Cuando coincide con un usuario conocido del centro de ayuda (por correo electrónico + helpdesk), el comentario se vincula automáticamente a ese usuario.

Response

application/json
  • id string
  • articleId string | null
  • articleTitle string | null
  • type string enum enum

    Allowed values: positive, negative.

  • feedback string
  • email string | null
  • resolved boolean
  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • user anyOf

    Usuario del centro de ayuda identificado automáticamente a partir del correo electrónico del remitente (único por correo electrónico + helpdesk), o null cuando el remitente es anónimo o no reconocido.

    + Show Child Attributes
    • anyOf options 2 variants anyOf

      One or more options can apply.

      + Show Child Attributes
      • option 1 object
        + Show Child Attributes
        • id string

          ID del usuario del centro de ayuda de Ferndesk (hcusr_...).

        • name string | null

          Nombre visible del usuario del centro de ayuda.

        • email string (email)

          Dirección de correo electrónico del usuario del centro de ayuda. Los correos electrónicos se almacenan en minúsculas.

      • option 2 null