Update article settings
  • 02 Feb 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Update article settings

  • Dark
    Light

PUT /articles/{ID}/{langcode}/settings 

Updates settings for the article in the respective language


Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.


Route Parameters

ParameterRequiredTypeDescription
IDYesstringThe ID of the article
langCodeYesstringLanguage code for multilingual (Default value is en)


Body Parameters

ParameterRequiredTypeDescription
slugNostringThe slug of the article
seo_titleNo
stringThe SEO title of the article
descriptionNo
stringThe description of the article
allow_commentsNo
booleanDisable / Enable internal commenting on the article
show_table_of_contentsNo
booleanDisable / Enable article table of contents(TOC) on the knowledge base
tagsNo
string[]Custom article tags
status_indicatorNo
intUser site article status 0 - none, 1 - new, 2 - updated
status_indicator_expiry_dateNo
DateTimeThe date-time when the public article status is removed
exclude_from_searchNo
booleanIf true, the article with not appear in search results on the knowledge base
related_articlesNo
string[]The list of related article IDs to show on the knowledge base


Sample Request

{
    "slug": "New API Documentation",
    "seo_title": "API Documentation",
    "allow_comments": true,
    "show_table_of_contents": true,
    "tags": [
        "API",
        "Demo",
        "Hello"
    ],
    "related_articles": ["ccc1ae8-0cda-4886-9f73-e98f3d8cc737", "bb1a1ae8-0cda-4886-9f73-e98f3d8cc737"]
}

Response

{
    "data": {
        "slug": "new-api-documentation",
        "seo_title": "API Documentation",
        "description": "",
        "allow_comments": true,
        "show_table_of_contents": true,
        "featured_image_url": null,
        "tags": [
            "API",
            "Demo",
            "Hello"
        ],
        "status_indicator": 0,
        "status_indicator_expiry_date": null,
        "exclude_from_search": false,
        "related_articles": [
            {
                "id": "bb1a1ae8-0cda-4886-9f73-e98f3d8cc737",
                "title": "Welcome !",
                "hidden": false,
                "slug": "welcome"
            },
            {
                "id": "ccc1ae8-0cda-4886-9f73-e98f3d8cc737",
                "title": "API Core",
                "hidden": false,
                "slug": "api-core"
            }
        ]
    },
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}


Response Sample

ParameterTypeDescription
slugstringThe slug of the article
seo_titlestringThe SEO title of the article
descriptionstringThe description of the article
allow_commentsbooleanDisable / Enable internal commenting on the article
show_table_of_contentsbooleanDisable / Enable article table of contents on the knowledge base
featured_image_urlstringThe URL of the image that will be used as a featured image
tagsstring[]Custom article tags
status_indicatorenumeratedUser site article status 0 - none, 1 - new, 2 - updated
status_indicator_expiry_datedatetimeThe date-time when the public article status is removed
exclude_from_searchbooleanIf true, the article with not appear in search results on the knowledge base
related_articlesobject[]The list of articles related to the current article. 

Response > related_articles

ParameterTypeDescription
idstringArticle ID
titlestringArticle title
hiddenbooleanArticle visibility status
slugstringArticle slug

Was this article helpful?