Publish a changelog entry. Publishes an entry now, or at publish_at (ISO time in the future: it goes live then, within a minute). Then, once, subscribers are emailed (notify_subscribers, default true) and so are followers of the linked posts (notify_linked_voters, default false). If the public changelog is off when it goes live, nobody is emailed, not even after it's turned on, and the entry stays hidden until then. Republishing never emails again. Managers and owners.
Toolset
changelog
Who can call it
OwnersManagersAPI keys
REST
POST /api/v1/w/{workspace}/changelog/{entry}/publish
Behavior
changes dataidempotent
Input
Field
Type
Description
entryrequired
string
Entry ID (chg_…) or slug.
publish_at
string (date-time)
Schedule for this time (UTC ISO 8601).
notify_subscribers
boolean
Default: true.
notify_linked_voters
boolean
Default: false.
expected_version
integer
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.