Sign in
Basic

Update article

Changed on

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.

patch/cms/knowledge-base/2027-03-beta/articles/{articleId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.publish)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.write)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.settings.write)

Path parameters

articleIdstring required

The unique identifier of the article to update.

Request body

accessGroupIdsobject required

The IDs of the access groups permitted to view the article. Used when accessType is ACCESS_GROUP_MEMBERSHIP.

accessTypeobject required

The access level of the article: PUBLIC, ACCESS_GROUP_MEMBERSHIP, or SSO_LOGIN.

archivedobject required

The deleted state of an article. To delete an article, set archived to true and include no other fields in the request body. This service does not support restoring an archived article — setting archived to false will fail.

archivedInDashboardobject required

The visibility state for this article in the dashboard.

bodyobject required

The article’s HTML content.

categoryIdobject required

The ID of the category the article belongs to.

metaDescriptionobject required

A brief description of the article, used for SEO.

pathobject required

The URL path segment for the article. This is combined with the knowledge base’s domain to form the article’s full URL (see the URL field on the response).

subtitleobject required

The subtitle of the article.

tagIdsobject required

The IDs of tags associated with the article.

titleobject required

The title of the article.

translationOfIdobject required

The ID of the article this is a translation of.

Response

An error occurred.

Changes

  • 2027-03-beta2eff3dd6fefaRevision changes
    • ○

      the security scope cms.knowledge_base.articles.publish was added to the endpoint's security scheme oauth2

    • ○

      the security scope cms.knowledge_base.settings.write was removed from the endpoint's security scheme oauth2

  • 2027-03-betaf542018e1a93Revision changes
    • ○

      the security scope cms.knowledge_base.articles.publish was added to the endpoint's security scheme oauth2

    • ○

      the security scope cms.knowledge_base.settings.write was removed from the endpoint's security scheme oauth2