Ferndesk

Articles

Mettre à jour l'article

Met à jour un article existant du centre d'aide. Les modifications de contenu (titre, sous-titre, corps) créent et publient automatiquement une nouvelle révision. Les modifications de métadonnées uniquement (slug, champs SEO, collection) sont appliquées directement.

Les articles externes gérés par des intégrations ne peuvent pas être mis à jour via ce point de terminaison.

PATCH /articles/{id}

Mettre à jour l'article

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

Article mis à jour

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 des Paramètres développeur.

Path Parameters

  • id string requis

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

Request Body

application/json
  • title string

    Titre de l'article mis à jour.

  • subtitle string | null

    Sous-titre de l'article mis à jour.

  • content any

    Contenu de l'article mis à jour.

  • collectionId string | null

    Assignation de collection mise à jour.

  • keywords string

    Mots-clés SEO mis à jour.

  • metaDescription string

    Méta-description SEO mise à jour.

  • ogImage string

    URL de l'image Open Graph mise à jour.

  • slug string

    Slug personnalisé mis à jour. S'il est différent du slug existant, le mode slug personnalisé est activé.

Response

application/json
  • id string

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

  • title string

    Titre principal de l'article.

  • contentHtml string

    Contenu de l'article rendu en HTML.

  • 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 optionnel pour l'article.

  • status string | null

    Statut de publication de l'article.

  • publishedAt string | null

    Horodatage de la publication de l'article.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • updatedAt string

    Horodatage ISO 8601 en UTC.