Ferndesk

Collections

Créer une collection

Crée une collection au sein d’une section. Nécessite le scope content:write.

Scope requis : content:write

POST /collections

Créer une collection

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": []
}

Collection créée

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un token Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Paramètres développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces scopes (chaque endpoint indique le scope requis via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier les brouillons d’articles, les utilisateurs et les tâches ; déplacer les articles et les collections
    • content:publish : Publier, dépublier, restaurer et mettre à la corbeille le contenu (rendre les modifications visibles)
    • analytics:read : Lire les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    Accorder content:write ou content:publish implique content:read. Les clés créées avant la mise en place des scopes ont des scopes null = accès complet (mode legacy).

Request Body

application/json
  • title string requis

    Titre de la collection.

  • subtitle string | null

    Sous-titre facultatif.

  • sectionId string requis

    ID de la section parente.

  • parentCollectionId string | null

    ID de la collection parente pour l’imbrication.

Response

application/json
  • id string

    ID de la collection Ferndesk (col_...).

  • helpdeskId string

    ID du helpdesk Ferndesk (help_...).

  • sectionId string | null

    ID de la section parente de cette collection.

  • parentCollectionId string | null

    ID de la collection parente si celle-ci est imbriquée.

  • title string

    Titre de la collection.

  • subtitle string | null

    Sous-titre facultatif de la collection.

  • shortId string

    Identifiant court lisible par l’utilisateur.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • updatedAt string

    Horodatage ISO 8601 en UTC.

  • translations[] object arraydefault

    Traductions localisées de la collection. Default: [].

    + Show Child Attributes
    • id string

      ID de l’enregistrement de traduction de la collection.

    • collectionId string

      ID de la collection Ferndesk (col_...).

    • language string

      Code de langue de cette traduction.

    • title string

      Titre localisé de la collection.

    • subtitle string | null

      Sous-titre localisé de la collection.

    • status string

      Statut de la traduction.

    • createdAt string

      Horodatage ISO 8601 en UTC.

    • updatedAt string

      Horodatage ISO 8601 en UTC.