---
title: "Update the SEO details of an article"
slug: "how-to-update-seo-details"
updated: 2025-06-12T07:20:41Z
published: 2025-06-12T07:22:11Z
canonical: "apidocs.document360.com/how-to-update-seo-details"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.document360.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update the SEO details of an article

You can use Document360’s API to update the SEO metadata of an article, such as the meta title and meta description. This helps automate SEO optimization across your knowledge base.

To update the SEO details of an article, follow these steps:

1. View the current SEO details of the article.
2. Update the SEO details using the API.

---

## Prerequisites for creating an article

Before you update the SEO metadata of an article, complete the following authorization steps in Postman.

### Authorization

To authorize requests in Postman, make sure your API token is added and the appropriate Base URL is set.

1. Click **Document360 Customer API** in the category tree.
2. In the Postman **Workbench**, go to the **Variables** tab.
3. In the **Variables** tab, check the **Initial** and **Current** values of the `baseUrl` variable.

This value should already be set to `https://apihub.document360.io`. If not, update both fields accordingly.
4. Add a new variable for your API token. For example, name it `api_token`.

Paste your API token from Document360 into both the **Initial value** and **Current value** fields.
5. Go to the **Authorization** tab and enter the variable you created in the **Value** field.

For example, enter `{{api_token}}` if your variable is named `api_token`.

[Embedded content](https://www.floik.com/embed/6c8153d2-2726-4c62-b723-2bd209ff8c39/3274f00b-9839-480d-a29c-9a0ab11cb84f-flo.html)

Once you've completed these steps, you're ready to start using Document360 APIs in **Postman**.

---

## Update SEO metadata of an article using Document360’s API

To create an article, you need the following values:

- Project version ID
- Article 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]
> 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.

[Embedded content](https://www.floik.com/embed/6c8153d2-2726-4c62-b723-2bd209ff8c39/2f86e398-bc89-4ac3-9bfd-ee024115c9d2-flo.html)

> [!NOTE]
> 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 article ID

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

1. Under **Project Versions**, expand the relevant **{projectVersionId}**, then go to **articles** > **Gets list of articles within project version**.
2. Click **Gets list of articles 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:
  - `langCode`:`en`
5. Click **Send**.
6. In the response body, locate the `id` value of the article you want to update.
7. Copy the `id` and save it for later use.

> [!TIP]
> PRO TIP
> 
> If you're not sure which article to use, look for the `"name"` field in the response to identify familiar article names.

![](https://cdn.document360.io/2b5c503e-f283-4987-b5a8-2b71b454ecec/Images/Documentation/1_Screenshot-Gets_list_of_articles_within_project_version.jpg)

---

## View current SEO details

Use this step to check the existing meta title and meta description values of the article.

1. Under **v2**, expand **Articles** > **{articleId}** > **{langCode}** > **settings**.
2. Click **Get settings for the article**.
3. In the **Params** tab, provide:
  - `articleId`: Paste the article ID
  - `langCode`: Enter the language code (e.g., `en`)
4. Click **Send**.

The response displays the current values of `seo_title` and `description`.

![](https://cdn.document360.io/2b5c503e-f283-4987-b5a8-2b71b454ecec/Images/Documentation/1_Screenshot-Gets_settings_for_the_article.jpg)

---

## Update SEO details

After retrieving the existing details, use this request to update the article’s SEO fields.

1. Under **v2**, expand **Articles** > **{articleId}** > **{langCode}** > **settings**.
2. Click **Update settings for the article**.
3. In the **Params** tab, provide:
  - `articleId`: Paste the article ID
  - `langCode`: Enter the language code

![](https://cdn.document360.io/2b5c503e-f283-4987-b5a8-2b71b454ecec/Images/Documentation/2_Screenshot-Updates_settings_for_the_article_params_tab.jpg)

1. Switch to the **Body** tab and include only the fields you want to update:
  - `seo_title`: Enter the new meta title
  - `description`: Enter the new meta description
2. Remove all other parameters from the request body.
3. Click **Send**.

If successful, the API will return a `200 OK` status and `"success": true`.

> [!NOTE]
> NOTE
> 
> Any fields included in the request will overwrite the existing values. Remove all fields you do not wish to modify.

![](https://cdn.document360.io/2b5c503e-f283-4987-b5a8-2b71b454ecec/Images/Documentation/3_Screenshot-Updates_settings_for_the_article_body_tab.jpg)