Skip to main content
POST
Create changelog

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string
required
Minimum string length: 1
content
string
required

Markdown body. House shape: one ## per section, a --- divider above each one that has content above it, > for a callout, and backticks for a navigation path.

Minimum string length: 1
date
string<date-time>
published
boolean
image_url
string<uri> | null
portal_instance_id
string | null

Portal instance id to assign, from GET /portal/instances. Omit to follow the group or parent the item belongs to; null targets the Main (Root) portal. A value that disagrees with the group's portal is rejected.

portal_instance_ids
string[]

Every portal the entry is on. Use "main" for the Main portal. Takes precedence over portal_instance_id.

language
string

BCP-47 language code. When set, the changelog is created with the body on a translation row and the base row stays empty. Requires the Pro plan and the language enabled in workspace settings.

tag_ids
string[]

Response

Successful response

id
string
required
created_at
string
required
updated_at
string
required
date
string | null
required
published
boolean
required
archived
boolean
required
title
string
required
slug
string | null
required
content
string
required
image_url
string | null
required
portal_instance_id
string | null
required
portal_instance_ids
string[]
required
tags
object[]
required