Ferndesk

Artikel

Artikel aktualisieren

Aktualisiert einen bestehenden Hilfe-Center-Artikel. Inhaltsänderungen (Titel, Untertitel, Textkörper) erstellen und veröffentlichen automatisch eine neue Revision. Reine Metadatenänderungen (Slug, SEO-Felder, Sammlung) werden direkt angewendet.\n\nExterne Artikel, die über Integrationen verwaltet werden, können nicht über diesen Endpunkt aktualisiert werden.

PATCH /articles/{id}

Artikel aktualisieren

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

Aktualisierter Artikel

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel haben das Präfix fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Entwickler-Einstellungen erstellen und verwalten.

Path Parameters

  • id string erforderlich

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

Request Body

application/json
  • title string

    Aktualisierter Artikeltitel.

  • subtitle string | null

    Aktualisierter Artikeluntertitel.

  • content any

    Aktualisierter Artikelinhalt.

  • collectionId string | null

    Aktualisierte Sammlungszuordnung.

  • keywords string

    Aktualisierte SEO-Keywords.

  • metaDescription string

    Aktualisierte SEO-Meta-Beschreibung.

  • ogImage string

    Aktualisierte Open-Graph-Bild-URL.

  • slug string

    Aktualisierter benutzerdefinierter Slug. Wenn dieser vom bestehenden Slug abweicht, wird der Modus für benutzerdefinierte Slugs aktiviert.

Response

application/json
  • id string

    Ferndesk Artikel-ID (art_...).

  • title string

    Primärer Artikeltitel.

  • contentHtml string

    Artikelinhalt, gerendert als HTML.

  • url string (uri) | null

    Kanonische öffentliche URL für diesen Artikel.

  • sectionId string | null

    Abschnitts-ID, die den Artikel enthält.

  • collectionId string | null

    Optionale Sammlungs-Gruppierungs-ID für den Artikel.

  • 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.