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.
{
"project_version_id": "ae430990-88df-4886-b1e6-2596ae416df7",
"lang_code": "en",
"user_id": "43340990-88df-4886-b1e6-2596ae416df7",
"article_ids": [
"ea35f84c-394b-407c-80e9-4187a7ea9620",
"49fe8b58-2e21-4251-b10d-cec4c5a8769f"
],
"workflow_status_info": {
"status_id": "65545e06-8c41-4e1a-a090-c603f9f1b4b2",
"due_date": "2024-06-13T14:30:00Z",
"comment": "Ready for review",
"assignee_id": "eed92685-0c5e-46b4-b559-c27625fe7a6b"
}
}Identifier of the specific workspace in the project in which the articles exist. This ID is used to ensure the workflow status update is applied to articles in a particular workspace.
Language code of the articles whose workflow status is being updated (e.g., "en", "fr"). This ensures the workflow status update is applied to the article in the specified language.
User ID of the team account changing the workflow status. This team account will be recorded in the audit log.
List of article IDs to be updated. Each ID in this array should refer to an existing article in the specified project version and language.
Object for workflow status metadata. This object defines the new workflow status and any associated information like due date, comment, or assignee.
ID of the workflow status to apply to the listed articles. If omitted, no status change is applied. The value should match one of the predefined workflow statuses in the project.
Due date associated with the workflow status for completing the task or review. It should be in ISO 8601 format (yyyy-mm-ddThh:mm:ss)
Optional text comment added along with the workflow status update. Useful for provided high-level instructions, context, or decisions.
ID of the user assigned to this workflow status. Assigning someone to a workflow status ensures they are notified via email.
{
"project_version_id": "ae430990-88df-4886-b1e6-2596ae416df7",
"lang_code": "en",
"user_id": "43340990-88df-4886-b1e6-2596ae416df7",
"article_ids": [
"ea35f84c-394b-407c-80e9-4187a7ea9620",
"49fe8b58-2e21-4251-b10d-cec4c5a8769f"
],
"workflow_status_info": {
"status_id": "65545e06-8c41-4e1a-a090-c603f9f1b4b2",
"due_date": "2024-06-13T14:30:00Z",
"comment": "Ready for review",
"assignee_id": "eed92685-0c5e-46b4-b559-c27625fe7a6b"
}
}Identifier of the specific workspace in the project in which the articles exist. This ID is used to ensure the workflow status update is applied to articles in a particular workspace.
Language code of the articles whose workflow status is being updated (e.g., "en", "fr"). This ensures the workflow status update is applied to the article in the specified language.
User ID of the team account changing the workflow status. This team account will be recorded in the audit log.
List of article IDs to be updated. Each ID in this array should refer to an existing article in the specified project version and language.
Object for workflow status metadata. This object defines the new workflow status and any associated information like due date, comment, or assignee.
ID of the workflow status to apply to the listed articles. If omitted, no status change is applied. The value should match one of the predefined workflow statuses in the project.
Due date associated with the workflow status for completing the task or review. It should be in ISO 8601 format (yyyy-mm-ddThh:mm:ss)
Optional text comment added along with the workflow status update. Useful for provided high-level instructions, context, or decisions.
ID of the user assigned to this workflow status. Assigning someone to a workflow status ensures they are notified via email.
{
"project_version_id": "ae430990-88df-4886-b1e6-2596ae416df7",
"lang_code": "en",
"user_id": "43340990-88df-4886-b1e6-2596ae416df7",
"article_ids": [
"ea35f84c-394b-407c-80e9-4187a7ea9620",
"49fe8b58-2e21-4251-b10d-cec4c5a8769f"
],
"workflow_status_info": {
"status_id": "65545e06-8c41-4e1a-a090-c603f9f1b4b2",
"due_date": "2024-06-13T14:30:00Z",
"comment": "Ready for review",
"assignee_id": "eed92685-0c5e-46b4-b559-c27625fe7a6b"
}
}Identifier of the specific workspace in the project in which the articles exist. This ID is used to ensure the workflow status update is applied to articles in a particular workspace.
Language code of the articles whose workflow status is being updated (e.g., "en", "fr"). This ensures the workflow status update is applied to the article in the specified language.
User ID of the team account changing the workflow status. This team account will be recorded in the audit log.
List of article IDs to be updated. Each ID in this array should refer to an existing article in the specified project version and language.
Object for workflow status metadata. This object defines the new workflow status and any associated information like due date, comment, or assignee.
ID of the workflow status to apply to the listed articles. If omitted, no status change is applied. The value should match one of the predefined workflow statuses in the project.
Due date associated with the workflow status for completing the task or review. It should be in ISO 8601 format (yyyy-mm-ddThh:mm:ss)
Optional text comment added along with the workflow status update. Useful for provided high-level instructions, context, or decisions.
ID of the user assigned to this workflow status. Assigning someone to a workflow status ensures they are notified via email.
{
"project_version_id": "ae430990-88df-4886-b1e6-2596ae416df7",
"lang_code": "en",
"user_id": "43340990-88df-4886-b1e6-2596ae416df7",
"article_ids": [
"ea35f84c-394b-407c-80e9-4187a7ea9620",
"49fe8b58-2e21-4251-b10d-cec4c5a8769f"
],
"workflow_status_info": {
"status_id": "65545e06-8c41-4e1a-a090-c603f9f1b4b2",
"due_date": "2024-06-13T14:30:00Z",
"comment": "Ready for review",
"assignee_id": "eed92685-0c5e-46b4-b559-c27625fe7a6b"
}
}Identifier of the specific workspace in the project in which the articles exist. This ID is used to ensure the workflow status update is applied to articles in a particular workspace.
Language code of the articles whose workflow status is being updated (e.g., "en", "fr"). This ensures the workflow status update is applied to the article in the specified language.
User ID of the team account changing the workflow status. This team account will be recorded in the audit log.
List of article IDs to be updated. Each ID in this array should refer to an existing article in the specified project version and language.
Object for workflow status metadata. This object defines the new workflow status and any associated information like due date, comment, or assignee.
ID of the workflow status to apply to the listed articles. If omitted, no status change is applied. The value should match one of the predefined workflow statuses in the project.
Due date associated with the workflow status for completing the task or review. It should be in ISO 8601 format (yyyy-mm-ddThh:mm:ss)
Optional text comment added along with the workflow status update. Useful for provided high-level instructions, context, or decisions.
ID of the user assigned to this workflow status. Assigning someone to a workflow status ensures they are notified via email.
Success
The below example shows a successful workflow update response
{
"extension_data": null,
"success": true,
"errors": 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.
Bad Request
The 'ProjectDocumentVersionId' field is required but was not provided.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "ProjectDocumentVersion ID is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}The 'LangCode' field is required but was not provided.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Language code is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}The 'UserId' field is required but was not provided.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "User Id is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}The 'DocumentIds' field is required but was not provided.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Document IDs are required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}The 'WorkflowStatusInfo' field is required but was not provided.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Workflow status information 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.