Update a collection

API Versioning

This API uses date-based versioning. Each version is identified by a release date and slug, e.g., 2026-01-01.nova.

Specifying a Version

Include the version in the request header:

Featurebase-Version: 2026-01-01.nova

Or set a default version for your organization in the dashboard settings.

Version Compatibility

Newer versions may add new fields to responses (always backwards-compatible)
Breaking changes (removed/renamed fields, changed behavior) only occur in new versions
Your integration will continue to work as long as you pin to a specific version

Authentication

All API requests require authentication via API key.

Include in headers:

Authorization: Bearer <api-key>

Create and manage your API keys in the Featurebase dashboard.

Error Handling

The API uses conventional HTTP response codes to indicate success or failure:

2xx - Success
4xx - Client errors (bad request, unauthorized, not found, etc.)
5xx - Server errors (internal error)

Error Response Format

All errors follow a consistent format:

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "Post not found",
    "param": "id",
    "status": 404
  }
}

Error Types

Type	Description
`authentication_error`	Authentication failed (401)
`authorization_error`	Permission denied (403)
`invalid_request_error`	Invalid request parameters or resource not found (400, 404, 410)
`api_error`	Server-side error (500)
`rate_limit_error`	Too many requests (429)

Boards

Boards (post categories) organize feedback into distinct containers with their own settings.

Operations

Posts

User-submitted feedback and feature requests. Posts belong to boards and can be upvoted, commented on, and tracked through statuses.

Operations

Post Statuses

Post statuses define the workflow stages for posts (e.g., In Review, Active, Completed).

Operations

Comments

Threaded discussions on posts and changelogs. Comments support voting, moderation, and privacy controls.

Operations

Custom Fields

Configurable input fields for posts in your Featurebase organization. Custom fields allow you to collect additional structured data when users create posts.

Operations

Changelogs

Release notes and updates published by the organization. Changelogs keep users informed about new features, improvements, and fixes.

Operations

Admins

Team members who manage your Featurebase organization. Admins have roles that define their permissions.

Operations

Teams

Teams are groups within your Featurebase organization. Use this endpoint to list and retrieve team information for conversation assignment and organization management.

Operations

Brands

Brands represent distinct brand identities within your organization. Each brand can have its own help center and email sending address. Use this endpoint to list and retrieve brand information.

Operations

Contacts

Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.

Operations

Companies

Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.

Operations

Surveys

Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.

Operations

Help Centers

Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.

Operations

Get a collection by ID

Request

Retrieves a specific collection by its unique identifier.

Returns the collection object if found in your organization's help center.

Response

Returns a collection object with:

id - Unique identifier
name - Collection name
description - Collection description
slug - URL slug
icon - Collection icon (emoji or custom)
parentId - Parent collection ID (null for root collections)
helpCenterId - ID of the help center this collection belongs to
organization - Organization ID
defaultLocale - Default locale for content
locale - Current locale
availableLocales - Array of available locales
featurebaseUrl - Featurebase URL for the collection
externalUrl - External URL if custom domain is configured
articleCount - Number of articles in this collection
authorCount - Number of authors who contributed
order - Display order
translations - Translations for different locales
createdAt - ISO 8601 timestamp when created
updatedAt - ISO 8601 timestamp when last updated

Errors

404 - Collection not found in your organization's help center

Security

bearerAuth

Path

idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

Collection unique identifier

Example: 6474684

Headers

Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova

curl -i -X GET \
  https://docs.featurebase.app/_mock/rest-api/v2/help_center/collections/6474684 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json

objectstringrequired

Object type identifier

Value"collection"

Example: "collection"

idstringrequired

Collection unique identifier

Example: "6474684"

namestring

Collection name

Example: "English Collection Name"

descriptionstring

Collection description

Example: "A description in English"

slugstring

URL slug

Example: "6474684-english-version"

iconobject or null(CollectionIcon)

Collection icon

parentIdstring or nullrequired

Parent collection ID

Example: null

helpCenterIdstringrequired

Help center ID

Example: "j7c5g8ah3ewxp4lo"

organizationstringrequired

Organization ID

Example: "6595518396205e06b897ad65"

defaultLocalestring

Default locale

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: "en"

localestringrequired

Current locale

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: "en"

availableLocalesArray of stringsrequired

Available locales

Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: ["en","de"]

featurebaseUrlstring

Featurebase URL

Example: "https://yourorg.featurebase.app/en/help/collections/6474684-english-version"

externalUrlstring

External URL

Example: "https://help.yourdomain.com/en/collections/6474684-english-version"

articleCountnumber

Number of articles

Example: 15

authorCountnumber

Number of authors

Example: 3

ordernumber or null

Display order

Example: 1

pathstring

Collection path

Example: "ox6qrqprmsuqaunj/3876752/3513543"

collapseSidebarboolean

Whether to collapse sidebar

Example: false

translationsobject

Translations by locale code

createdAtstringrequired

