The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
[
{
"article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
"lang_code": "en",
"title": "Updated Title",
"content": "updating content",
"html_content": "updating content
",
"category_id": "68212cec-7a9b-4323-9bb8-33865444a508",
"hidden": false,
"version_number": 1,
"translation_option": "",
"source": "",
"order": 0
}
]The ID of the article
Language code of the article
The title of the article
The content of the article, for any Editor type, use this property.
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.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
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).
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
[
{
"article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
"lang_code": "en",
"title": "Updated Title",
"content": "updating content",
"html_content": "updating content
",
"category_id": "68212cec-7a9b-4323-9bb8-33865444a508",
"hidden": false,
"version_number": 1,
"translation_option": "",
"source": "",
"order": 0
}
]The ID of the article
Language code of the article
The title of the article
The content of the article, for any Editor type, use this property.
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.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
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).
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
[
{
"article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
"lang_code": "en",
"title": "Updated Title",
"content": "updating content",
"html_content": "updating content
",
"category_id": "68212cec-7a9b-4323-9bb8-33865444a508",
"hidden": false,
"version_number": 1,
"translation_option": "",
"source": "",
"order": 0
}
]The ID of the article
Language code of the article
The title of the article
The content of the article, for any Editor type, use this property.
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.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
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).
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
[
{
"article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
"lang_code": "en",
"title": "Updated Title",
"content": "updating content",
"html_content": "updating content
",
"category_id": "68212cec-7a9b-4323-9bb8-33865444a508",
"hidden": false,
"version_number": 1,
"translation_option": "",
"source": "",
"order": 0
}
]The ID of the article
Language code of the article
The title of the article
The content of the article, for any Editor type, use this property.
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.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
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).
Success
This is an response that indicate the bulk articles has updated successfully.
{
"data": [
{
"article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
"success": true,
"details": "Successfully updated article with an id 0e9a3cf2-b5ce-46d4-a637-604cb8407b93"
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Bulk updated article data
Article ID that has updated
Indicates if articles creation was successful
Additional information about articles creation status
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"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": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.