Update a collection

Understanding how to use FeatureOS API to build custom integrations.

Introduction

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

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

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

const response = await fetch('https://api.featureos.app/api/v3/collections/: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/collections/: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
name	false	String	The name of the collection.
description	false	Text	A description of the collection.
privacy	false	String	The collection privacy: `public` or `private`.
parent_id	false	Integer	The ID of a parent collection. Set to `null` to make it a top-level collection.
icon	false	String	URL to a custom icon for the collection.
position	false	Integer	Display position of the collection.

Sample response

{
  "id": 25,
  "slug": "integrations",
  "color": "default",
  "description": "Connect FeatureOS with your favorite tools and services.",
  "icon": null,
  "kind": "category",
  "name": "Integrations",
  "published_articles_count": 3,
  "published_articles_count_with_children": 0,
  "read_only": false,
  "sub_categories_count": 0,
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-16T14:00:00.000Z",
  "parent_id": null,
  "user_id": 123,
  "privacy": "public",
  "position": 11,
  "seo_title": null,
  "seo_description": null
}