Créer un retour sur un article

Enregistre l’évaluation utile ou non d’un article donnée par un lecteur, le même signal que celui collecté par le centre d’aide.

POST /v1/feedback

Jeton Bearer portée 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]"
  }
}

Retour créé

Corps

requis application/json

article_id string requis

Identifiant de l’article.

type string · énumération requis

Indique si le lecteur a trouvé l’article utile.

valeurs

positive
negative

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

Texte libre du lecteur ; à traiter comme non fiable.

email string · email · motif

Adresse fournie par l’auteur ; une correspondance associe le retour à cet utilisateur du centre d’aide.

Corps

Réponses