Skip to main content

Changelog mutations

Changelog mutations require a write-enabled apikey. The ssoid and ssotype headers must identify a board owner, admin, or moderator.

mutation CreateChangelog(
$title: String!
$content: String
$status: ChangelogStatus!
$datePublished: DateTime
$properties: [ChangelogPropertyInput]
) {
createChangelog(
title: $title
content: $content
status: $status
datePublished: $datePublished
properties: $properties
) {
node { id cid title status datePublished slug properties { id parent type values } }
}
}
mutation UpdateChangelog(
$changelogId: String!
$title: String
$content: String
$status: ChangelogStatus
$datePublished: DateTime
$properties: [ChangelogPropertyInput]
$isPinned: Boolean
$isBoosted: Boolean
$boostExpiresAt: DateTime
) {
updateChangelog(
changelogId: $changelogId
title: $title
content: $content
status: $status
datePublished: $datePublished
properties: $properties
isPinned: $isPinned
isBoosted: $isBoosted
boostExpiresAt: $boostExpiresAt
) {
node { id title status datePublished isPinned isBoosted boostExpiresAt }
}
}

Use deleteChangelog(changelogId: String!) to delete an entry. Use updateChangelogProperty(fieldId:, changelogId:, values:) when updating one custom field independently.

Published entries can be announced immediately or scheduled. Omit audience to notify all engaged subscribers, or provide user-attribute option pairs to require recipients to match every selected attribute.

mutation AnnounceChangelog(
$changelogId: String!
$scheduleAt: DateTime
$audience: [ChangelogAudienceFilterInput!]
) {
announceChangelog(changelogId: $changelogId, scheduleAt: $scheduleAt, audience: $audience) {
node { id announcedAt announceScheduledAt announceAudience { fieldId optionId } }
}
}