Update article

curl --request PATCH \
  --url https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
  "accessType": "{ \"accessType\": \"PUBLIC\" }",
  "archived": "{ \"archived\": true }",
  "archivedInDashboard": "{ \"archivedInDashboard\": false }",
  "body": "{ \"body\": \"<p>To reset your password, go to Settings > Security.</p>\" }{}",
  "categoryId": "{ \"categoryId\": \"12345678\" }",
  "metaDescription": "{ \"metaDescription\": \"Learn how to reset your HubSpot account password.\" }",
  "path": "{}{ \"path\": \"how-to-reset-your-password\" }",
  "subtitle": "{ \"subtitle\": \"Step-by-step instructions\" }",
  "tagIds": "{ \"tagIds\": [\"23456789\", \"34567890\"] }",
  "title": "{ \"title\": \"How to reset your password\" }",
  "translationOfId": "{ \"translationOfId\": \"98765432\" }"
}
'

import requests

url = "https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}"

payload = {
    "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
    "accessType": "{ \"accessType\": \"PUBLIC\" }",
    "archived": "{ \"archived\": true }",
    "archivedInDashboard": "{ \"archivedInDashboard\": false }",
    "body": "{ \"body\": \"<p>To reset your password, go to Settings > Security.</p>\" }{}",
    "categoryId": "{ \"categoryId\": \"12345678\" }",
    "metaDescription": "{ \"metaDescription\": \"Learn how to reset your HubSpot account password.\" }",
    "path": "{}{ \"path\": \"how-to-reset-your-password\" }",
    "subtitle": "{ \"subtitle\": \"Step-by-step instructions\" }",
    "tagIds": "{ \"tagIds\": [\"23456789\", \"34567890\"] }",
    "title": "{ \"title\": \"How to reset your password\" }",
    "translationOfId": "{ \"translationOfId\": \"98765432\" }"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessGroupIds: '{ "accessGroupIds": ["45678901"] }',
    accessType: '{ "accessType": "PUBLIC" }',
    archived: '{ "archived": true }',
    archivedInDashboard: '{ "archivedInDashboard": false }',
    body: JSON.stringify('{ "body": "<p>To reset your password, go to Settings > Security.</p>" }{}'),
    categoryId: '{ "categoryId": "12345678" }',
    metaDescription: '{ "metaDescription": "Learn how to reset your HubSpot account password." }',
    path: '{}{ "path": "how-to-reset-your-password" }',
    subtitle: '{ "subtitle": "Step-by-step instructions" }',
    tagIds: '{ "tagIds": ["23456789", "34567890"] }',
    title: '{ "title": "How to reset your password" }',
    translationOfId: '{ "translationOfId": "98765432" }'
  })
};

