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.
The ID of the article
Language code of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "Publishing my article with new changes."
}The ID of the team account that will be marked as the contributor of this publish
The version number of the article to be published
The publish message of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "Publishing my article with new changes."
}The ID of the team account that will be marked as the contributor of this publish
The version number of the article to be published
The publish message of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "Publishing my article with new changes."
}The ID of the team account that will be marked as the contributor of this publish
The version number of the article to be published
The publish message of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "Publishing my article with new changes."
}The ID of the team account that will be marked as the contributor of this publish
The version number of the article to be published
The publish message of the article
Success
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"url": "https://example.com/v1/docs/en/getting-started",
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Create article response data
The ID of the article
The article title
The article version number(revision) that is currently published
The latest version number of this article
The default language code
Indicates if the article is visible on the site
The status of the article: 0 - Draft, 3 - Published
The position of the article inside the parent category
The slug of the article
The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2
The Translation status of the article
True indicates that the article is shared
Article modified date time
Current Workflow status of the article
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 is repeated task that, this article has already published
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Article has already been published.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}version_number is missing or null, kindly verify the version number and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The field VersionNumber must be between 1 and 32767.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly verify the article_id and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "One or more errors occurred. (Article not found).",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly verify the articleId or langCode and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Article not found.",
"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.