Ferndesk

Articles

Déplacer un article

Déplace un article vers une autre collection et/ou section. Nécessite le scope content:write.

Scope requis : content:write

POST /articles/{id}/move

Déplacer un article

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/move' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "title": "<string>",
  "slug": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>"
}

Article déplacé

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton 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 des articles et des collections
    • content:publish : Publier, dépublier, restaurer et mettre à la corbeille du contenu (rendre les modifications effectives)
    • analytics:read : Lire les rapports, les analyses et les 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

    L’octroi de 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 hérité).

Path Parameters

  • id string requis

    ID de ressource de l’entité demandée. Exemple: art_01JXY9AZK4KV

Request Body

application/json
  • collection_id string | null

    ID de la collection cible, ou null pour retirer l’article de toute collection.

  • section_id string

    ID de la section cible.

Response

application/json
  • id string

    ID d’article Ferndesk (art_...).

  • title string

    Titre principal de l’article.

  • slug string | null

    Slug d’URL de l’article.

  • contentHtml string

    Contenu de l’article rendu en HTML. Présent lorsque format=html (par défaut).

  • contentMarkdown string

    Contenu de l’article rendu en Markdown. Présent lorsque format=markdown.

  • contentJson any | null

    Document ProseMirror/Tiptap brut stocké. Présent lorsque format=json. Utilise le schéma ProseMirror de Ferndesk (nœuds personnalisés tels que callout, steps, cards) et constitue la représentation sans perte.

  • url string (uri) | null

    URL publique canonique de cet article.

  • sectionId string | null

    ID de la section contenant l’article.

  • collectionId string | null

    ID de regroupement de collection facultatif pour l’article.

  • status string | null

    Statut de publication de l’article.

  • publishedAt string | null

    Horodatage de publication de l’article.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • updatedAt string

    Horodatage ISO 8601 en UTC.