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.
{
"articles": [
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"version_number": 1
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "multiple article unpublished"
}Details of the articles need to be unpublished
The ID of the article
The version number of the article to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the article exists.
The unpublish message of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"articles": [
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"version_number": 1
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "multiple article unpublished"
}Details of the articles need to be unpublished
The ID of the article
The version number of the article to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the article exists.
The unpublish message of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"articles": [
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"version_number": 1
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "multiple article unpublished"
}Details of the articles need to be unpublished
The ID of the article
The version number of the article to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the article exists.
The unpublish message of the article
Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.
{
"articles": [
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"version_number": 1
},
{
"article_id": "2ce2607f-6cfa-4bc9-9e47-1dc3843198629",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "multiple article unpublished"
}Details of the articles need to be unpublished
The ID of the article
The version number of the article to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the article exists.
The unpublish message of the article
Success
Unpublishing an article with ArticleId, project_version_id, langCode, user_id, version_number, and unpublish_message.
{
"data": [
{
"article_id": "8bcd4bf9-eb93-40d9-a8df-c3b518660ceb",
"success": true,
"details": "Successfully unpublished article with an id 8bcd4bf9-eb93-40d9-a8df-c3b518660ceb"
},
{
"article_id": "99575fe3-f7b0-4e0a-bc46-38aed8c621f9",
"success": true,
"details": "Successfully unpublished article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9"
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Bulk unpublish article response 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 article has been already unpublished.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Failed to unpublish article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9\r\nError: Article has already been unpublished.",
"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 unpublish 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.