> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# 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.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2027-03-beta/cms-knowledge-base-v2027-03-beta.json PATCH /cms/knowledge-base/2027-03-beta/articles/{articleId}
openapi: 3.0.1
info:
title: CMS Knowledge Base
description: Basepom for all HubSpot Projects
version: 2027-03-beta
x-hubspot-product-tier-requirements:
service: PROFESSIONAL
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Categories
- name: Drafts
- name: Tags
- name: Basic
paths:
/cms/knowledge-base/2027-03-beta/articles/{articleId}:
patch:
tags:
- Basic
summary: Update article
description: >-
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.
operationId: patch-/cms/knowledge-base/2027-03-beta/articles/{articleId}
parameters:
- name: articleId
in: path
description: The unique identifier of the article to update.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateArticleRequest'
required: true
responses:
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- cms.knowledge_base.articles.publish
- oauth2:
- cms.knowledge_base.articles.write
- oauth2:
- cms.knowledge_base.settings.write
components:
schemas:
UpdateArticleRequest:
required:
- accessGroupIds
- accessType
- archived
- archivedInDashboard
- body
- categoryId
- metaDescription
- path
- subtitle
- tagIds
- title
- translationOfId
type: object
properties:
accessGroupIds:
type: object
properties: {}
description: >-
An object representing the IDs of access groups that can view the
article.
accessType:
type: object
properties: {}
description: >-
An object defining the access level for the article. Can be PUBLIC,
ACCESS_GROUP_MEMBERSHIP, or SSO_LOGIN.
archived:
type: object
properties: {}
description: An object indicating whether the article is archived.
archivedInDashboard:
type: object
properties: {}
description: >-
An object indicating whether the article is archived in the
dashboard.
body:
type: object
properties: {}
description: The main content of the article, represented as an object.
categoryId:
type: object
properties: {}
description: >-
The identifier for the category to which the article belongs,
represented as an object.
metaDescription:
type: object
properties: {}
description: >-
A brief description of the article for SEO purposes, represented as
an object.
path:
type: object
properties: {}
description: The URL path for the article, represented as an object.
subtitle:
type: object
properties: {}
description: The subtitle of the article, represented as an object.
tagIds:
type: object
properties: {}
description: An object representing the tags associated with the article.
title:
type: object
properties: {}
description: The title of the article, represented as an object.
translationOfId:
type: object
properties: {}
description: >-
An object representing the ID of the original article if this is a
translation.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
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.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
cms.knowledge_base.articles.publish: ''
cms.knowledge_base.articles.read: ''
cms.knowledge_base.articles.write: ''
cms.knowledge_base.settings.read: ''
cms.knowledge_base.settings.write: ''
````
{product.name} -
{product.level}
)}