Ferndesk

Abschnitte

Abschnitt löschen

Löscht einen leeren Abschnitt. Ein Abschnitt mit Stammsammlungen, Artikeln oder API-Referenzen kann nicht gelöscht werden. Erfordert den Bereich content:write.

Erforderlicher Bereich: content:write

DELETE /sections/{id}

Abschnitt löschen

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

Gelöscht

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 Bereiche beschränkt werden (jeder Endpunkt führt den erforderlichen Bereich über x-required-scopes auf):

    • content:read: Hilfecenter-Artikel, 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, Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Hilfecenter-Berichte, Analysen und Artikel-Feedback 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 der Bereichsbeschränkung erstellte Schlüssel haben null Bereiche und somit vollständigen Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

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

Response

application/json
  • id string
  • deleted boolean