Create Article

Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
owned_bylist of stringsRequired
The users that own the article.
resourceobjectRequired
titlestringRequiredformat: "text"
Name of the article.
access_levelenumOptional
Allowed values:
aliaseslist of stringsOptional
The aliases of the article.
applies_to_partslist of stringsOptional
The parts that the article applies to.
article_typeenumOptional
Type of the article.
Allowed values:
authored_bylist of stringsOptional
The authors of the article.
brandstringOptionalformat: "id"
The brand associated with the article.
content_formatenumOptional
Content format of the article.
Allowed values:
custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

data_sourceslist of objectsOptional
Data sources provide the backing data for the article.
descriptionstringOptionalformat: "text"
Description for the article.
extracted_contentlist of stringsOptional
ID of the extracted content artifact.
languagestringOptionalformat: "text"
Language of the article.
notifybooleanOptional
Whether to notify the users when the article is published.
parentstringOptionalformat: "id"
The parent directory of the article.
published_atstringOptionalformat: "date-time"
The published date of the article.
release_notesstringOptionalformat: "text"
The release notes of the article.
scopelongOptional
The scope of the article.
shared_withlist of objectsOptional
Information about the role the member receives due to the share.
statusenumOptional
Status of the article.
Allowed values:
tagslist of objectsOptional
Tags associated with the article.

Response

Create article response.
articleobject

Errors