Ferndesk

Artikel

Artikel verschieben

Verschiebt einen Artikel in eine andere Sammlung und/oder einen anderen Abschnitt. Erfordert den Scope content:write.

Erforderlicher Scope: content:write

POST /articles/{id}/move

Artikel verschieben

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/move' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "title": "<string>",
  "slug": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>"
}

Verschobener Artikel

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 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, Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikelfeedback 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 ausgestellte Schlüssel haben null Scopes = vollständigen Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

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

Request Body

application/json
  • collection_id string | null

    Ziel-ID der Sammlung oder null, um den Artikel aus allen Sammlungen zu entfernen.

  • section_id string

    Ziel-ID des Abschnitts.

Response

application/json
  • id string

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

  • title string

    Primärer Artikeltitel.

  • slug string | null

    URL-Slug des Artikels.

  • contentHtml string

    Als HTML gerenderter Artikelinhalt. Wird bereitgestellt, wenn format=html (Standard) verwendet wird.

  • contentMarkdown string

    Als Markdown gerenderter Artikelinhalt. Wird bereitgestellt, wenn format=markdown verwendet wird.

  • contentJson any | null

    Unverarbeitetes gespeichertes ProseMirror/Tiptap-Dokument. Wird bereitgestellt, wenn format=json verwendet wird. Verwendet das ProseMirror-Schema von Ferndesk (benutzerdefinierte Knoten wie callout, steps, cards) und ist die verlustfreie Darstellung.

  • url string (uri) | null

    Kanonische öffentliche URL für diesen Artikel.

  • sectionId string | null

    ID des Abschnitts, der den Artikel enthält.

  • collectionId string | null

    Optionale ID der Sammlung, der der Artikel zugeordnet ist.

  • status string | null

    Veröffentlichungsstatus des Artikels.

  • publishedAt string | null

    Zeitstempel der Veröffentlichung des Artikels.

  • createdAt string

    ISO-8601-Zeitstempel in UTC.

  • updatedAt string

    ISO-8601-Zeitstempel in UTC.