Update the SEO details of an article

Beta
  • Updated on Mar 9, 2023
  • 1 minute(s) read
  • Prashanth Rajamanickam

With Postman, you can update the SEO details, such as an article's meta title and meta description. Updating SEO details with API allows you to automate the SEO process.

To update the SEO details:

  • View the current SEO details of the article
  • Update the desired SEO details of the article

Viewing settings of the article

1_Screenshot-Gets_settings_for_article

  1. Under v2, expand Articles → {article Id} → {lang Code} → settings and click Get settings for the article
  2. In the Params tab, you can find the Path variables section
  3. In the 'Value' field of articleId and langCode, paste the desired article id and language code
  4. Click Send
    This action will display all the settings of the desired article. You can find the current meta title and meta description of the article.

Updating SEO details of the article

2_Screenshot-Updates_settings_for_article

  1. Under v2, expand Articles → {article Id} → settings and click Updates settings for the article
  2. In the Params tab, you can find the Path variables section
  3. In the 'Value' field of articleId and langCode, paste the desired article id and language code
    3_Screenshot-Updates_settings_for_article_body
  4. Navigate to the Body tab in the main window
  5. Remove the parameters you do not want to update

The parameter values in this tab are updated for the respective settings in the article. If the unwanted parameters are not removed, the unwanted parameters also get updated.

  1. Update the desired meta title and meta description in the value of 'seo_title' and 'description' parameters
  2. Remove other parameters
  3. Click Send, and the desired settings are updated successfully
  4. The desired article settings are updated successfully. You can verify this with the 200 OK status and success parameter value as true