Skip to main content
POST
Create article

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
knowledgeBaseId
string
required

The ID of the knowledge base where the article will be created. Required.

Example:

"{ \"knowledgeBaseId\": \"23456789\" }"

language
string
required

The article’s language. Must be either the knowledge base’s primary language or one of its existing translation-variant languages. Accepts an ISO 639 language code (e.g., en, es), optionally with a region subtag (e.g., en-US). Required.

Example:

"{ \"language\": \"en\" }"

title
string
required

The title of the article. Required.

Example:

"{ \"title\": \"How to reset your password\" }"

accessGroupIds
string[]

The IDs of the access groups permitted to view the article. Required and non-empty only when accessType is ACCESS_GROUP_MEMBERSHIP; must be empty otherwise.

accessType
enum<string>

The access level for the article: PUBLIC, SSO_LOGIN, or ACCESS_GROUP_MEMBERSHIP.

Available options:
ACCESS_GROUP_MEMBERSHIP,
PUBLIC,
SSO_LOGIN
Example:

"{ \"accessType\": \"ACCESS_GROUP_MEMBERSHIP\" }"

body
string

The article’s HTML content.

categoryId
string

The unique identifier of the category this article belongs to.

Example:

"{ \"categoryId\": \"12345678\" }"

metaDescription
string

A brief description of the article, used for SEO.

path
string

The URL path segment for the article.

Example:

"{ \"path\": \"how-to-reset-your-password\" }"

subtitle
string

The subtitle of the article.

Example:

"{ \"subtitle\": \"Step-by-step instructions\" }"

tagIds
string[]

The IDs of the tags associated with the article.

Example:

"{ \"tagIds\": [\"34567890\"] }"

translationOfId
string

The ID of the article this is a translation of.

Example:

"{ \"translationOfId\": \"98765432\" }"

Response

successful operation

accessGroupIds
string[]
required

The IDs of the access groups that have access to the article. Used when accessType is ACCESS_GROUP_MEMBERSHIP.

accessType
enum<string>
required

The access level for the article: PUBLIC, SSO_LOGIN, or ACCESS_GROUP_MEMBERSHIP.

Available options:
ACCESS_GROUP_MEMBERSHIP,
PUBLIC,
SSO_LOGIN
archivedInDashboard
boolean
required

A boolean indicating whether the article is archived in the dashboard.

createdAt
string<date-time>
required

The date and time when the article was created, in ISO 8601 format.

id
string
required

The unique identifier for the knowledge article.

knowledgeBaseId
string
required

The unique identifier of the knowledge base to which this article belongs.

language
string
required

The article’s language, as an ISO 639 code (e.g. en).

path
string
required

The URL path segment for the article. Combined with the knowledge base’s domain, this forms the URL field.

state
enum<string>
required

The article’s state: either DRAFT or PUBLISHED.

Available options:
DRAFT,
PUBLISHED
tagIds
string[]
required

The IDs of the tags associated with the article.

title
string
required

The title of the knowledge article.

updatedAt
string<date-time>
required

The date and time when the article was last updated, in ISO 8601 format.

url
string
required

The full URL of the article.

body
string

The article’s HTML content. Only included when the request’s includeBody query parameter is true (which is the default value for the query).

categoryId
string

The ID of the category this article belongs to.

createdByUserId
string

The unique identifier of the user who created the article.

initialPublishedAt
string<date-time>

The date and time the article was first published, in ISO 8601 format. Absent if the article has never been published.

metaDescription
string

A brief description of the article, used for SEO.

position
integer<int32>

The position of the article within its category.

publishedAt
string<date-time>

The date and time the article was last published, in ISO 8601 format. Absent if the article has never been published.

subcategoryId
string

The subcategory this article belongs to.

subtitle
string

The subtitle of the knowledge article.

translationOfId
string

The ID of the article this is a translation of.

translations
object

A summary of the article’s translations, keyed by language code. Only included when the request’s includeTranslations query parameter is true (which is the default value for the query).

updatedByUserId
string

The unique identifier of the user who last updated the article.

Last modified on September 28, 2026