Skip to content
REST API
/
/
Publish 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

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
}

Publish a changelog

Request

Publishes a changelog and optionally sends an email notification to subscribers.

Optional Fields

  • sendEmail - Whether to send an email notification to subscribers (default: false)
  • locales - Array of locales to publish. An empty array publishes to all available locales
  • scheduledDate - A future date/time when the changelog should be published

Scheduling

If scheduledDate is provided:

  • Must be a future date
  • The changelog will be scheduled for publishing at that time
  • Any existing scheduled publish for the same locales will be cancelled and replaced

Email Notifications

If sendEmail is true:

  • Email notifications are sent to all subscribers in the published locales
  • Emails are only sent once per locale (won't resend on republish)

Response

Returns a success confirmation:

{
  "success": true,
  "state": "published"
}

Or for scheduled publishes:

{
  "success": true,
  "state": "scheduled"
}

Errors

  • 400 - Invalid changelog ID or scheduled date is not in the future
  • 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
sendEmailboolean or null

A flag indicating whether to send an email notification to subscribers.

Default false
Example: true
localesArray of strings

An array of locales to publish the changelog to. An empty array publishes to all locales.

Default []
Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: ["en","de"]
scheduledDatestring or null

The date when the changelog should be published. Must be a future date. Pass null or omit to publish immediately.

Example: "2023-12-01T00:00:00Z"
Any of:

The date when the changelog should be published. Must be a future date. Pass null or omit to publish immediately.

string
curl -i -X POST \
  https://docs.featurebase.app/_mock/rest-api/v2/changelogs/507f1f77bcf86cd799439011/publish \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "sendEmail": true,
    "locales": [
      "en",
      "de"
    ],
    "scheduledDate": "2023-12-01T00:00:00Z"
  }'

Responses

Success

Bodyapplication/json
successbooleanrequired

Indicates the operation was successful

Valuetrue
Example: true
statestring

The state of the changelog after the operation

Enum"published""scheduled""unpublished"
Example: "published"
Response
application/json
{
  "success": true,
  "state": "published"
}

Unpublish a changelog

Request

Unpublishes a changelog, removing it from public view.

Optional Fields

  • locales - Array of locales to unpublish from. An empty array unpublishes from all locales

Behavior

  • The changelog content is preserved (reverts to draft state)
  • Any scheduled publishes for the specified locales are cancelled
  • The changelog can be re-published later

Response

Returns a success confirmation:

{
  "success": true,
  "state": "unpublished"
}

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
Bodyapplication/json
localesArray of strings

An array of locales to unpublish the changelog from. An empty array unpublishes from all locales.

Default []
Items Enum"bn""bs""pt-BR""bg""ca""hr""cs""da""nl""en"
Example: ["en"]
curl -i -X POST \
  https://docs.featurebase.app/_mock/rest-api/v2/changelogs/507f1f77bcf86cd799439011/unpublish \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Featurebase-Version: 2026-01-01.nova' \
  -d '{
    "locales": [
      "en"
    ]
  }'

Responses

Success

Bodyapplication/json
successbooleanrequired

Indicates the operation was successful

Valuetrue
Example: true
statestring

The state of the changelog after the operation

Enum"published""scheduled""unpublished"
Example: "published"
Response
application/json
{
  "success": true,
  "state": "published"
}

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

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