Remove Item From HelpCenter Change Set
helpcenter_remove_change_set_itemTake one item out of a change set. The work it pointed at — the staged edit, the draft, the category — is untouched and simply stops being part of this release.
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.
This is how to ship a release without one of its parts: a blocked item, a language that is not ready, a draft that should wait.
Requires a write-scoped API key. The set must be open.
Args:
change_set_id (number, required).
item_id (number, required): the ITEM id from helpcenter_get_change_set — not the article or category id.
Returns: { status: "success", change_set: {...} } with the remaining items.
Errors: 403 if the key is read-scoped; 404 if the item is not in this change set, or the set is not in this help center; 409 CHANGE_SET_NOT_OPEN once it is publishing or published.
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>",
"item_id": "<item_id>"
},
"name": "helpcenter_remove_change_set_item"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| item_id | Yes | Id of the ITEM (from helpcenter_get_change_set's items), not the article or category id. | |
| 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. |