Ferndesk

Sammlungen

Eine Sammlung erstellen

Erstellt eine Sammlung innerhalb eines Abschnitts. Erfordert den content:write-Scope.

Erforderlicher Scope: content:write

POST /collections

Eine Sammlung erstellen

curl --request POST \
  --url 'https://api.ferndesk.com/v1/collections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "helpdeskId": "<string>",
  "sectionId": "<string>",
  "parentCollectionId": "<string>",
  "title": "<string>",
  "subtitle": "<string>",
  "shortId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "translations": []
}

Sammlung erstellt

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 Developer settings generieren und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den über x-required-scopes erforderlichen Scope auf):

    • content:read: Hilfecenter-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, deren Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfecenters 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 Scopes ausgestellte Schlüssel haben null Scopes = Vollzugriff (Legacy-Modus).

Request Body

application/json
  • title string erforderlich

    Titel der Sammlung.

  • subtitle string | null

    Optionaler Untertitel.

  • sectionId string erforderlich

    ID des übergeordneten Abschnitts.

  • parentCollectionId string | null

    ID der übergeordneten Sammlung für Verschachtelungen.

Response

application/json
  • id string

    Ferndesk-Sammlungs-ID (col_...).

  • helpdeskId string

    Ferndesk-Hilfecenter-ID (help_...).

  • sectionId string | null

    ID des übergeordneten Abschnitts für diese Sammlung.

  • parentCollectionId string | null

    ID der übergeordneten Sammlung, wenn diese verschachtelt ist.

  • title string

    Titel der Sammlung.

  • subtitle string | null

    Optionaler Untertitel der Sammlung.

  • shortId string

    Kurze, menschenfreundliche Kennung.

  • createdAt string

    ISO-8601-Zeitstempel in UTC.

  • updatedAt string

    ISO-8601-Zeitstempel in UTC.

  • translations[] object arraydefault

    Lokalisierte Übersetzungen der Sammlung. Default: [].

    + Show Child Attributes
    • id string

      ID des Übersetzungseintrags der Sammlung.

    • collectionId string

      Ferndesk-Sammlungs-ID (col_...).

    • language string

      Sprachcode für diese Übersetzung.

    • title string

      Lokalisierter Titel der Sammlung.

    • subtitle string | null

      Lokalisierter Untertitel der Sammlung.

    • status string

      Status der Übersetzung.

    • createdAt string

      ISO-8601-Zeitstempel in UTC.

    • updatedAt string

      ISO-8601-Zeitstempel in UTC.