Contents x
Updates settings for the article
  • 16 Mar 2023
  • 6 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Updates settings for the article

  • Updated on 16 Mar 2023
  • 6 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Put
/v2/Articles/{articleId}/{langCode}/settings
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
articleId
string Required

The ID of the article

langCode
string Required

Language code of the article

Body parameters
Article settings update request.

This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.

{
  "slug": "updatearticlesettings",
  "seo_title": "update",
  "description": "This is the description for updating article settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 2,
  "status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}
object
slug
string

The slug of the article

seo_title
string

The SEO title of the article

description
string

The SEO description of the article

allow_comments
boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents
boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags
Array of string

Custom article tags

status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string

The date-time when the public article status is removed

exclude_from_search
boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles
Array of string

The list of related article IDs to show in the knowledge base

content_type
integer
Valid values[0,1,2]
Article settings update request.

This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.

{
  "slug": "updatearticlesettings",
  "seo_title": "update",
  "description": "This is the description for updating article settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 2,
  "status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}
object
slug
string

The slug of the article

seo_title
string

The SEO title of the article

description
string

The SEO description of the article

allow_comments
boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents
boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags
Array of string

Custom article tags

status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string

The date-time when the public article status is removed

exclude_from_search
boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles
Array of string

The list of related article IDs to show in the knowledge base

content_type
integer
Valid values[0,1,2]
Article settings update request.

This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.

{
  "slug": "updatearticlesettings",
  "seo_title": "update",
  "description": "This is the description for updating article settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 2,
  "status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}
object
slug
string

The slug of the article

seo_title
string

The SEO title of the article

description
string

The SEO description of the article

allow_comments
boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents
boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags
Array of string

Custom article tags

status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string

The date-time when the public article status is removed

exclude_from_search
boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles
Array of string

The list of related article IDs to show in the knowledge base

content_type
integer
Valid values[0,1,2]
Article settings update request.

This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.

{
  "slug": "updatearticlesettings",
  "seo_title": "update",
  "description": "This is the description for updating article settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 2,
  "status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}
object
slug
string

The slug of the article

seo_title
string

The SEO title of the article

description
string

The SEO description of the article

allow_comments
boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents
boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags
Array of string

Custom article tags

status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string

The date-time when the public article status is removed

exclude_from_search
boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles
Array of string

The list of related article IDs to show in the knowledge base

content_type
integer
Valid values[0,1,2]
Responses
200

Success

Successfully updated the article setings.

This response indicate a article settings has been successfully updated.

{
  "data": {
    "slug": "updatearticlesettings",
    "seo_title": "update",
    "description": "This is the description for updating article settings.",
    "allow_comments": true,
    "show_table_of_contents": true,
    "featured_image_url": "",
    "tags": [],
    "status_indicator": 2,
    "status_indicator_expiry_date": "2023-03-16T13:17:47.3672054Z",
    "exclude_from_search": true,
    "related_articles": []
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": [
    {
      "extension_data": null,
      "description": "Article settings updated successfully"
    }
  ]
}
Expand All
object
data
object
slug
string
seo_title
string
description
string
allow_comments
boolean
show_table_of_contents
boolean
featured_image_url
string
tags
Array of string
status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string
exclude_from_search
boolean
related_articles
Array of object
object
id
string
title
string
hidden
boolean
slug
string
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "A non-empty request body is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
data
object
slug
string
seo_title
string
description
string
allow_comments
boolean
show_table_of_contents
boolean
featured_image_url
string
tags
Array of string
status_indicator
integer
Valid values[0,1,2,3]
status_indicator_expiry_date
string
exclude_from_search
boolean
related_articles
Array of object
object
id
string
title
string
hidden
boolean
slug
string
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next