Ferndesk

Articles

Update article

Updates an existing help center article. Content changes (title, subtitle, body) create and publish a new revision automatically. Metadata-only changes (slug, SEO fields, collection) are applied directly.

External articles managed by integrations cannot be updated through this endpoint.

PATCH /articles/{id}

Update 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>"
}

Updated article

Authorizations

  • Authorization string required header

    All requests require a Bearer token in the Authorization header. API keys are prefixed with fdsk_ and should be kept secret. You can generate and manage keys from the Developer settings page.

Path Parameters

  • id string required

    Resource ID for the requested entity. Example: art_01JXY9AZK4KV

Request Body

application/json
  • title string

    Updated article title.

  • subtitle string | null

    Updated article subtitle.

  • content any

    Updated article content.

  • collectionId string | null

    Updated collection assignment.

  • keywords string

    Updated SEO keywords.

  • metaDescription string

    Updated SEO meta description.

  • ogImage string

    Updated Open Graph image URL.

  • slug string

    Updated custom slug. If changed from the existing slug, custom slug mode is enabled.

Response

application/json
  • id string

    Ferndesk article ID (art_...).

  • title string

    Primary article title.

  • contentHtml string

    Article content rendered as HTML.

  • url string (uri) | null

    Canonical public URL for this article.

  • sectionId string | null

    Section ID containing the article.

  • collectionId string | null

    Optional collection grouping ID for the article.

  • status string | null

    Article publish status.

  • publishedAt string | null

    Timestamp when the article was published.

  • createdAt string

    ISO 8601 timestamp in UTC.

  • updatedAt string

    ISO 8601 timestamp in UTC.