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
stringRequired

The ID of the article

langCode
stringRequired

Language code of the article

Default"en"
Body parameters
Show example
object
slug
string | null

The slug of the article

seo_title
string | null

The SEO title of the article

description
string | null

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 | null

Custom article tags

string
status_indicator
integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]
status_indicator_expiry_date
string (date-time) | null

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 | null

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

string
content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
object
slug
string | null

The slug of the article

seo_title
string | null

The SEO title of the article

description
string | null

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 | null

Custom article tags

string
status_indicator
integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]
status_indicator_expiry_date
string (date-time) | null

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 | null

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

string
content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
object
slug
string | null

The slug of the article

seo_title
string | null

The SEO title of the article

description
string | null

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 | null

Custom article tags

string
status_indicator
integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]
status_indicator_expiry_date
string (date-time) | null

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 | null

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

string
content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
object
slug
string | null

The slug of the article

seo_title
string | null

The SEO title of the article

description
string | null

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 | null

Custom article tags

string
status_indicator
integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]
status_indicator_expiry_date
string (date-time) | null

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 | null

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

string
content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
Responses
200
400
Show example

Success

Collapse all
object
data
object (ArticleSettingCustomerResponse)
url
string | null

Url of the article

slug
string | null

The slug of the article

seo_title
string | null

The SEO title of the article

description
string | null

The SEO description of the article

allow_comments
boolean

True indicates that comments are allowed in the article

show_table_of_contents
boolean

True indicates that Table of Contents are shown in the article

featured_image_url
string | null

URL of the featured image

tags
Array of string | null

List of tags associated to the article

string
status_indicator
integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]
status_indicator_expiry_date
string (date-time) | null

The number of days after which the article status will be removed

exclude_from_search
boolean

True indicates that the article will not appear in the Knowledge base search results

related_articles
Array of object (RelatedArticleData) | null

List of related articles associated to the article

object
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
information
Array of object (BaseInformation) | null

Information passed by the customer API response

object