fetch('https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'accessGroupIds' => '{ "accessGroupIds": ["45678901"] }',
    'accessType' => '{ "accessType": "PUBLIC" }',
    'archived' => '{ "archived": true }',
    'archivedInDashboard' => '{ "archivedInDashboard": false }',
    'body' => '{ "body": "<p>To reset your password, go to Settings > Security.</p>" }{}',
    'categoryId' => '{ "categoryId": "12345678" }',
    'metaDescription' => '{ "metaDescription": "Learn how to reset your HubSpot account password." }',
    'path' => '{}{ "path": "how-to-reset-your-password" }',
    'subtitle' => '{ "subtitle": "Step-by-step instructions" }',
    'tagIds' => '{ "tagIds": ["23456789", "34567890"] }',
    'title' => '{ "title": "How to reset your password" }',
    'translationOfId' => '{ "translationOfId": "98765432" }'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}"

	payload := strings.NewReader("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"PUBLIC\\\" }\",\n  \"archived\": \"{ \\\"archived\\\": true }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": false }\",\n  \"body\": \"{ \\\"body\\\": \\\"<p>To reset your password, go to Settings > Security.</p>\\\" }{}\",\n  \"categoryId\": \"{ \\\"categoryId\\\": \\\"12345678\\\" }\",\n  \"metaDescription\": \"{ \\\"metaDescription\\\": \\\"Learn how to reset your HubSpot account password.\\\" }\",\n  \"path\": \"{}{ \\\"path\\\": \\\"how-to-reset-your-password\\\" }\",\n  \"subtitle\": \"{ \\\"subtitle\\\": \\\"Step-by-step instructions\\\" }\",\n  \"tagIds\": \"{ \\\"tagIds\\\": [\\\"23456789\\\", \\\"34567890\\\"] }\",\n  \"title\": \"{ \\\"title\\\": \\\"How to reset your password\\\" }\",\n  \"translationOfId\": \"{ \\\"translationOfId\\\": \\\"98765432\\\" }\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"PUBLIC\\\" }\",\n  \"archived\": \"{ \\\"archived\\\": true }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": false }\",\n  \"body\": \"{ \\\"body\\\": \\\"<p>To reset your password, go to Settings > Security.</p>\\\" }{}\",\n  \"categoryId\": \"{ \\\"categoryId\\\": \\\"12345678\\\" }\",\n  \"metaDescription\": \"{ \\\"metaDescription\\\": \\\"Learn how to reset your HubSpot account password.\\\" }\",\n  \"path\": \"{}{ \\\"path\\\": \\\"how-to-reset-your-password\\\" }\",\n  \"subtitle\": \"{ \\\"subtitle\\\": \\\"Step-by-step instructions\\\" }\",\n  \"tagIds\": \"{ \\\"tagIds\\\": [\\\"23456789\\\", \\\"34567890\\\"] }\",\n  \"title\": \"{ \\\"title\\\": \\\"How to reset your password\\\" }\",\n  \"translationOfId\": \"{ \\\"translationOfId\\\": \\\"98765432\\\" }\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"PUBLIC\\\" }\",\n  \"archived\": \"{ \\\"archived\\\": true }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": false }\",\n  \"body\": \"{ \\\"body\\\": \\\"<p>To reset your password, go to Settings > Security.</p>\\\" }{}\",\n  \"categoryId\": \"{ \\\"categoryId\\\": \\\"12345678\\\" }\",\n  \"metaDescription\": \"{ \\\"metaDescription\\\": \\\"Learn how to reset your HubSpot account password.\\\" }\",\n  \"path\": \"{}{ \\\"path\\\": \\\"how-to-reset-your-password\\\" }\",\n  \"subtitle\": \"{ \\\"subtitle\\\": \\\"Step-by-step instructions\\\" }\",\n  \"tagIds\": \"{ \\\"tagIds\\\": [\\\"23456789\\\", \\\"34567890\\\"] }\",\n  \"title\": \"{ \\\"title\\\": \\\"How to reset your password\\\" }\",\n  \"translationOfId\": \"{ \\\"translationOfId\\\": \\\"98765432\\\" }\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

Knowledge base

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.

PATCH

cms

knowledge-base

2027-03-beta

articles

{articleId}

Update article

curl --request PATCH \
  --url https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
  "accessType": "{ \"accessType\": \"PUBLIC\" }",
  "archived": "{ \"archived\": true }",
  "archivedInDashboard": "{ \"archivedInDashboard\": false }",
  "body": "{ \"body\": \"<p>To reset your password, go to Settings > Security.</p>\" }{}",
  "categoryId": "{ \"categoryId\": \"12345678\" }",
  "metaDescription": "{ \"metaDescription\": \"Learn how to reset your HubSpot account password.\" }",
  "path": "{}{ \"path\": \"how-to-reset-your-password\" }",
  "subtitle": "{ \"subtitle\": \"Step-by-step instructions\" }",
  "tagIds": "{ \"tagIds\": [\"23456789\", \"34567890\"] }",
  "title": "{ \"title\": \"How to reset your password\" }",
  "translationOfId": "{ \"translationOfId\": \"98765432\" }"
}
'

