Skip to main content
PATCH
/
articles
/
{permalink_id}
Update article
curl --request PATCH \
  --url https://{your-workspace}.neetokb.com/api/external/v1/articles/{permalink_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "title": "Getting Started",
  "state": "draft",
  "html_content": "<h1>Welcome</h1><p>Example content</p>",
  "slug": "getting-started",
  "page_title": "Getting Started",
  "meta_description": "A comprehensive guide to help you get started with our platform"
}
'
{
  "message": "<string>"
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

​
permalink_id
string
required

Unique identifier of the article. Refer to the NeetoKB help article for detailed instructions.

Example:

"a-84af178b"

Body

application/json
​
title
string

Title of the article.

Example:

"Getting Started"

​
state
enum<string>

Status of the article.

Available options:
draft,
published
Example:

"draft"

​
html_content
string

Content of the article in HTML format.

Example:

"<h1>Welcome</h1><p>Example content</p>"

​
slug
string

URL-friendly version of the article's title. Can only be modified if the article's state is published.

Example:

"getting-started"

​
page_title
string

Title of the page (used for SEO). Can only be modified if the article's state is published.

Example:

"Getting Started"

​
meta_description
string

Description of the article's content (used for SEO). Can only be modified if the article's state is published.

Example:

"A comprehensive guide to help you get started with our platform"

Response

200 - application/json

OK - Request succeeded

​
message
string