Skip to main content
POST
Publish release

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Release ID

Body

application/json
status
enum<string>
default:RELEASED

RELEASED publishes the release immediately. SCHEDULED publishes it automatically at scheduled_at.

Available options:
RELEASED,
SCHEDULED
scheduled_at
string<date-time>

When to publish the release. Required when status is SCHEDULED, must be a future date, and requires a plan that includes scheduled releases.

Example:

"2026-08-01T09:00:00.000Z"

Response

Release published successfully

id
string

Unique release identifier

title
string

Release title

body
string

Release description/body content (HTML formatted)

slug
string

URL-friendly release identifier

status
enum<string>

Current release status

Available options:
DRAFT,
RELEASED
version
string | null

Release version

is_pinned
boolean

Whether release is pinned

is_public
boolean

Whether release is publicly visible

is_pre_release
boolean

Whether this is a pre-release

summary
string | null

AI generated summary of the release

hero
null | object

Hero image/video for the release

changes
object[]

List of changes in this release

project
object
labels
object[]
attachments
object[]
contributors
object[]

List of contributors to this release

released_at
string<date-time> | null

When the release was released

created_at
string<date-time>

When the release was created

updated_at
string<date-time>

When the release was last updated