Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference
Changelogs

Publish a changelog

POST/v2/changelogs/{id}/publish

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
Path ParametersExpand Collapse
id: string

Changelog unique identifier

Header ParametersExpand Collapse
"Featurebase-Version": optional "2026-08-19.orbit" or "2026-01-01.nova" or "2025-12-12.clover"
One of the following:
"2026-08-19.orbit"
"2026-01-01.nova"
"2025-12-12.clover"
Body ParametersJSONExpand Collapse
locales: optional array of "ar" or "am" or "fa" or 68 more

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

One of the following:
"ar"
"am"
"fa"
"ht"
"lo"
"my"
"pa"
"ps"
"so"
"tl"
"ur"
"he"
"ta"
"te"
"mr"
"gu"
"kn"
"ml"
"ha"
"jv"
"yo"
"ig"
"uz"
"ne"
"sd"
"az"
"si"
"km"
"kk"
"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"
scheduledDate: optional string

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

sendEmail: optional boolean

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

ReturnsExpand Collapse
PublishUnpublishSuccess object { success, state }
success: true

Indicates the operation was successful

state: optional "published" or "scheduled" or "unpublished"

The state of the changelog after the operation

One of the following:
"published"
"scheduled"
"unpublished"

Publish a changelog

curl https://do.featurebase.app/v2/changelogs/$ID/publish \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY" \
    -d '{
          "locales": [
            "en",
            "de"
          ],
          "scheduledDate": "2023-12-01T00:00:00Z",
          "sendEmail": true
        }'
{
  "success": true,
  "state": "published"
}
Returns Examples
{
  "success": true,
  "state": "published"
}