Ferndesk

Artikel

Artikel veröffentlichen

Veröffentlicht einen offenen Entwurf und macht ihn zur Live-Version.

  • Geben Sie draft_id an, um einen bestimmten Entwurf zu veröffentlichen.
  • Lassen Sie draft_id nur weg, wenn genau ein offener, von diesem API-Schlüssel erstellter Entwurf vorhanden ist; andernfalls wird no_draft (409) zurückgegeben.

Veraltete Veröffentlichungen geben 409 mit code: draft_outdated sowie den aktuellen und Basisversionen zurück, damit Sie einen Rebase durchführen können. Erfordert den Bereich content:publish.

Erforderlicher Bereich: content:publish

POST /articles/{id}/publish

Artikel veröffentlichen

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/publish' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "status": "<string>",
  "version": 1
}

Veröffentlicht

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel tragen das Präfix 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: Hilfe-Center-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, die Veröffentlichung aufheben, wiederherstellen und löschen (Änderungen live schalten)
    • analytics:read: Hilfe-Center-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 von Bereichen erstellte Schlüssel haben null Bereiche = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

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

Request Body

application/json
  • draft_id string

    Zu veröffentlichender Entwurf. Optional, wenn genau ein offener, von diesem API-Schlüssel erstellter Entwurf vorhanden ist.

Response

application/json
  • id string

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

  • status string
  • version integer

    Neue Artikelversion nach der Veröffentlichung.