Create and publish multiple articles

You can use Document360’s API to create and publish multiple articles in one go. This helps you automate content creation across different versions and categories, reducing manual effort.

For example, you can create two articles in a category under version v1, and three articles in another category under version v2, all in a single request.

Prerequisites for creating multiple articles

Before you create multiple articles, complete the following authorization steps in Postman.

Creating multiple articles using Document360’s API

To create multiple articles, you need the following values:

• Project version ID

• Category ID

• User ID

Get project version ID

To create an article using the API, you need to associate it with the correct version of your documentation project. This step helps you retrieve that version ID.

1. In Postman, under Document360 Customer API, expand v2 > Project Versions.

2. Click Gets list of project versions, then click Send.

3. In the response body (as shown in the screenshot), locate the id of the version you want to use.

   NOTE

   If you're unsure which one to choose, look for the version marked with "is_current": true.

4. Copy the id value and save it for later use.

NOTE

In Document360, the order of categories and articles is based on the paths defined in the API specification files rather than tags. The first tag in the path determines the first category, with all endpoints mapped to that tag grouped accordingly.

Get category ID

To create an article, you need the ID of the category where the article should be added. Follow these steps to retrieve it using Postman:

1. Under Project Versions, expand the relevant {projectVersionId}, then go to categories > Gets list of categories within project version.

2. Click Gets list of categories within project version, then switch to the Params tab.

3. In the Path Variables section, enter the project version ID you copied in step 4 of the previous section.

4. In the Query Params section, provide the following values:

   • excludeArticles → true

   • langCode → en

   • includeCategoryDescription → false

5. Click Send.

6. In the response body, locate the id value of the category you want to use.

7. Copy the id and save it for later use.

PRO TIP

If you're not sure which category to use, look for the "name" field in the response to identify familiar category names (e.g., "Getting started").

Get user ID

To create an article using the API, you also need to provide the user ID of the team member creating the article.

1. In Postman, under v2, expand Teams, then click Get all team accounts.

2. Click Send to retrieve the list of all team members in the project.

3. In the response body, locate the desired user and copy the id value.

PRO TIP

If you're not sure which user to pick, look at fields like "email_id", "portal_role", or "last_name" to identify the appropriate account.

Create multiple articles

Once you have the required values (project_version_id, category_id, user_id), follow these steps to create multiple articles using the API.

Steps to create articles

1. Under v2, expand Articles > bulkcreate, then click Adds multiple articles.

2. In the main panel, switch to the Body tab.

3. You’ll see a default JSON body with two sample article objects. To add more articles:

   • Copy one of the existing article objects (enclosed in {}).

   • Paste it before the closing bracket ].

   • Add a comma , after each object, except the last one.

4. For each article object, update the following fields:

   • category_id: Paste the ID of the category where the article should be added.

   • project_version_id: Paste the project version ID.

   • title: Enter the article title.

   • user_id: Paste the user ID.

   • content: Add the article content.

   • order: Specify the position of the article within the category.

     • For example:

       • To place the article first in the category, set order to 0.

       • To make it the fifth article, set order to 4.

   • content_type: Select the editor type for the article. The default value of the parameter is null.

     • Set content_type to 0 for Markdown editor.

     • Set content_type to 1 for WYSIWYG editor.

     • Set content_type to 2 for Advanced WYSIWYG editor.

5. Click Send.

6. If the articles are created successfully, you’ll receive a 200 OK status and "success": true in the response.

7. Copy the id values for each newly created article and save them. You will need them for publishing.

Publish multiple articles

After creating your articles, you can publish them all at once using the API.

To publish multiple articles, you’ll need:

• article_id: The ID of each article to publish.

• user_id: The ID of the user performing the action.

Steps to publish articles

1. Under v2, expand Articles > bulkpublish > {langCode}, then click Publishes multiple articles.

2. Under v2, expand Articles, then click Publishes multiple articles.

3. In the main panel, switch to the Body tab.

4. You’ll see a sample request body with two article objects. To publish more articles:

   • Copy one of the existing objects (enclosed in {}).

   • Paste it before the closing bracket ].

   • Add a comma , after each object, except the last one.

5. For each article object, update the following fields:

   • article_id: Paste the ID of the article to publish.

   • user_id: Paste the user ID.

   • version_number: Specify the version number to be published.

   • publish_message: Enter a short message describing the purpose of the publish action.

6. Click Send.

7. If the articles are published successfully, you’ll receive a 200 OK status and "success": true in the response.

NOTE

Each article publish request must be inside {} and part of the array []. Ensure all commas are in place and that the JSON is valid.