Put
/v2/Articles/{articleId}/{langCode}
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
title
string

The title of the article

content
string

The content of the article, for any Editor type, use this property.

html_content
string Deprecated

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

order
integer (int32)

To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

object
title
string

The title of the article

content
string

The content of the article, for any Editor type, use this property.

html_content
string Deprecated

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

order
integer (int32)

To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

object
title
string

The title of the article

content
string

The content of the article, for any Editor type, use this property.

html_content
string Deprecated

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

order
integer (int32)

To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

object
title
string

The title of the article

content
string

The content of the article, for any Editor type, use this property.

html_content
string Deprecated

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer (int32)

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

order
integer (int32)

To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

Responses
200
400
Show example

Success

Collapse all
object
data
object (ArticleSimpleDataCustomer)
id
string

The ID of the article

title
string

The article title

public_version
integer (int32)

The article version number(revision) that is currently published

latest_version
integer (int32)

The latest version number of this article

language_code
string Deprecated

The default language code

hidden
boolean

Indicates if the article is visible on the site

status
integer (int32)

The status of the category page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked

Valid values[ 0, 1, 2, 3, 4, 5 ]
order
integer (int32)

The position of the article inside the parent category

slug
string

The slug of the article

content_type
integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[ 0, 1, 2 ]
translation_option
integer (int32)

0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress

Valid values[ 0, 1, 2, 3 ]
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
warnings
Array of object (BaseWarning)

Warnings in the customer API response

object
information
Array of object (BaseInformation)

Information passed by the customer API response

object