Delete a collection

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS delete collection API allows you to permanently remove a collection from your knowledge base. All articles within the collection must be moved or deleted before the collection can be removed.

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

curl -X DELETE '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: 'DELETE',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.delete(
    '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.

Query Parameters

Parameter	Default	Description
id	-	The ID of the collection to delete.

Sample response

{
  "success": true
}