Ferndesk

Artikel

Einen Artikel in den Papierkorb verschieben

Verschiebt einen Artikel in den Papierkorb (umkehrbar). Er verschwindet sofort aus öffentlichen Ansichten und der Suche und kann bis zur endgültigen Löschung nach 30 Tagen über POST /articles/:id/restore wiederhergestellt werden. Erfordert den Scope content:write; das Verschieben eines PUBLISHED-Artikels in den Papierkorb nimmt den Live-Inhalt offline und erfordert zusätzlich content:publish.

Erforderlicher Scope: content:write

DELETE /articles/{id}

Einen Artikel in den Papierkorb verschieben

curl --request DELETE \
  --url 'https://api.ferndesk.com/v1/articles/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "status": "<string>"
}

In den Papierkorb verschoben

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel über die Seite Developer settings erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfezentrumsartikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, deren Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfezentrums lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von Scopes erstellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ressourcen-ID der angeforderten Entität. Beispiel: art_01JXY9AZK4KV

Response

application/json
  • id string

    Ferndesk article ID (art_...).

  • status string