Skip to content
Featurebase Featurebase Featurebase
Dashboard
API Reference

Changelogs

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

List all changelogs
client.changelogs.list(ChangelogListParams { id, categories, cursor, 9 more } params?, RequestOptionsoptions?): CursorPage<Changelog { id, allowedSegmentIds, availableLocales, 21 more } >
GET/v2/changelogs
Create a new changelog
client.changelogs.create(ChangelogCreateParams { title, allowedSegmentIds, categories, 7 more } params, RequestOptionsoptions?): Changelog { id, allowedSegmentIds, availableLocales, 21 more }
POST/v2/changelogs
Get a changelog by ID
client.changelogs.retrieve(stringid, ChangelogRetrieveParams { featurebaseVersion } params?, RequestOptionsoptions?): Changelog { id, allowedSegmentIds, availableLocales, 21 more }
GET/v2/changelogs/{id}
Update a changelog
client.changelogs.update(stringid, ChangelogUpdateParams { allowedSegmentIds, categories, date, 5 more } params, RequestOptionsoptions?): Changelog { id, allowedSegmentIds, availableLocales, 21 more }
PATCH/v2/changelogs/{id}
Delete a changelog
client.changelogs.delete(stringid, ChangelogDeleteParams { featurebaseVersion } params?, RequestOptionsoptions?): ChangelogDeleteResponse { id, deleted, object }
DELETE/v2/changelogs/{id}
Publish a changelog
client.changelogs.publish(stringid, ChangelogPublishParams { locales, scheduledDate, sendEmail, featurebaseVersion } params, RequestOptionsoptions?): PublishUnpublishSuccess { success, state }
POST/v2/changelogs/{id}/publish
Unpublish a changelog
client.changelogs.unpublish(stringid, ChangelogUnpublishParams { locales, featurebaseVersion } params, RequestOptionsoptions?): PublishUnpublishSuccess { success, state }
POST/v2/changelogs/{id}/unpublish
ModelsExpand Collapse
Changelog { id, allowedSegmentIds, availableLocales, 21 more }
id: string

Unique identifier

allowedSegmentIds: Array<string>

Segment IDs that are allowed to view this changelog

availableLocales: Array<string>

Array of locale codes where the changelog has content

categories: Array<Category>

Categories the changelog belongs to

id: string

Category unique identifier

name: string

Category name

roles?: Array<string>

Roles allowed to view this category

commentCount: number

Number of comments

content: string

Content in HTML format

createdAt: string

ISO 8601 timestamp when created

date: string

Publication date as ISO 8601 timestamp

emailSentToSubscribers: boolean

Whether email notification was sent to subscribers

featuredImage: string | null

Featured image URL

isDraftDiffersFromLive: boolean

Whether the draft content differs from the published live content

isPublished: boolean

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

locale: "bn" | "bs" | "pt-BR" | 39 more

Locale of the changelog

One of the following:
"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"
markdownContent: string | null

Content in markdown format

notifications: Record<string, Notifications>

Notification settings for each locale

scheduledDate: string | null

Scheduled publication date as ISO 8601 timestamp

emailSent?: boolean

Whether the email notification has been sent

hideFromBoardAndWidgets?: boolean

Whether the changelog is hidden from the board and widgets

sendEmailNotification?: boolean

Whether email notification should be sent for this locale

object: "changelog"

Object type identifier

organization: string

Organization identifier

publishedLocales: Array<string>

Array of locale codes where the changelog is published

slug: string

URL-friendly slug

slugs: Record<string, string>

URL-friendly slugs for each locale

state: "live" | "draft"

State of the changelog

One of the following:
"live"
"draft"
title: string

Changelog title

updatedAt: string

ISO 8601 timestamp when updated

url: string

Public URL to view the changelog

PublishUnpublishSuccess { success, state }
success: true

Indicates the operation was successful

state?: "published" | "scheduled" | "unpublished"

The state of the changelog after the operation

One of the following:
"published"
"scheduled"
"unpublished"
ChangelogDeleteResponse { id, deleted, object }
id: string

Unique identifier of the deleted changelog

deleted: true

Indicates the resource was deleted

object: "changelog"

Object type identifier

ChangelogsSubscribers

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

Add changelog subscribers
client.changelogs.subscribers.add(SubscriberAddParams { emails, locale, featurebaseVersion } params, RequestOptionsoptions?): SubscriberAddResponse { count, object }
POST/v2/changelogs/subscribers
Remove changelog subscribers
client.changelogs.subscribers.remove(SubscriberRemoveParams { emails, featurebaseVersion } params, RequestOptionsoptions?): SubscriberRemoveResponse { count, object }
DELETE/v2/changelogs/subscribers
ModelsExpand Collapse
SubscriberAddResponse { count, object }
count: number

Number of email addresses processed

object: "changelog_subscribers_import"

Object type identifier

SubscriberRemoveResponse { count, object }
count: number

Number of email addresses processed

object: "changelog_subscribers_removal"

Object type identifier