Skip to content
Dashboard

Changelogs

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

List all changelogs
GET/v2/changelogs
Create a new changelog
POST/v2/changelogs
Get a changelog by ID
GET/v2/changelogs/{id}
Update a changelog
PATCH/v2/changelogs/{id}
Delete a changelog
DELETE/v2/changelogs/{id}
Publish a changelog
POST/v2/changelogs/{id}/publish
Unpublish a changelog
POST/v2/changelogs/{id}/unpublish
ModelsExpand Collapse
Changelog object { id, allowedSegmentIds, availableLocales, 21 more }
id: string

Unique identifier

allowedSegmentIds: array of string

Segment IDs that are allowed to view this changelog

availableLocales: array of string

Array of locale codes where the changelog has content

categories: array of object { id, name, roles }

Categories the changelog belongs to

id: string

Category unique identifier

name: string

Category name

roles: optional array of 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

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" or "bs" or "pt-BR" or 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

Content in markdown format

notifications: map[object { scheduledDate, emailSent, hideFromBoardAndWidgets, sendEmailNotification } ]

Notification settings for each locale

scheduledDate: string

Scheduled publication date as ISO 8601 timestamp

emailSent: optional boolean

Whether the email notification has been sent

hideFromBoardAndWidgets: optional boolean

Whether the changelog is hidden from the board and widgets

sendEmailNotification: optional boolean

Whether email notification should be sent for this locale

object: "changelog"

Object type identifier

organization: string

Organization identifier

publishedLocales: array of string

Array of locale codes where the changelog is published

slug: string

URL-friendly slug

slugs: map[string]

URL-friendly slugs for each locale

state: "live" or "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 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"
ChangelogDeleteResponse object { 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
POST/v2/changelogs/subscribers
Remove changelog subscribers
DELETE/v2/changelogs/subscribers
ModelsExpand Collapse
SubscriberAddResponse object { count, object }
count: number

Number of email addresses processed

object: "changelog_subscribers_import"

Object type identifier

SubscriberRemoveResponse object { count, object }
count: number

Number of email addresses processed

object: "changelog_subscribers_removal"

Object type identifier