Put
/v2/Articles/bulkupdate
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Body parameters
Show example
Array of object
object
article_id
string | null

The ID of the article

lang_code
string | null

Language code of the article

title
string | null

The title of the article

content
string | null

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

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

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

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

translation_option
string | null

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

source
string | null

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).

Array of object
object
article_id
string | null

The ID of the article

lang_code
string | null

Language code of the article

title
string | null

The title of the article

content
string | null

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

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

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

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

translation_option
string | null

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

source
string | null

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).

Array of object
object
article_id
string | null

The ID of the article

lang_code
string | null

Language code of the article

title
string | null

The title of the article

content
string | null

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

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

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

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

translation_option
string | null

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

source
string | null

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).

Array of object
object
article_id
string | null

The ID of the article

lang_code
string | null

Language code of the article

title
string | null

The title of the article

content
string | null

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

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

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

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

translation_option
string | null

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

source
string | null

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
Array of object (BulkArticleResultCustomer) | null

Bulk updated article data

object
article_id
string | null

Article ID that has updated

success
boolean

Indicates if articles creation was successful

details
string | null

Additional information about articles creation status

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