Update an article

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS update article API allows you to update an existing article in your knowledge base.

PUT https://api.featureos.app/api/v3/articles/:id

curl -X PUT 'https://api.featureos.app/api/v3/articles/:id' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/articles/:id', {
  method: 'PUT',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.put(
    'https://api.featureos.app/api/v3/articles/:id',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.
Authorization	-	Generate a unique JWT token specific to a user.

Body Parameters

Parameter	Required	Format	Description
title	false	String	The title of the article. Also used to update the slug.
description	false	Text	The content of the article. HTML is allowed.
collection_id	false	Integer	Move the article to a different collection.
status	false	String	The article status: `draft` or `published`.
privacy	false	String	The article privacy: `public`, `unlisted`, or `private`.
locale	false	String	Language code for the article (e.g., `en`, `es`, `fr`).
seo_title	false	String	Custom SEO title for the article.
seo_description	false	String	Custom SEO meta description.
cover_image	false	File	Cover image for the article. Accepts `jpeg`, `jpg`, `png`, or `gif`. Max 10 MB.
tag_ids	false	Array	IDs of tags to attach to the article. Replaces existing tags.
assignee_ids	false	Array	IDs of team members to assign. Replaces existing assignees.
position	false	Integer	The display position of the article within its collection.

Sample response

{
  "id": 42,
  "title": "Getting Started with SSO (Updated)",
  "slug": "getting-started-with-sso-updated",
  "status": "published",
  "key": "FO-112",
  "updated_at": "2025-01-16T12:00:00.000Z",
  "description": "<p>Updated guide for setting up Single Sign-On for your organization.</p>",
  "cover_image": null,
  "locale": "en",
  "privacy": "public",
  "imported_resource": null,
  "imported_resource_id": "0",
  "position": 1,
  "seo_title": "SSO Setup Guide",
  "seo_description": "Learn how to configure SSO for your FeatureOS organization.",
  "authors": [
      {
        "id": 1234,
        "name": "Swathy",
        "email": "[email protected]"
      }
  ],
  "assignees": [
      {
        "id": 123,
        "name": "John",
        "email": "[email protected]"
      }
  ],
  "tags": [
      {
        "name": "SSO",
        "color": "blue",
        "id": 53001
      }
  ],
  "published_at": "2025-01-16T12:00:00.000Z",
  "collection": {
      "id": 5,
      "slug": "getting-started",
      "color": "default",
      "description": "Everything you need to get started.",
      "icon": null,
      "kind": "category",
      "name": "Getting Started",
      "published_articles_count": 9,
      "published_articles_count_with_children": 0,
      "read_only": false,
      "sub_categories_count": 0,
      "created_at": "2024-05-20T05:44:33.911Z",
      "updated_at": "2025-01-16T12:00:00.000Z",
      "parent_id": null,
      "user_id": 123,
      "privacy": "public",
      "position": 1,
      "seo_title": null,
      "seo_description": null
  }
}