Post
/v2/Articles
Security
API Key
Header parameter nameapi_token

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

Body parameters
object
title
string Required

The title of the article

Min length1
content
string | null

The content of the article, for any Editor type, use this property

category_id
string Required

The ID of the category where the article will be created

Min length1
project_version_id
string Required

The project version ID in which the article will be created

Min length1
order
integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id
string Required

The ID of the team account that will be marked as a contributor of the article

Min length1
content_type
integer (int32)

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

Valid values[ 0, 1, 2 ]
object
title
string Required

The title of the article

Min length1
content
string | null

The content of the article, for any Editor type, use this property

category_id
string Required

The ID of the category where the article will be created

Min length1
project_version_id
string Required

The project version ID in which the article will be created

Min length1
order
integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id
string Required

The ID of the team account that will be marked as a contributor of the article

Min length1
content_type
integer (int32)

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

Valid values[ 0, 1, 2 ]
object
title
string Required

The title of the article

Min length1
content
string | null

The content of the article, for any Editor type, use this property

category_id
string Required

The ID of the category where the article will be created

Min length1
project_version_id
string Required

The project version ID in which the article will be created

Min length1
order
integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id
string Required

The ID of the team account that will be marked as a contributor of the article

Min length1
content_type
integer (int32)

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

Valid values[ 0, 1, 2 ]
object
title
string Required

The title of the article

Min length1
content
string | null

The content of the article, for any Editor type, use this property

category_id
string Required

The ID of the category where the article will be created

Min length1
project_version_id
string Required

The project version ID in which the article will be created

Min length1
order
integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id
string Required

The ID of the team account that will be marked as a contributor of the article

Min length1
content_type
integer (int32)

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

Valid values[ 0, 1, 2 ]
Responses
200
400

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

modified_at
string (date-time) | null

Article modified date time

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