Ferndesk

Abschnitte

Abschnitt erstellen

Erstellt einen Abschnitt der obersten Ebene. Erfordert den content:write-Scope.

Erforderlicher Scope: content:write

POST /sections

Abschnitt erstellen

curl --request POST \
  --url 'https://api.ferndesk.com/v1/sections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "helpdeskId": "<string>",
  "name": "<string>",
  "isDefault": true,
  "position": 1,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "translations": []
}

Abschnitt erstellt

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 Keys auf der Seite Developer settings erstellen und verwalten.

    Keys 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: Lesen und Durchsuchen von Help-Center-Artikeln, Sammlungen, Abschnitten und Übersetzungen
    • content:write: Erstellen und Bearbeiten von Artikelentwürfen, Benutzern und Aufgaben; Verschieben von Artikeln und Sammlungen
    • content:publish: Veröffentlichen, Zurücknehmen der Veröffentlichung, Wiederherstellen und Löschen von Inhalten (Änderungen live schalten)
    • analytics:read: Lesen von Help-Center-Berichten, Analysen und Artikel-Feedback
    • conversations:read: Lesen von KI-Assistenten-Konversationen und Transkripten
    • webhooks:manage: Erstellen und Verwalten ausgehender Webhook-Abonnements

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Keys, die vor der Einführung von Scopes erstellt wurden, haben null Scopes = vollständigen Zugriff (Legacy-Modus).

Request Body

application/json
  • name string erforderlich

    Name des Abschnitts.

  • slug string

    Optionaler URL-Slug.

Response

application/json
  • id string

    Ferndesk-Abschnitts-ID (sect_...).

  • helpdeskId string

    Ferndesk-Helpdesk-ID (help_...).

  • name string

    Anzeigename des Abschnitts.

  • isDefault boolean

    Gibt an, ob dieser Abschnitt der Standardabschnitt im Help Center ist.

  • position integer

    Sortierposition für die Reihenfolge der Abschnitte.

  • createdAt string

    ISO 8601-Zeitstempel in UTC.

  • updatedAt string

    ISO 8601-Zeitstempel in UTC.

  • translations[] object arraydefault

    Lokalisierte Übersetzungen des Abschnitts. Default: [].

    + Show Child Attributes
    • id string

      ID des Abschnittsübersetzungsdatensatzes.

    • sectionId string

      Ferndesk-Abschnitts-ID (sect_...).

    • language string

      Sprachcode für diese Übersetzung.

    • name string

      Lokalisierter Abschnittsname.

    • status string

      Übersetzungsstatus.

    • createdAt string

      ISO 8601-Zeitstempel in UTC.

    • updatedAt string

      ISO 8601-Zeitstempel in UTC.