Crear comentarios sobre artículos

Registra la valoración de un lector sobre si un artículo le resultó útil o no, la misma señal que recopila el centro de ayuda.

POST /v1/feedback

Token Bearer ámbito content:write

curl 'https://api.ferndesk.com/v1/feedback' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "article_id": "art_01JXY9AZK4KV",
  "type": "positive",
  "feedback": "This walkthrough was clear and accurate.",
  "email": "[email protected]"
}'

{
  "id": "artfb_01JXY9AZK4KV",
  "articleId": "article_01JXY9AZK4KV",
  "articleTitle": "Getting started with API keys",
  "type": "positive",
  "feedback": "This walkthrough was clear and accurate.",
  "email": "[email protected]",
  "resolved": false,
  "createdAt": "2026-01-15T18:25:43.511Z",
  "user": {
    "id": "hcusr_01JXYB3S2Y8C",
    "name": "Alice Example",
    "email": "[email protected]"
  }
}

Comentario creado

Cuerpo

obligatorio application/json

article_id string obligatorio

Identificador del artículo.

type string · enumeración obligatorio

Indica si el lector consideró útil el artículo.

valores

positive
negative

feedback string · min length: 1· max length: 5000 obligatorio

Texto libre del lector; debe tratarse como no confiable.

email string · email · patrón

Dirección proporcionada por quien lo envía; una coincidencia vincula el comentario con ese usuario del centro de ayuda.

Cuerpo

Respuestas