import requests

url = "https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}"

payload = {
    "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
    "accessType": "{ \"accessType\": \"PUBLIC\" }",
    "archived": "{ \"archived\": true }",
    "archivedInDashboard": "{ \"archivedInDashboard\": false }",
    "body": "{ \"body\": \"<p>To reset your password, go to Settings > Security.</p>\" }{}",
    "categoryId": "{ \"categoryId\": \"12345678\" }",
    "metaDescription": "{ \"metaDescription\": \"Learn how to reset your HubSpot account password.\" }",
    "path": "{}{ \"path\": \"how-to-reset-your-password\" }",
    "subtitle": "{ \"subtitle\": \"Step-by-step instructions\" }",
    "tagIds": "{ \"tagIds\": [\"23456789\", \"34567890\"] }",
    "title": "{ \"title\": \"How to reset your password\" }",
    "translationOfId": "{ \"translationOfId\": \"98765432\" }"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessGroupIds: '{ "accessGroupIds": ["45678901"] }',
    accessType: '{ "accessType": "PUBLIC" }',
    archived: '{ "archived": true }',
    archivedInDashboard: '{ "archivedInDashboard": false }',
    body: JSON.stringify('{ "body": "<p>To reset your password, go to Settings > Security.</p>" }{}'),
    categoryId: '{ "categoryId": "12345678" }',
    metaDescription: '{ "metaDescription": "Learn how to reset your HubSpot account password." }',
    path: '{}{ "path": "how-to-reset-your-password" }',
    subtitle: '{ "subtitle": "Step-by-step instructions" }',
    tagIds: '{ "tagIds": ["23456789", "34567890"] }',
    title: '{ "title": "How to reset your password" }',
    translationOfId: '{ "translationOfId": "98765432" }'
  })
};

fetch('https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'accessGroupIds' => '{ "accessGroupIds": ["45678901"] }',
    'accessType' => '{ "accessType": "PUBLIC" }',
    'archived' => '{ "archived": true }',
    'archivedInDashboard' => '{ "archivedInDashboard": false }',
    'body' => '{ "body": "<p>To reset your password, go to Settings > Security.</p>" }{}',
    'categoryId' => '{ "categoryId": "12345678" }',
    'metaDescription' => '{ "metaDescription": "Learn how to reset your HubSpot account password." }',
    'path' => '{}{ "path": "how-to-reset-your-password" }',
    'subtitle' => '{ "subtitle": "Step-by-step instructions" }',
    'tagIds' => '{ "tagIds": ["23456789", "34567890"] }',
    'title' => '{ "title": "How to reset your password" }',
    'translationOfId' => '{ "translationOfId": "98765432" }'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}"

	payload := strings.NewReader("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"PUBLIC\\\" }\",\n  \"archived\": \"{ \\\"archived\\\": true }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": false }\",\n  \"body\": \"{ \\\"body\\\": \\\"<p>To reset your password, go to Settings > Security.</p>\\\" }{}\",\n  \"categoryId\": \"{ \\\"categoryId\\\": \\\"12345678\\\" }\",\n  \"metaDescription\": \"{ \\\"metaDescription\\\": \\\"Learn how to reset your HubSpot account password.\\\" }\",\n  \"path\": \"{}{ \\\"path\\\": \\\"how-to-reset-your-password\\\" }\",\n  \"subtitle\": \"{ \\\"subtitle\\\": \\\"Step-by-step instructions\\\" }\",\n  \"tagIds\": \"{ \\\"tagIds\\\": [\\\"23456789\\\", \\\"34567890\\\"] }\",\n  \"title\": \"{ \\\"title\\\": \\\"How to reset your password\\\" }\",\n  \"translationOfId\": \"{ \\\"translationOfId\\\": \\\"98765432\\\" }\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"PUBLIC\\\" }\",\n  \"archived\": \"{ \\\"archived\\\": true }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": false }\",\n  \"body\": \"{ \\\"body\\\": \\\"<p>To reset your password, go to Settings > Security.</p>\\\" }{}\",\n  \"categoryId\": \"{ \\\"categoryId\\\": \\\"12345678\\\" }\",\n  \"metaDescription\": \"{ \\\"metaDescription\\\": \\\"Learn how to reset your HubSpot account password.\\\" }\",\n  \"path\": \"{}{ \\\"path\\\": \\\"how-to-reset-your-password\\\" }\",\n  \"subtitle\": \"{ \\\"subtitle\\\": \\\"Step-by-step instructions\\\" }\",\n  \"tagIds\": \"{ \\\"tagIds\\\": [\\\"23456789\\\", \\\"34567890\\\"] }\",\n  \"title\": \"{ \\\"title\\\": \\\"How to reset your password\\\" }\",\n  \"translationOfId\": \"{ \\\"translationOfId\\\": \\\"98765432\\\" }\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"PUBLIC\\\" }\",\n  \"archived\": \"{ \\\"archived\\\": true }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": false }\",\n  \"body\": \"{ \\\"body\\\": \\\"<p>To reset your password, go to Settings > Security.</p>\\\" }{}\",\n  \"categoryId\": \"{ \\\"categoryId\\\": \\\"12345678\\\" }\",\n  \"metaDescription\": \"{ \\\"metaDescription\\\": \\\"Learn how to reset your HubSpot account password.\\\" }\",\n  \"path\": \"{}{ \\\"path\\\": \\\"how-to-reset-your-password\\\" }\",\n  \"subtitle\": \"{ \\\"subtitle\\\": \\\"Step-by-step instructions\\\" }\",\n  \"tagIds\": \"{ \\\"tagIds\\\": [\\\"23456789\\\", \\\"34567890\\\"] }\",\n  \"title\": \"{ \\\"title\\\": \\\"How to reset your password\\\" }\",\n  \"translationOfId\": \"{ \\\"translationOfId\\\": \\\"98765432\\\" }\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

