Update Article

POST

Updates an article.

Request

This endpoint expects an object.
access_levelenumRequired
Allowed values: externalinternalprivatepublicrestricted
aliasesobjectRequired
applies_to_partsobjectRequired
artifactsobjectRequired
authored_byobjectRequired
content_blocksobjectRequired
custom_schema_specobjectRequired

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

extracted_contentobjectRequired
idstringRequiredformat: "id"

The article’s ID.

owned_byobjectRequired
reorderobjectRequired
shared_withobjectRequired
statusenumRequired
Allowed values: archiveddraftpublishedreview_needed

Status of the article.

tagsobjectRequired
custom_fieldsobjectOptional

Application-defined custom fields.

descriptionstringOptionalformat: "text"

Updated description of the article object, or unchanged if not provided.

languagestringOptionalformat: "text"

Updates the language of the article.

parentstringOptionalformat: "id"

The updated parent directory for the article.

published_versionstringOptionalformat: "text"

Updates the the latest published version.

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
Built with