Get HelpCenter Change Set Status
helpcenter_get_change_set_statusCheck on a change set's release — the poll after helpcenter_publish_change_set.
A change set is a named release. It groups work that already exists — staged edits on published articles, never-published draft articles, and category visibility changes — and publishes all of it together, now or at a scheduled time. It owns no content: removing an item or deleting the set never deletes the work, which simply stays unreleased.
Use one when several articles have to go live at the same moment — a feature launch, a restructure, a coordinated translation. For one article, helpcenter_publish_staged_changes (or publishing a draft with helpcenter_update_article) is simpler. The flow: stage edits with helpcenter_stage_article_changes, or write drafts with helpcenter_create_article and published: false -> helpcenter_create_change_set -> helpcenter_add_change_set_items -> check readiness with helpcenter_get_change_set -> helpcenter_publish_change_set -> poll helpcenter_get_change_set_status until done.
Change sets are part of the Catalyst plan, behind the same gate as staged changes; on other plans the API answers 402.
Read-only. Loop on 'done', not on the status name: done is true once nothing more will happen without you (published, partially published, failed, or open and unscheduled) and false while it is publishing or waiting for its scheduled time. Wait a few seconds between polls — these calls count against the API's per-minute write budget.
When it finishes as 'partially_published' or 'failed', each item's 'error' says what went wrong. Fix that, then publish the set again.
Args:
change_set_id (number, required).
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { status: "success", change_set_status, done, processed_items, total_items, published_at, items: [{ id, type, article_id, locale, variant, applied, error }] }.
Errors: 404 if the change set is not in this help center.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"change_set_id": "<change_set_id>"
},
"name": "helpcenter_get_change_set_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | No | Which help center to act on: an id from helpcenter_list_sites. Needed when this connection reaches more than one help center; omit it when it reaches one. Applies to this call only — pass it on every call of a task, and ask the user which help center they mean if their request does not say. | |
| change_set_id | Yes | Id of the change set. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |