Update an article
Update an existing article using its unique identifier. Only the fields included in the request are modified — omitted fields are left unchanged. Supports updating title, subtitle, body, category, tags, access settings, and metadata. ArchivedInDashboard is a CMS-specific property that controls the article’s visibility in the dashboard UI and has no other effect on the article’s state. To delete an article, set archived to true and include no other fields in the request body. This endpoint does not support restoring an archived article — setting archived to false will fail.
Supported products
Supported products
Required scopes
Required scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the article to update.
Body
An object representing the IDs of access groups that can view the article.
An object defining the access level for the article. Can be PUBLIC, ACCESS_GROUP_MEMBERSHIP, or SSO_LOGIN.
An object indicating whether the article is archived.
An object indicating whether the article is archived in the dashboard.
The main content of the article, represented as an object.
The identifier for the category to which the article belongs, represented as an object.
A brief description of the article for SEO purposes, represented as an object.
The URL path for the article, represented as an object.
The subtitle of the article, represented as an object.
An object representing the tags associated with the article.
The title of the article, represented as an object.
An object representing the ID of the original article if this is a translation.
Response
Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.
The error category
A unique identifier for the request. Include this value with any error reports or support tickets
"aeb5f871-7f07-4993-9211-075dc63e7cbf"
A human readable message describing the error along with remediation steps where appropriate
"An error occurred"
Context about the error condition
"{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}"
further information about the error
A map of link names to associated URIs containing documentation about the error or recommended remediation steps
A specific category that contains more specific detail about the error