Skip to content
REST API
/
/
Update a changelog

Featurebase API (2026-01-01.nova)

Welcome to the Featurebase API. This API allows you to programmatically interact with your Featurebase organization.

This documentation reflects API version 2026-01-01.nova.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://featurebase.app
License
Proprietary
Languages
Servers
Mock server
https://docs.featurebase.app/_mock/rest-api/
Production
https://do.featurebase.app/

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

TypeDescription
authentication_errorAuthentication failed (401)
authorization_errorPermission denied (403)
invalid_request_errorInvalid request parameters or resource not found (400, 404, 410)
api_errorServer-side error (500)
rate_limit_errorToo 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

Get a changelog by ID

Request

Retrieves a single changelog by its unique identifier or slug.

Returns the full changelog object including:

  • Title and content (in HTML and markdown formats)
  • Featured image
  • Publication date
  • Categories
  • Comment count
  • Email notification status

Localization

The changelog content is returned in the organization's default locale. If the changelog doesn't exist in the default locale, the first available locale is used.

State

Both published (live) and draft changelogs can be retrieved. The state field indicates the current publication status.

Security
bearerAuth
Path
idstringrequired

Changelog unique identifier

Example: 507f1f77bcf86cd799439011
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/changelogs/507f1f77bcf86cd799439011 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"changelog"
Example: "changelog"
idstringrequired

Unique identifier

Example: "6457e3ff70afca5d8c27dccc"
titlestringrequired

Changelog title

Example: "Your awesome changelog!"
slugstringrequired

URL-friendly slug

Example: "your-awesome-changelog"
urlstringrequired

Public URL to view the changelog

Example: "https://myorg.featurebase.app/en/changelog/your-awesome-changelog"
contentstringrequired

Content in HTML format

Example: "<p>Your changelog content in HTML format.</p>"
markdownContentstring or nullrequired

Content in markdown format

Example: "Your changelog content in markdown format."
featuredImagestring or nullrequired

Featured image URL

Example: "https://cdn.example.com/images/feature.png"
datestringrequired

Publication date as ISO 8601 timestamp

Example: "2023-05-07T12:59:59.000Z"
statestringrequired

State of the changelog

Enum"live""draft"
Example: "live"
localestringrequired

Locale of the changelog

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

Whether the changelog is published (has a live version) in this locale

Example: true
isDraftDiffersFromLivebooleanrequired

Whether the draft content differs from the published live content

Example: false
publishedLocalesArray of stringsrequired

Array of locale codes where the changelog is published

Example: ["en","de"]
availableLocalesArray of stringsrequired

Array of locale codes where the changelog has content

Example: ["en","de","fr"]
slugsobjectrequired

URL-friendly slugs for each locale

Example: {"en":"your-awesome-changelog","de":"dein-tolles-changelog"}
slugs.​property name*stringadditional property
commentCountnumberrequired

Number of comments

Example: 2
categoriesArray of objects(ChangelogCategory)required

Categories the changelog belongs to

categories[].​idstringrequired

Category unique identifier

Example: "6438a1efda3640f8feb72121"
categories[].​namestringrequired

Category name

Example: "New Features"
categories[].​rolesArray of strings

Roles allowed to view this category

Example: []
organizationstringrequired

Organization identifier

Example: "myorg"
notificationsobjectrequired

Notification settings for each locale

notifications.​property name*object(ChangelogLocaleNotification)additional property
allowedSegmentIdsArray of stringsrequired

Segment IDs that are allowed to view this changelog

Example: []
emailSentToSubscribersbooleanrequired

Whether email notification was sent to subscribers

Example: true
createdAtstringrequired

ISO 8601 timestamp when created

Example: "2023-12-12T00:00:00.000Z"
updatedAtstringrequired

ISO 8601 timestamp when updated

