Ferndesk

Sammlungen

Sammlung aktualisieren

Aktualisiert eine Sammlung. Erfordert den content:write-Scope.

Erforderlicher Scope: content:write

PATCH /collections/{id}

Sammlung aktualisieren

curl --request PATCH \
  --url 'https://api.ferndesk.com/v1/collections/{ID}' \
  --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 aktualisiert

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API keys 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: 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, Veröffentlichung aufheben, wiederherstellen und löschen (Änderungen live schalten)
    • analytics:read: Hilfecenter-Berichte, Analysen und Artikel-Feedback lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    content:write oder content:publish zu gewähren, schließt content:read ein. Vor der Einführung von Scopes erstellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

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

Request Body

application/json
  • title string
  • subtitle string | null
  • sectionId string
  • parentCollectionId string | null

Response

application/json
  • id string

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

  • helpdeskId string

    Ferndesk-Hilfedesk-ID (help_...).

  • sectionId string | null

    Übergeordnete Abschnitts-ID dieser Sammlung.

  • parentCollectionId string | null

    Übergeordnete Sammlungs-ID, wenn diese verschachtelt ist.

  • title string

    Titel der Sammlung.

  • subtitle string | null

    Optionaler Untertitel der Sammlung.

  • shortId string

    Kurze, menschenlesbare 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 Übersetzungsdatensatzes der Sammlung.

    • collectionId string

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

    • language string

      Sprachcode für diese Übersetzung.

    • title string

      Lokalisierter Sammlungstitel.

    • subtitle string | null

      Lokalisierter Untertitel der Sammlung.

    • status string

      Übersetzungsstatus.

    • createdAt string

      ISO-8601-Zeitstempel in UTC.

    • updatedAt string

      ISO-8601-Zeitstempel in UTC.