ISO 8601 timestamp when created

Example: "2024-10-18T12:33:09.099Z"

updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: "2024-10-18T13:03:25.921Z"

Response

application/json

{
  "object": "collection",
  "id": "6474684",
  "name": "English Collection Name",
  "description": "A description in English",
  "slug": "6474684-english-version",
  "icon": {
    "type": "emoji",
    "value": "🥾"
  },
  "parentId": null,
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organization": "6595518396205e06b897ad65",
  "defaultLocale": "en",
  "locale": "en",
  "availableLocales": [
    "en",
    "de"
  ],
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version",
  "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version",
  "articleCount": 15,
  "authorCount": 3,
  "order": 1,
  "path": "ox6qrqprmsuqaunj/3876752/3513543",
  "collapseSidebar": false,
  "translations": {
    "bn": { … },
    "bs": { … },
    "pt-BR": { … },
    "bg": { … },
    "ca": { … },
    "hr": { … },
    "cs": { … },
    "da": { … },
    "nl": { … },
    "en": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "de": { … },
    "el": { … },
    "hi": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lv": { … },
    "lt": { … },
    "ms": { … },
    "mn": { … },
    "nb": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sr": { … },
    "zh-CN": { … },
    "sk": { … },
    "sl": { … },
    "es": { … },
    "sw": { … },
    "sv": { … },
    "th": { … },
    "zh-TW": { … },
    "tr": { … },
    "uk": { … },
    "vi": { … }
  },
  "createdAt": "2024-10-18T12:33:09.099Z",
  "updatedAt": "2024-10-18T13:03:25.921Z"
}

Update a collection

Request

Updates an existing collection. Only include the fields you wish to update.

Path Parameters

id - The unique identifier of the collection to update

Request Body

All fields are optional. Only provided fields will be updated:

name - The new name of the collection
description - The new description of the collection
icon - An updated icon object for the collection (with type and value)
parentId - The new parent collection ID, if applicable (null for root level)
translations - A dictionary of updated translations keyed by locale code

Response

Returns the updated collection object with:

id - Unique identifier
name - Collection name
description - Collection description
slug - URL slug
icon - Collection icon (emoji or custom)
parentId - Parent collection ID (null for root collections)
helpCenterId - ID of the help center this collection belongs to
organization - Organization ID
defaultLocale - Default locale for content
locale - Current locale
availableLocales - Array of available locales
featurebaseUrl - Featurebase URL for the collection
externalUrl - External URL if custom domain is configured
articleCount - Number of articles in this collection
authorCount - Number of authors who contributed
order - Display order
translations - Translations for different locales
createdAt - ISO 8601 timestamp when created
updatedAt - ISO 8601 timestamp when last updated

Errors

404 - Collection not found in your organization's help center

Security

bearerAuth

Path

idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

The collection unique identifier

Example: 3416135

Headers

Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova

Bodyapplication/json

namestring<= 255 characters

The new name of the collection

Example: "Updated Collection"

descriptionstring<= 512 characters

The new description of the collection

Example: "Updated description in English."

iconobject or null(CollectionIcon_Nova)

An updated icon object for the collection

parentIdstring or null[ 1 .. 16 ] characters^[a-zA-Z0-9]+$

The new parent collection ID, if applicable

Example: null

translationsobject

A dictionary of updated translations keyed by locale

curl -i -X PATCH \
  https://docs.featurebase.app/_mock/rest-api/v2/help_center/collections/3416135 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "name": "Updated Collection",
    "description": "Updated description in English.",
    "icon": {
      "type": "emoji",
      "value": "📝"
    },
    "parentId": null,
    "translations": {
      "bn": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "bs": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "pt-BR": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "bg": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ca": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "hr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "cs": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "da": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "nl": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "en": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "et": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "fi": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "fr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "de": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "el": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "hi": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "hu": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "id": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "it": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ja": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ko": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "lv": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "lt": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ms": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "mn": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "nb": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "pl": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "pt": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ro": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "ru": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "zh-CN": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sk": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sl": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "es": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sw": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "sv": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "th": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "zh-TW": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "tr": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "uk": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      },
      "vi": {
        "name": "German Collection",
        "description": "This is a collection of articles in German."
      }
    }
  }'

Responses

Success

Bodyapplication/json

objectstringrequired

Object type identifier

Value"collection"

Example: "collection"

idstringrequired

Collection unique identifier

Example: "6474684"

namestring

Collection name

Example: "English Collection Name"

descriptionstring

Collection description

Example: "A description in English"

slugstring

URL slug

Example: "6474684-english-version"

iconobject or null(CollectionIcon)

Collection icon

parentIdstring or nullrequired

Parent collection ID

Example: null

helpCenterIdstringrequired

Help center ID

Example: "j7c5g8ah3ewxp4lo"

organizationstringrequired

Organization ID

Example: "6595518396205e06b897ad65"

defaultLocalestring

