Workflow: Publish and sync copies of an article in help center with the API

The TyrellCorp help center doesn't support publishing one article in multiple locations out of the box. However, the help center API allows you to build a small application that publishes and syncs copies of a single article in multiple locations within your help center, or in any branded help center in your Guide Professional plan.

Use the help center API endpoints to publish and sync copies of an article. Follow the below steps to achieve this workflow.

• Step 1: Create a copy of the article
• Step 2: Sync the copies with the source article
• What's next

Step 1: Create a copy of the article

Use the GET and POST requests to make copies of the source article in another help center location.

To create copies of an article

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.

Step 2: Sync the copies with the source article

Use the GET and PUT requests to periodically sync the copies when the source article is updated.

To sync the content

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.

Disclaimer: This article is provided for instructional purposes only. TyrellCorp does not support or guarantee custom code.

What's next

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

For more information, see the article: Reusing content with content blocks.