Ferndesk

Artikelentwürfe

Entwurf eines Artikels aktualisieren

Aktualisiert einen offenen Entwurf. Der Besitz des Entwurfs wird vom Dienst erzwungen: Das Bearbeiten eines Entwurfs, der einem anderen Autor gehört, gibt 409 draft_conflict zurück. Erfordert den Scope content:write.

Erforderlicher Scope: content:write

PATCH /articles/{id}/drafts/{draftId}

Entwurf eines Artikels aktualisieren

curl --request PATCH \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts/{DRAFTID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "language": "<string>",
  "status": "<string>",
  "baseVersion": 1,
  "source": "<string>",
  "stale": true,
  "updatedAt": "<string>"
}

Aktualisierter Entwurf

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Header Authorization. API-Schlüssel haben 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 Scopes beschränkt werden (jeder Endpunkt listet den erforderlichen Scope ü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 beinhaltet content:read. Vor der Einführung von Scopes ausgestellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • draftId string erforderlich

    Entwurfs-ID. Beispiel: drft_01JXY9AZK4KV

  • id string erforderlich

    Ferndesk-Artikel-ID (art_...). Beispiel: art_01JXY9AZK4KV

Request Body

application/json
  • title string
  • content any

    JSON-Dokument-Payload. Für Artikel handelt es sich typischerweise um ein Rich-Text-Objekt im Stil von ProseMirror/Tiptap. src-Werte von Bildknoten können Ferndesk-Asset-Pfade, externe Bild-URLs oder data:image/...;base64,...-Werte sein; externe URLs und Base64-Bilder werden beim Schreiben hochgeladen und in Ferndesk-Asset-Pfade umgeschrieben.

  • markdown string

Response

application/json
  • id string

    Entwurfs-ID.

  • language string | null

    Sprache des Entwurfs.

  • status string

    Status des Entwurfs.

  • baseVersion integer

    Artikelversion, auf der der Entwurf basiert.

  • source string | null

    Schreibkanal, der den Entwurf erstellt hat.

  • stale boolean

    Gibt an, ob der Artikel seit der Erstellung der Grundlage des Entwurfs weiterentwickelt wurde (nur primäre Entwürfe).

  • updatedAt string

    ISO-8601-Zeitstempel in UTC.