Ferndesk

Artikel

Artikel erstellen

Erstellt einen neuen Hilfe-Center-Artikel und veröffentlicht ihn sofort. Sie können ihn optional einer Sammlung zuweisen, SEO-Metadaten festlegen und einen benutzerdefinierten Slug angeben.

Rate limit: 60 Anfragen pro Stunde pro API-Schlüssel.

POST /articles

Artikel erstellen

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles' \
  --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>"
}

Artikel erstellt

Authorizations

  • Authorization string erforderlich header

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

Request Body

application/json
  • title string erforderlich

    Artikeltitel.

  • subtitle string | null

    Optionaler Artikel-Untertitel.

  • content any

    Inhalts-Payload des Artikels. Falls weggelassen, wird ein leerer Entwurfstext verwendet.

  • sectionId string erforderlich

    Section ID, in der der Artikel erstellt werden soll.

  • collectionId string | null

    Optionale collectionId zur Gruppierung dieses Artikels.

  • keywords string

    SEO-Schlüsselwörter.

  • metaDescription string

    SEO-Metabeschreibung.

  • ogImage string

    Open Graph Bild-URL.

  • slug string

    Benutzerdefinierter URL-Slug. Die Angabe eines neuen Slugs aktiviert automatisch den benutzerdefinierten Slug-Modus.

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

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