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
Show example
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

Maximum32767
Minimum1
publish_message
string | null

The publish message of the article

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

Maximum32767
Minimum1
publish_message
string | null

The publish message of the article

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

Maximum32767
Minimum1
publish_message
string | null

The publish message of the article

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

Maximum32767
Minimum1
publish_message
string | null

The publish message of the article

Responses
200
400
Show example

Success

Collapse all
object
data
object (ArticleSimpleDataCustomer)
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)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

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

0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress

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

True indicates that the article is shared

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
information
Array of object (BaseInformation) | null

Information passed by the customer API response

object