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.
Language code of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
[
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
}
]The ID of the article
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.
[
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
}
]The ID of the article
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.
[
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
}
]The ID of the article
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.
[
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"version_number": 1,
"publish_message": "multiple article published"
}
]The ID of the article
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.
{
"data": [
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"success": true,
"details": "Successfully published article with an id 8bcd4bf9-eb93-40d9-a8df-c3b518660ceb"
},
{
"article_id": "99575fe3-f7b0-4e0a-bc46-38aed8c621f9",
"success": true,
"details": "Successfully published article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9"
}
],
"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 article has been already published.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Failed to publish article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9\r\nError: Article has already been published.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly verfy the user_id is not null or empty, and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Failed to publish article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9\r\nError: The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Invalid article_id or null reference, verify the article Id and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The ArticleId field is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Invalid datatype for version_number, Kindly use integer value 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": []
}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.