Publishes an article with an id

Prev Next
Post
/v2/Articles/{articleId}/{langCode}/publish
Security
API Key: api_token
Header parameter nameapi_token

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.

Path parameters
articleId
stringRequired

The ID of the article

langCode
stringRequired

Language code of the article

Default"en"
Body parameters
Publish Article Request Example

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."
}
object
user_id
string Required

The ID of the team account that will be marked as the contributor of this publish

Min length1
version_number
integer (int32) Required

The version number of the article to be published

Minimum1
Maximum32767
publish_message
string | null

The publish message of the article

Publish Article Request Example

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."
}
object
user_id
string Required

The ID of the team account that will be marked as the contributor of this publish

Min length1
version_number
integer (int32) Required

The version number of the article to be published

Minimum1
Maximum32767
publish_message
string | null

The publish message of the article

Publish Article Request Example

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."
}
object
user_id
string Required

The ID of the team account that will be marked as the contributor of this publish

Min length1
version_number
integer (int32) Required

The version number of the article to be published

Minimum1
Maximum32767
publish_message
string | null

The publish message of the article

Publish Article Request Example

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."
}
object
user_id
string Required

The ID of the team account that will be marked as the contributor of this publish

Min length1
version_number
integer (int32) Required

The version number of the article to be published

Minimum1
Maximum32767
publish_message
string | null

The publish message of the article

Responses
200

Success

Publish Article Request Example

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": []
}
Expand All
object
data
object | null

Create article response data

id
string | null

The ID of the article

title
string | null

The article title

public_version
integer (int32)

The article version number(revision) that is currently published

latest_version
integer (int32)

The latest version number of this article

language_code
string | null Deprecated

The default language code

hidden
boolean

Indicates if the article is visible on the site

status
integer (int32)

The status of the article: 0 - Draft, 3 - Published

Valid values[ 0, 3 ]
order
integer (int32)

The position of the article inside the parent category

slug
string | null

The slug of the article

content_type
integer (int32) | null

The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2

Valid values[ 0, 1, 2 ]
translation_option
integer (int32)

The Translation status of the article

Valid values[ 0, 1, 2, 3 ]
is_shared_article
boolean

True indicates that the article is shared

modified_at
string (date-time) | null

Article modified date time

current_workflow_status_id
string | null

Current Workflow status of the article

extension_data
object | null

Extension data for customer API response

success
boolean

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.

errors
Array of object (BaseError) | null

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.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

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.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

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.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

Bad Request

ALready published Article

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 Not Found

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": []
}
article_id Not Found

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": []
}
article Not Found

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": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

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.

errors
Array of object (BaseError) | null

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.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

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.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

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.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.