Publishing and syncing copies of articles in Help Center with the API

Out of the box, Help Center doesn't support publishing one article in multiple locations.

Using the Help Center API, however, you or a technically minded colleague can build a small application that publishes copies of any article in one or more specified locations in your Help Center, or in any branded Help Center in your Guide Professional plan. Such an application could also periodically update the copies with the latest versions of the source article.

You can use the following Help Center API endpoints to publish and sync copies of articles.

To make a copy of an article in another Help Center location

1. Make a GET request to get the source article's data:

   GET /api/v2/help_center/{locale}/articles/{article_id}.json
   

   See Show Article in the developer docs.

2. Make a POST request to create a copy using the data from the GET request:

   POST /api/v2/help_center/{locale}/sections/{section_id}/articles.json
   

   See Create Article.

To sync the content of a source article with one of its copies

1. Make a GET request to get the current content of the source article:

   GET /api/v2/help_center/articles/{article_id}/translations/{locale}.json
   

   See Show Translation in the developer docs.

2. Make a PUT request to update the article copy using the data from the GET request:

   PUT /api/v2/help_center/articles/{article_id}/translations/{locale}.json
   

   See Update Translation.

To learn how you might build a copy-sync application with these endpoints, see Mimeo, a small, command-line application on Github. Start with the project's documentation. Then clone or download the source code to try it out or just to see how it works. You can also modify or extend the application any way you want to build your own solution.