Save a changelog entry. Creates a draft changelog entry (no id) or edits one (id). Body is Markdown, images by URL. labels are label names; linked_posts are post IDs or slugs, which then show "Shipped in …". Saving never publishes or emails; use publish_changelog_entry. Contributors edit drafts; managers edit any entry.
Toolset
changelog
Who can call it
OwnersManagersContributorsAPI keys
REST
PUT /api/v1/w/{workspace}/changelog
Behavior
changes dataaccepts idempotency_key
Input
Field
Type
Description
id
string
Entry ID (chg_…) or slug.
title
string
body
string
labels
array of string
linked_posts
array of string
expected_version
integer
idempotency_key
string
Retry-safe key. Repeating a call with the same key returns the first result.
Output
Field
Type
Description
idrequired
string
ID with prefix "chg_"
slugrequired
string
titlerequired
string
labelsrequired
array of object
staterequired
one of: draft, scheduled, published, unpublished
draft, scheduled (goes live at publish_at), published or unpublished. A scheduled entry whose time has come reads as published.
publish_atrequired
string (date-time) or null
published_atrequired
string (date-time) or null
When it went live.
linked_post_countrequired
integer
urlrequired
string
Its page on the portal (live entries) or in the admin (others).
versionrequired
integer
updated_atrequired
string (date-time)
bodyrequired
string
Markdown.
linked_postsrequired
array of object
notify_subscribersrequired
boolean
Email subscribers when it first goes live. False if the emails went to nobody.
notify_linked_votersrequired
boolean
Email followers of the linked posts when it first goes live. False if the emails went to nobody.
emailedrequired
boolean
Whether publication emails went to anyone. They go out once, ever, when it first goes live, and only if the public changelog is on then.