Create an article - HubSpot docs

Create Article

curl --request POST \
  --url https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessGroupIds": [
    "<string>"
  ],
  "knowledgeBaseId": "<string>",
  "language": "<string>",
  "tagIds": [
    "<string>"
  ],
  "title": "<string>",
  "body": "<string>",
  "categoryId": "<string>",
  "metaDescription": "<string>",
  "path": "<string>",
  "subtitle": "<string>",
  "translationOfId": "<string>"
}
'

import requests

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

payload = {
    "accessGroupIds": ["<string>"],
    "knowledgeBaseId": "<string>",
    "language": "<string>",
    "tagIds": ["<string>"],
    "title": "<string>",
    "body": "<string>",
    "categoryId": "<string>",
    "metaDescription": "<string>",
    "path": "<string>",
    "subtitle": "<string>",
    "translationOfId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessGroupIds: ['<string>'],
    knowledgeBaseId: '<string>',
    language: '<string>',
    tagIds: ['<string>'],
    title: '<string>',
    body: JSON.stringify('<string>'),
    categoryId: '<string>',
    metaDescription: '<string>',
    path: '<string>',
    subtitle: '<string>',
    translationOfId: '<string>'
  })
};

fetch('https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accessGroupIds' => [
        '<string>'
    ],
    'knowledgeBaseId' => '<string>',
    'language' => '<string>',
    'tagIds' => [
        '<string>'
    ],
    'title' => '<string>',
    'body' => '<string>',
    'categoryId' => '<string>',
    'metaDescription' => '<string>',
    'path' => '<string>',
    'subtitle' => '<string>',
    'translationOfId' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"accessGroupIds\": [\n    \"<string>\"\n  ],\n  \"knowledgeBaseId\": \"<string>\",\n  \"language\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"categoryId\": \"<string>\",\n  \"metaDescription\": \"<string>\",\n  \"path\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"translationOfId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessGroupIds\": [\n    \"<string>\"\n  ],\n  \"knowledgeBaseId\": \"<string>\",\n  \"language\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"categoryId\": \"<string>\",\n  \"metaDescription\": \"<string>\",\n  \"path\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"translationOfId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessGroupIds\": [\n    \"<string>\"\n  ],\n  \"knowledgeBaseId\": \"<string>\",\n  \"language\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"categoryId\": \"<string>\",\n  \"metaDescription\": \"<string>\",\n  \"path\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"translationOfId\": \"<string>\"\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"
  }
}

POST

cms

knowledge-base

2027-03-beta

articles

Create Article

curl --request POST \
  --url https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessGroupIds": [
    "<string>"
  ],
  "knowledgeBaseId": "<string>",
  "language": "<string>",
  "tagIds": [
    "<string>"
  ],
  "title": "<string>",
  "body": "<string>",
  "categoryId": "<string>",
  "metaDescription": "<string>",
  "path": "<string>",
  "subtitle": "<string>",
  "translationOfId": "<string>"
}
'

import requests

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

payload = {
    "accessGroupIds": ["<string>"],
    "knowledgeBaseId": "<string>",
    "language": "<string>",
    "tagIds": ["<string>"],
    "title": "<string>",
    "body": "<string>",
    "categoryId": "<string>",
    "metaDescription": "<string>",
    "path": "<string>",
    "subtitle": "<string>",
    "translationOfId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessGroupIds: ['<string>'],
    knowledgeBaseId: '<string>',
    language: '<string>',
    tagIds: ['<string>'],
    title: '<string>',
    body: JSON.stringify('<string>'),
    categoryId: '<string>',
    metaDescription: '<string>',
    path: '<string>',
    subtitle: '<string>',
    translationOfId: '<string>'
  })
};

fetch('https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accessGroupIds' => [
        '<string>'
    ],
    'knowledgeBaseId' => '<string>',
    'language' => '<string>',
    'tagIds' => [
        '<string>'
    ],
    'title' => '<string>',
    'body' => '<string>',
    'categoryId' => '<string>',
    'metaDescription' => '<string>',
    'path' => '<string>',
    'subtitle' => '<string>',
    'translationOfId' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"accessGroupIds\": [\n    \"<string>\"\n  ],\n  \"knowledgeBaseId\": \"<string>\",\n  \"language\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"categoryId\": \"<string>\",\n  \"metaDescription\": \"<string>\",\n  \"path\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"translationOfId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.hubapi.com/cms/knowledge-base/2027-03-beta/articles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessGroupIds\": [\n    \"<string>\"\n  ],\n  \"knowledgeBaseId\": \"<string>\",\n  \"language\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"categoryId\": \"<string>\",\n  \"metaDescription\": \"<string>\",\n  \"path\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"translationOfId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accessGroupIds\": [\n    \"<string>\"\n  ],\n  \"knowledgeBaseId\": \"<string>\",\n  \"language\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"categoryId\": \"<string>\",\n  \"metaDescription\": \"<string>\",\n  \"path\": \"<string>\",\n  \"subtitle\": \"<string>\",\n  \"translationOfId\": \"<string>\"\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.

Body

application/json

accessGroupIds

string[]

required

An array of access group identifiers that can view the article. Each access group ID is a string. This property is required.

knowledgeBaseId

string

required

The unique identifier of the knowledge base where the article will be created. It is a string.

language

string

required

The language of the article. It is a string and is required.

tagIds

string[]

required

An array of tag identifiers associated with the article. Each tag ID is a string. This property is required.

title

string

required

The title of the article. It is a string and is required.

accessType

enum<string>

The access level for the article. It is a string and can be 'PUBLIC', 'SSO_LOGIN', or 'ACCESS_GROUP_MEMBERSHIP'.

Available options:

ACCESS_GROUP_MEMBERSHIP,

PUBLIC,

SSO_LOGIN

body

string

The main content of the article. It is a string.

categoryId

string

The unique identifier of the category to which the article belongs. It is a string.

metaDescription

string

A meta description for the article, used for SEO purposes. It is a string.

path

string

The URL path for the article. It is a string.

subtitle

string

An optional subtitle for the article. It is a string.

translationOfId

string

The unique identifier of the article of which this is a translation. It is a string.

Response

successful operation

accessGroupIds

string[]

required

accessType

enum<string>

required

Available options:

ACCESS_GROUP_MEMBERSHIP,

PUBLIC,

SSO_LOGIN

archivedInDashboard

boolean

required

createdAt

string<date-time>

required

string

required

knowledgeBaseId

string

required

language

string

required

path

string

required

state

enum<string>

required

Available options:

DRAFT,

PUBLISHED

tagIds

string[]

required

title

string

required

updatedAt

string<date-time>

required

url

string

required

body

string

categoryId

string

createdByUserId

string

initialPublishedAt

string<date-time>

metaDescription

string

position

integer<int32>

publishedAt

string<date-time>

subcategoryId

string

subtitle

string

translationOfId

string

translations

object

Show child attributes

updatedByUserId

string

Last modified on September 21, 2026