Put
/v1/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
string Required

The ID of the article

langCode
string Required

Language code of the article

Body parameters

Show example

object

title
string 

The title of the article


content
string 

The markdown content of the article. If the editor type is Markdown, use this property


html_content
string 

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property


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 

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



object

title
string 

The title of the article


content
string 

The markdown content of the article. If the editor type is Markdown, use this property


html_content
string 

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property


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 

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



object

title
string 

The title of the article


content
string 

The markdown content of the article. If the editor type is Markdown, use this property


html_content
string 

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property


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 

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



object

title
string 

The title of the article


content
string 

The markdown content of the article. If the editor type is Markdown, use this property


html_content
string 

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property


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 

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


Responses
200
400
Show example

Success

Collapse all

object

data
object

id
string 

The ID of the article


title
string 

The article title


public_version
integer 

The article version number(revision) that is currently published


latest_version
integer 

The latest version number of this article


language_code
string 


hidden
boolean 

Indicates if the article is visible on the site


status
integer 

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

The position of the article inside the parent category


slug
string 


content_type
integer 

Valid values[0,1,2]
extension_data
object

success
boolean 

Status indication for customer Api response


errors
Array of object

Errors in the customer Api response


object

warnings
Array of object

Warning in the customer Api response


object

information
Array of object

Information passed by the customer Api response


object