Supported products

Required scopes

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

cms.knowledge_base.articles.publish

cms.knowledge_base.articles.write

cms.knowledge_base.settings.write

Path Parameters

articleId

string

required

The unique identifier of the article to update.

Body

application/json

accessGroupIds

object

required

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

Example:

"{ \"accessGroupIds\": [\"45678901\"] }"

accessType

object

required

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

Example:

"{ \"accessType\": \"PUBLIC\" }"

archived

object

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.

Example:

"{ \"archived\": true }"

archivedInDashboard

object

required

The visibility state for this article in the dashboard.

Example:

"{ \"archivedInDashboard\": false }"

body

object

required

The article’s HTML content.

Example:

"{ \"body\": \"<p>To reset your password, go to Settings > Security.</p>\" }{}"

categoryId

object

required

The ID of the category the article belongs to.

Example:

"{ \"categoryId\": \"12345678\" }"

metaDescription

object

required

A brief description of the article, used for SEO.

Example:

"{ \"metaDescription\": \"Learn how to reset your HubSpot account password.\" }"

path

object

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).

Example:

"{}{ \"path\": \"how-to-reset-your-password\" }"

subtitle

object

required

The subtitle of the article.

Example:

"{ \"subtitle\": \"Step-by-step instructions\" }"

tagIds

object

required

The IDs of tags associated with the article.

Example:

"{ \"tagIds\": [\"23456789\", \"34567890\"] }"

title

object

required

The title of the article.

Example:

"{ \"title\": \"How to reset your password\" }"

translationOfId

object

required

The ID of the article this is a translation of.

Example:

"{ \"translationOfId\": \"98765432\" }"

Response

default - */*

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.

Account & Settings

Automation

CMS

CRM

Data integration

Marketing

Meetings

Querying data

Reporting

Revenue

Webhooks journal

Update an article

Authorizations

Scopes

Path Parameters

Body

Response