HelpDocs

List archived articles. They are deliberately absent from list_articles and from search, so this is the only way to find one without already knowing its ID. Only articles the caller could have archived are shown.

list_archived_articles

List and filter articles in the knowledge base. Returns one page at a time: when the response carries next_cursor, pass it back as the cursor argument (with every other argument unchanged) to fetch the following page, and keep going until next_cursor is absent. A page can come back with fewer articles than the limit — or none at all — while has_more is still true, because articles the caller cannot see are removed after the page is read; that is not the end of the list, so keep paging until next_cursor is gone.

list_articles

List all categories in the knowledge base. Read-only. Use it to find a category_id for the article and category tools.

list_categories

List soft-deleted articles that can still be restored with restore_article. Only articles the caller could have deleted are shown.

list_deleted_articles

List permission groups (user groups) on this account. Returns {user_groups: [{permission_group_id, group_id, name, user_is_member, user_read_only_member}], can_assign_any}. Pass the permission_group_id value (already in the required "group:<id>" form) directly to the permission_groups parameter of create_article, update_article, create_category, or update_category. When can_assign_any is true (caller has settings:edit) any group can be assigned. When false, only groups where user_is_member=true will be accepted; user_read_only_member=true means the caller can view content restricted to that group but cannot assign it, so those are still rejected on write.

list_permission_groups

List the help center's redirect rules in match order. The first rule that matches wins, and rules only run for a path that would otherwise be a 404. Each rule has a redirect_id, from, to and status_code (301 permanent, 302 temporary).

list_redirects

Publish an article's unpublished working copy, so the help center serves those pending edits instead of what it serves now, exactly as the Publish button in the editor does. Nothing else about the article changes. This is how a change written with update_article(working_copy: true) goes live, and it publishes the working copy AS IT STANDS, so read it with fetch(working_copy: true) first if you did not write it yourself. Fails if the article has no working copy in the language being published. Each language is published separately: publishing one leaves working copies in every other language untouched.

publish_working_copy

Set the match order of the redirect rules. The first rule that matches wins, so order matters when rules overlap (a wildcard before a specific path hides the specific one). Pass EVERY redirect_id from list_redirects, in the new order: a list that is missing a rule, has one twice, or names one that no longer exists is refused and nothing moves, so call list_redirects again and retry.

reorder_redirects

Restore an article that was deleted. Deletes are soft, so anything deleted (whether by this agent or by someone in the editor) can be brought back until it is purged. Use list_deleted_articles to find the ID if you do not already have it.

restore_article

Search for articles in the knowledge base using typeahead-style search. Short, specific queries work best (1-3 words). Use exact phrases rather than full questions. Each result carries a status field, so a result can be told apart from a published one at a glance.

search

Bring an archived article back as a DRAFT, in the category it was archived from. It does not return to the status it had before archiving, so an article that was published is not republished by this: publish it with update_article if it should go back on the help center.

unarchive_article

Update an existing article. Only the fields you send are changed. Edits to a PUBLISHED article go live immediately: pass working_copy: true to save them as an unpublished working copy instead, which is what a human usually means by "draft this". Returns the article's identity, placement and state (id, title, slug, url, status, category, tags, version) — not its body. Call fetch if you need the stored content back. Full field reference: https://apidocs.helpdocs.io/article/sc5pREDFNn-updating-an-article

update_article

Update an existing category: rename it, change its slug or description, or move it under another parent. Only the fields you send are changed, and the change is live on the help center immediately. Changing the slug changes the category's public URL.

update_category

Change one redirect rule. Only the fields you send change; the rest are left as they are. Takes effect immediately.

update_redirect