Ferndesk

Artikel

Artikel unveröffentlichen

Nimmt einen veröffentlichten Artikel offline und setzt ihn wieder auf den Entwurfsstatus zurück. Erfordert den Scope content:publish.

Erforderlicher Scope: content:publish

POST /articles/{id}/unpublish

Artikel unveröffentlichen

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

Unveröffentlicht

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 auf der Seite Entwicklereinstellungen erstellen und verwalten.

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

    • content:read: Hilfeartikel, Sammlungen, Abschnitte und Übersetzungen im Help Center lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, unveröffentlichen, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Help Centers 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 schließt content:read ein. Vor der Einführung von Scopes erstellte Schlüssel haben null scopes = Vollzugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ressourcen-ID für die angeforderte Entität. Beispiel: art_01JXY9AZK4KV

Response

application/json
  • id string

    Ferndesk-Artikel-ID (art_...).

  • status string