Default locale

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: "en"

localestringrequired

Current locale

Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: "en"

availableLocalesArray of stringsrequired

Available locales

Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"

Example: ["en","de"]

featurebaseUrlstring

Featurebase URL

Example: "https://yourorg.featurebase.app/en/help/collections/6474684-english-version"

externalUrlstring

External URL

Example: "https://help.yourdomain.com/en/collections/6474684-english-version"

articleCountnumber

Number of articles

Example: 15

authorCountnumber

Number of authors

Example: 3

ordernumber or null

Display order

Example: 1

pathstring

Collection path

Example: "ox6qrqprmsuqaunj/3876752/3513543"

collapseSidebarboolean

Whether to collapse sidebar

Example: false

translationsobject

Translations by locale code

createdAtstringrequired

ISO 8601 timestamp when created

Example: "2024-10-18T12:33:09.099Z"

updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: "2024-10-18T13:03:25.921Z"

Response

application/json

{
  "object": "collection",
  "id": "6474684",
  "name": "English Collection Name",
  "description": "A description in English",
  "slug": "6474684-english-version",
  "icon": {
    "type": "emoji",
    "value": "🥾"
  },
  "parentId": null,
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "organization": "6595518396205e06b897ad65",
  "defaultLocale": "en",
  "locale": "en",
  "availableLocales": [
    "en",
    "de"
  ],
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version",
  "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version",
  "articleCount": 15,
  "authorCount": 3,
  "order": 1,
  "path": "ox6qrqprmsuqaunj/3876752/3513543",
  "collapseSidebar": false,
  "translations": {
    "bn": { … },
    "bs": { … },
    "pt-BR": { … },
    "bg": { … },
    "ca": { … },
    "hr": { … },
    "cs": { … },
    "da": { … },
    "nl": { … },
    "en": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "de": { … },
    "el": { … },
    "hi": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lv": { … },
    "lt": { … },
    "ms": { … },
    "mn": { … },
    "nb": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sr": { … },
    "zh-CN": { … },
    "sk": { … },
    "sl": { … },
    "es": { … },
    "sw": { … },
    "sv": { … },
    "th": { … },
    "zh-TW": { … },
    "tr": { … },
    "uk": { … },
    "vi": { … }
  },
  "createdAt": "2024-10-18T12:33:09.099Z",
  "updatedAt": "2024-10-18T13:03:25.921Z"
}

Delete a collection

Request

Deletes an existing collection.

Path Parameters

id - The unique identifier of the collection to delete

Response

Returns a deletion confirmation object:

id - The ID of the deleted collection
object - Always "collection"
deleted - Always true

Errors

404 - Collection not found in your organization's help center

Security

bearerAuth

Path

idstring[ 1 .. 16 ] characters^[a-zA-Z0-9]+$required

The collection unique identifier

Example: 3416135

Headers

Featurebase-Versionstring(FeaturebaseVersion)

API version for this request. Defaults to your organization's configured API version if not specified.

Example: 2026-01-01.nova

curl -i -X DELETE \
  https://docs.featurebase.app/_mock/rest-api/v2/help_center/collections/3416135 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json

idstringrequired

Unique identifier of the deleted collection

Example: "3416135"

objectstringrequired

Object type identifier

Value"collection"

Example: "collection"

deletedbooleanrequired

Indicates the resource was deleted

Valuetrue

Example: true

Response

application/json

{
  "id": "3416135",
  "object": "collection",
  "deleted": true
}

Conversations

Conversations are messenger/inbox conversations in your Featurebase organization. Use this endpoint to list and retrieve conversation information.

Operations

Webhooks

Webhooks allow you to receive real-time HTTP callbacks when events occur in your Featurebase organization. Configure webhook endpoints to subscribe to specific event types.

Operations

Featurebase API (2026-01-01.nova)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

API Versioning

Authentication

Error Handling

Boards

Posts

Post Statuses

Comments

Custom Fields

Changelogs

Admins

Teams

Brands

Contacts

Companies

Surveys

Help Centers

Get a collection by ID

Request

Response

Errors

Responses

Was this helpful?

Update a collection

Request

Path Parameters

Request Body

Response

Errors

Responses

Was this helpful?

Delete a collection

Request

Path Parameters

Response

Errors

Responses

Was this helpful?

Conversations

Webhooks

Featurebase API (2026-01-01.nova)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

API Versioning

Authentication

Error Handling

Boards

Posts

Post Statuses

Comments

Custom Fields

Changelogs

Admins

Teams

Brands

Contacts

Companies

Surveys

Help Centers

Get a collection by ID

Request

Response

Errors

Responses

Was this helpful?

Update a collection

RequestExpand all

Path Parameters

Request Body

Response

Errors

Responses

Was this helpful?

Delete a collection

Request

Path Parameters

Response

Errors

Responses

Was this helpful?

Conversations

Webhooks

Featurebase API (2026-01-01.nova)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request