Example: "2023-12-13T00:00:00.000Z"
Response
application/json
{
  "object": "changelog",
  "id": "6457e3ff70afca5d8c27dccc",
  "title": "Your awesome changelog!",
  "slug": "your-awesome-changelog",
  "url": "https://myorg.featurebase.app/en/changelog/your-awesome-changelog",
  "content": "<p>Your changelog content in HTML format.</p>",
  "markdownContent": "Your changelog content in markdown format.",
  "featuredImage": "https://cdn.example.com/images/feature.png",
  "date": "2023-05-07T12:59:59.000Z",
  "state": "live",
  "locale": "en",
  "isPublished": true,
  "isDraftDiffersFromLive": false,
  "publishedLocales": [
    "en",
    "de"
  ],
  "availableLocales": [
    "en",
    "de",
    "fr"
  ],
  "slugs": {
    "en": "your-awesome-changelog",
    "de": "dein-tolles-changelog"
  },
  "commentCount": 2,
  "categories": [
    { … }
  ],
  "organization": "myorg",
  "notifications": {
    "property1": { … },
    "property2": { … }
  },
  "allowedSegmentIds": [],
  "emailSentToSubscribers": true,
  "createdAt": "2023-12-12T00:00:00.000Z",
  "updatedAt": "2023-12-13T00:00:00.000Z"
}

Update a changelog

Request

Updates an existing changelog by its unique identifier.

You can update:

  • title - The changelog title
  • htmlContent - HTML content (one of htmlContent or markdownContent)
  • markdownContent - Markdown content (one of htmlContent or markdownContent)
  • categories - Array of category names
  • featuredImage - Featured image URL
  • allowedSegmentIds - Segment IDs for access control
  • date - The date of the changelog

Content Format

Provide content in one of two formats:

  • htmlContent - HTML content of the changelog
  • markdownContent - Markdown content of the changelog

Note: For images in content, you can use:

  • External URLs in img src attributes (automatically uploaded to our storage)
  • Base64 encoded data URIs (data:image/...) which are processed and stored

Categories

Provide category names as an array. The categories must already exist in your organization.

Example: ["New", "Fixed", "Improved"]

Response

Returns the updated changelog object with all fields populated.

Errors

  • 400 - Invalid changelog ID format or invalid input
  • 404 - Changelog not found or doesn't belong to your organization
Security
bearerAuth
Path
idstringrequired

Changelog unique identifier

Example: 507f1f77bcf86cd799439011
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
titlestring[ 1 .. 512 ] characters

The title of the changelog

Example: "Updated Features Release"
htmlContentstring

The HTML content of the changelog. Provide either htmlContent or markdownContent. For images, external URLs and base64 data URIs are automatically processed and stored.

Example: "<p>Updated features to explore.</p>"
markdownContentstring

The markdown content of the changelog. Provide either htmlContent or markdownContent. For images, external URLs and base64 data URIs are automatically processed and stored.

Example: "Updated features to explore."
categoriesArray of strings<= 100 items

An array of category names to which the changelog belongs

Example: ["New","Fixed","Improved"]
featuredImagestring

The URL of the featured image for the changelog. External URLs will be uploaded to our storage.

Example: "https://example.com/image.png"
allowedSegmentIdsArray of strings<= 100 items

An array of segment IDs that are allowed to view the changelog

Example: ["507f1f77bcf86cd799439011"]
datestring or null

The date of the changelog

Example: "2024-01-15"
curl -i -X PATCH \
  https://docs.featurebase.app/_mock/rest-api/v2/changelogs/507f1f77bcf86cd799439011 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "title": "Updated Features Release",
    "htmlContent": "<p>Updated features to explore.</p>",
    "markdownContent": "Updated features to explore.",
    "categories": [
      "New",
      "Fixed",
      "Improved"
    ],
    "featuredImage": "https://example.com/image.png",
    "allowedSegmentIds": [
      "507f1f77bcf86cd799439011"
    ],
    "date": "2024-01-15"
  }'

Responses

Success

Bodyapplication/json
objectstringrequired

Object type identifier

Value"changelog"
Example: "changelog"
idstringrequired

Unique identifier

Example: "6457e3ff70afca5d8c27dccc"
titlestringrequired

Changelog title

Example: "Your awesome changelog!"
slugstringrequired

URL-friendly slug

Example: "your-awesome-changelog"
urlstringrequired

Public URL to view the changelog

Example: "https://myorg.featurebase.app/en/changelog/your-awesome-changelog"
contentstringrequired

Content in HTML format

Example: "<p>Your changelog content in HTML format.</p>"
markdownContentstring or nullrequired

Content in markdown format

Example: "Your changelog content in markdown format."
featuredImagestring or nullrequired

