Publishes an article with an id

  • Updated on May 14, 2025
  • 4 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
 Prev Next
Post
/v2/Articles/{articleId}/{langCode}/publish
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

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

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information

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

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information