Skip to main content
PATCH
/
knowledge
/
articles
/
{id}
Update an article
curl --request PATCH \
  --url https://api.getfernand.com/knowledge/articles/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "seo_title": "<string>",
  "slug": "<string>",
  "previous_url": "<string>",
  "description": "<string>",
  "content": "<string>",
  "collections": [
    123
  ],
  "published": true,
  "visibility": "public"
}
'
{
  "id": 123,
  "title": "How to get started",
  "seo_title": "Getting Started Guide - Complete Tutorial",
  "slug": "how-to-get-started",
  "previous_url": "<string>",
  "description": "Learn how to set up your account and start using our platform in minutes.",
  "content": "<p>Welcome to our platform! This guide will help you get started...</p>",
  "created": "2023-11-07T05:31:56Z",
  "last_updated": "2023-11-07T05:31:56Z",
  "published": true,
  "get_collections": [
    {
      "collection_id": 1,
      "sort": 1
    },
    {
      "collection_id": 3,
      "sort": 2
    }
  ],
  "visibility": "public",
  "get_url": "https://help.piedpiper.com/getting-started/introduction"
}
Updates article properties. Publishing an article generates a social banner and processes content. Collection assignments can be modified - new collections are added, removed collections trigger sort order updates. If the article URL changes (slug or collections), internal references are updated. Changes to content or slug update the AI data store if enabled.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Path Parameters

​
id
integer
required

ID of the article to update.

Body

application/json
​
title
string

Display title of the article (optional).

Maximum string length: 250
​
seo_title
string | null

SEO-optimized title (optional).

Maximum string length: 250
​
slug
string

URL-safe slug (optional, must be unique).

Maximum string length: 250
​
previous_url
string | null

Previous URL for migration tracking (optional).

Maximum string length: 250
​
description
string | null

Brief description for SEO (optional).

Maximum string length: 250
​
content
string | null

HTML content with images (optional).

Maximum string length: 16000000
​
collections
(integer | null)[] | null

Array of collection IDs (optional, at least one if provided).

​
published
boolean

Publication status (optional).

​
visibility
enum<string> | null

Visibility setting (optional).

Available options:
public,
chat,
chat_auth
Maximum string length: 10

Response

Article updated successfully.

​
id
integer<int64>

Unique identifier for the article.

​
title
string

Display title of the article.

Maximum string length: 250
Example:

"How to get started"

​
seo_title
string

SEO-optimized title for search engines and meta tags.

Maximum string length: 250
Example:

"Getting Started Guide - Complete Tutorial"

​
slug
string

URL-safe slug used in the article's URL path.

Maximum string length: 250
Example:

"how-to-get-started"

​
previous_url
string | null

Previous URL if the article was migrated from another help system, used for redirect tracking.

Maximum string length: 250
​
description
string | null

Brief description used for SEO meta tags and article previews.

Maximum string length: 250
Example:

"Learn how to set up your account and start using our platform in minutes."

​
content
string | null

Full HTML content of the article including formatted text, images, code blocks, and embedded media.

Example:

"<p>Welcome to our platform! This guide will help you get started...</p>"

​
created
string<date-time>

Timestamp when the article was originally created.

​
last_updated
string<date-time>

Timestamp when the article was last modified.

​
published
boolean

Whether the article is published and visible to users (unpublished articles are drafts).

​
get_collections
object[]

List of collections this article belongs to with their sort positions.

Example:
[
  { "collection_id": 1, "sort": 1 },
  { "collection_id": 3, "sort": 2 }
]
​
visibility
enum<string>

Visibility setting - public (visible to all), chat (only in chat widget), chat_auth (only in chat for authenticated users).

Available options:
public,
chat,
chat_auth
Maximum string length: 10
Example:

"public"

​
get_url
string

Full computed URL path to access the article, including collection hierarchy.

Example:

"https://help.piedpiper.com/getting-started/introduction"