Update a draft

Update draft

curl --request PATCH \
  --url https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
  "accessType": "{ \"accessType\": \"ACCESS_GROUP_MEMBERSHIP\" }",
  "archivedInDashboard": "{ \"archivedInDashboard\": true }",
  "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\" }"
}
'

import requests

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

payload = {
    "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
    "accessType": "{ \"accessType\": \"ACCESS_GROUP_MEMBERSHIP\" }",
    "archivedInDashboard": "{ \"archivedInDashboard\": true }",
    "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\" }"
}
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": "ACCESS_GROUP_MEMBERSHIP" }',
    archivedInDashboard: '{ "archivedInDashboard": true }',
    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" }'
  })
};

fetch('https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}/draft', 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}/draft",
  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": "ACCESS_GROUP_MEMBERSHIP" }',
    'archivedInDashboard' => '{ "archivedInDashboard": true }',
    '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" }'
  ]),
  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}/draft"

	payload := strings.NewReader("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"ACCESS_GROUP_MEMBERSHIP\\\" }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": true }\",\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}")

	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}/draft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"ACCESS_GROUP_MEMBERSHIP\\\" }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": true }\",\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}")
  .asString();

require 'uri'
require 'net/http'

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

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\\\": \\\"ACCESS_GROUP_MEMBERSHIP\\\" }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": true }\",\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}"

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

{
  "accessGroupIds": [
    "<string>"
  ],
  "accessType": "ACCESS_GROUP_MEMBERSHIP",
  "archivedInDashboard": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "knowledgeBaseId": "<string>",
  "language": "<string>",
  "path": "<string>",
  "state": "DRAFT",
  "tagIds": [
    "<string>"
  ],
  "title": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "body": "<string>",
  "categoryId": "<string>",
  "createdByUserId": "<string>",
  "initialPublishedAt": "2023-11-07T05:31:56Z",
  "metaDescription": "<string>",
  "position": 123,
  "publishedAt": "2023-11-07T05:31:56Z",
  "subcategoryId": "<string>",
  "subtitle": "<string>",
  "translationOfId": "<string>",
  "translations": {},
  "updatedByUserId": "<string>"
}

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

PATCH

cms

knowledge-base

2027-03-beta

articles

{articleId}

draft

Update draft

curl --request PATCH \
  --url https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
  "accessType": "{ \"accessType\": \"ACCESS_GROUP_MEMBERSHIP\" }",
  "archivedInDashboard": "{ \"archivedInDashboard\": true }",
  "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\" }"
}
'

import requests

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

payload = {
    "accessGroupIds": "{ \"accessGroupIds\": [\"45678901\"] }",
    "accessType": "{ \"accessType\": \"ACCESS_GROUP_MEMBERSHIP\" }",
    "archivedInDashboard": "{ \"archivedInDashboard\": true }",
    "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\" }"
}
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": "ACCESS_GROUP_MEMBERSHIP" }',
    archivedInDashboard: '{ "archivedInDashboard": true }',
    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" }'
  })
};

fetch('https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles/{articleId}/draft', 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}/draft",
  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": "ACCESS_GROUP_MEMBERSHIP" }',
    'archivedInDashboard' => '{ "archivedInDashboard": true }',
    '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" }'
  ]),
  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}/draft"

	payload := strings.NewReader("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"ACCESS_GROUP_MEMBERSHIP\\\" }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": true }\",\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}")

	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}/draft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessGroupIds\": \"{ \\\"accessGroupIds\\\": [\\\"45678901\\\"] }\",\n  \"accessType\": \"{ \\\"accessType\\\": \\\"ACCESS_GROUP_MEMBERSHIP\\\" }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": true }\",\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}")
  .asString();

require 'uri'
require 'net/http'

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

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\\\": \\\"ACCESS_GROUP_MEMBERSHIP\\\" }\",\n  \"archivedInDashboard\": \"{ \\\"archivedInDashboard\\\": true }\",\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}"

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

{
  "accessGroupIds": [
    "<string>"
  ],
  "accessType": "ACCESS_GROUP_MEMBERSHIP",
  "archivedInDashboard": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "knowledgeBaseId": "<string>",
  "language": "<string>",
  "path": "<string>",
  "state": "DRAFT",
  "tagIds": [
    "<string>"
  ],
  "title": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "body": "<string>",
  "categoryId": "<string>",
  "createdByUserId": "<string>",
  "initialPublishedAt": "2023-11-07T05:31:56Z",
  "metaDescription": "<string>",
  "position": 123,
  "publishedAt": "2023-11-07T05:31:56Z",
  "subcategoryId": "<string>",
  "subtitle": "<string>",
  "translationOfId": "<string>",
  "translations": {},
  "updatedByUserId": "<string>"
}

{
  "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 whose draft is to be updated.

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\": \"ACCESS_GROUP_MEMBERSHIP\" }"

archivedInDashboard

object

required

The visibility state for this article in the dashboard.

Example:

"{ \"archivedInDashboard\": true }"

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

Response

successful operation

accessGroupIds

string[]

required

The IDs of the access groups that have access to the article. Used when accessType is ACCESS_GROUP_MEMBERSHIP.

accessType

enum<string>

required

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

Available options:

ACCESS_GROUP_MEMBERSHIP,

PUBLIC,

SSO_LOGIN

archivedInDashboard

boolean

required

A boolean indicating whether the article is archived in the dashboard.

createdAt

string<date-time>

required

The date and time when the article was created, in ISO 8601 format.

string

required

The unique identifier for the knowledge article.

knowledgeBaseId

string

required

The unique identifier of the knowledge base to which this article belongs.

language

string

required

The article’s language, as an ISO 639 code (e.g. en).

path

string

required

The URL path segment for the article. Combined with the knowledge base’s domain, this forms the URL field.

state

enum<string>

required

The article’s state: either DRAFT or PUBLISHED.

Available options:

DRAFT,

PUBLISHED

tagIds

string[]

required

The IDs of the tags associated with the article.

title

string

required

The title of the knowledge article.

updatedAt

string<date-time>

required

The date and time when the article was last updated, in ISO 8601 format.

url

string

required

The full URL of the article.

body

string

The article’s HTML content. Only included when the request’s includeBody query parameter is true (which is the default value for the query).

categoryId

string

The ID of the category this article belongs to.

createdByUserId

string

The unique identifier of the user who created the article.

initialPublishedAt

string<date-time>

The date and time the article was first published, in ISO 8601 format. Absent if the article has never been published.

metaDescription

string

A brief description of the article, used for SEO.

position

integer<int32>

The position of the article within its category.

publishedAt

string<date-time>

The date and time the article was last published, in ISO 8601 format. Absent if the article has never been published.

subcategoryId

string

The subcategory this article belongs to.

subtitle

string

The subtitle of the knowledge article.

translationOfId

string

The ID of the article this is a translation of.

translations

object

A summary of the article’s translations, keyed by language code. Only included when the request’s includeTranslations query parameter is true (which is the default value for the query).

Show child attributes

updatedByUserId

string

The unique identifier of the user who last updated the article.

Last modified on September 28, 2026

Account & Settings

Automation

CMS

CRM

Data integration

Marketing

Meetings

Querying data

Reporting

Revenue

Webhooks journal

Authorizations

Scopes

Path Parameters

Body

Response