Featured image URL

Example: "https://cdn.example.com/images/feature.png"
datestringrequired

Publication date as ISO 8601 timestamp

Example: "2023-05-07T12:59:59.000Z"
statestringrequired

State of the changelog

Enum"live""draft"
Example: "live"
localestringrequired

Locale of the changelog

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

Whether the changelog is published (has a live version) in this locale

Example: true
isDraftDiffersFromLivebooleanrequired

Whether the draft content differs from the published live content

Example: false
publishedLocalesArray of stringsrequired

Array of locale codes where the changelog is published

Example: ["en","de"]
availableLocalesArray of stringsrequired

Array of locale codes where the changelog has content

Example: ["en","de","fr"]
slugsobjectrequired

URL-friendly slugs for each locale

Example: {"en":"your-awesome-changelog","de":"dein-tolles-changelog"}
slugs.​property name*stringadditional property
commentCountnumberrequired

Number of comments

Example: 2
categoriesArray of objects(ChangelogCategory)required

Categories the changelog belongs to

categories[].​idstringrequired

Category unique identifier

Example: "6438a1efda3640f8feb72121"
categories[].​namestringrequired

Category name

Example: "New Features"
categories[].​rolesArray of strings

Roles allowed to view this category

Example: []
organizationstringrequired

Organization identifier

Example: "myorg"
notificationsobjectrequired

Notification settings for each locale

notifications.​property name*object(ChangelogLocaleNotification)additional property
allowedSegmentIdsArray of stringsrequired

Segment IDs that are allowed to view this changelog

Example: []
emailSentToSubscribersbooleanrequired

Whether email notification was sent to subscribers

Example: true
createdAtstringrequired

ISO 8601 timestamp when created

Example: "2023-12-12T00:00:00.000Z"
updatedAtstringrequired

ISO 8601 timestamp when updated

Example: "2023-12-13T00:00:00.000Z"
Response
application/json
{
  "object": "changelog",
  "id": "6457e3ff70afca5d8c27dccc",
  "title": "Your awesome changelog!",
  "slug": "your-awesome-changelog",
  "url": "https://myorg.featurebase.app/en/changelog/your-awesome-changelog",
  "content": "<p>Your changelog content in HTML format.</p>",
  "markdownContent": "Your changelog content in markdown format.",
  "featuredImage": "https://cdn.example.com/images/feature.png",
  "date": "2023-05-07T12:59:59.000Z",
  "state": "live",
  "locale": "en",
  "isPublished": true,
  "isDraftDiffersFromLive": false,
  "publishedLocales": [
    "en",
    "de"
  ],
  "availableLocales": [
    "en",
    "de",
    "fr"
  ],
  "slugs": {
    "en": "your-awesome-changelog",
    "de": "dein-tolles-changelog"
  },
  "commentCount": 2,
  "categories": [
    { … }
  ],
  "organization": "myorg",
  "notifications": {
    "property1": { … },
    "property2": { … }
  },
  "allowedSegmentIds": [],
  "emailSentToSubscribers": true,
  "createdAt": "2023-12-12T00:00:00.000Z",
  "updatedAt": "2023-12-13T00:00:00.000Z"
}

Delete a changelog

Request

Deletes a changelog by its unique identifier.

Deletion Behavior

The changelog and all associated comments are permanently deleted. This action cannot be undone.

Permissions

Only organization admins can delete changelogs.

Response

Returns a deletion confirmation:

{
  "id": "6457e3ff70afca5d8c27dccc",
  "object": "changelog",
  "deleted": true
}

Errors

  • 400 - Invalid changelog ID format
  • 404 - Changelog not found or doesn't belong to your organization
Security
bearerAuth
Path
idstringrequired

Changelog unique identifier

Example: 507f1f77bcf86cd799439011
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/changelogs/507f1f77bcf86cd799439011 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Featurebase-Version: 2026-01-01.nova'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the deleted changelog

Example: "507f1f77bcf86cd799439011"
objectstringrequired

Object type identifier

Value"changelog"
Example: "changelog"
deletedbooleanrequired

Indicates the resource was deleted

Valuetrue
Example: true
Response
application/json
{
  "id": "507f1f77bcf86cd799439011",
  "object": "changelog",
  "deleted": true
}

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

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

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