API Referencearticles

Update Article

Updates an article.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The article's ID.
access_levelenumOptional
Allowed values:
aliasesobjectOptional
applies_to_partsobjectOptional
artifactsobjectOptional
authored_byobjectOptional
brandstring or nullOptionalformat: "id"
The updated brand of the article.
content_blocksobjectOptional
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_sourcesobjectOptional
descriptionstringOptionalformat: "text"
Updated description of the article object, or unchanged if not provided.
extracted_contentobjectOptional
languagestringOptionalformat: "text"
Updates the language of the article.
notifybooleanOptional
Whether to notify the users when the article is published.
owned_byobjectOptional
parentstring or nullOptionalformat: "id"
The updated parent directory for the article.
published_versionstringOptionalformat: "text"
Updates the the latest published version.
release_notesstringOptionalformat: "text"
Updates the release notes of the article.
reorderobjectOptional
shared_withobjectOptional
statusenumOptional
Status of the article.
Allowed values:
tagsobjectOptional
titlestringOptionalformat: "text"
Updated title of the article object, or unchanged if not provided.
urlstringOptionalformat: "text"
Updates the URL of the external article.

Response

Success.
articleobject

Errors