PATCH
/
articles
/
{articleId}
Update article
curl --request PATCH \
  --url https://helpcenter.thena.ai/articles/{articleId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "title": "Getting Started Guide",
  "description": "Learn how to get started with our platform features",
  "slug": "getting-started-guide",
  "authors": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ],
  "tags": [
    "507f1f77bcf86cd799439013",
    "507f1f77bcf86cd799439014"
  ],
  "addToCollections": [
    "507f1f77bcf86cd799439015",
    "507f1f77bcf86cd799439016"
  ],
  "removeFromCollections": [
    "507f1f77bcf86cd799439017",
    "507f1f77bcf86cd799439018"
  ],
  "meta": {
    "title": "SEO Title",
    "description": "SEO Description",
    "image": "https://example.com/image.jpg"
  }
}'
{
  "_id": "682c3cb454561efcea641c8c",
  "orgId": "EWWESHH5ED",
  "uid": 4275918855,
  "title": "Getting Started Guide",
  "description": "A comprehensive guide to get started",
  "slug": "8588462216-getting-started-guide",
  "state": "draft",
  "authors": [
    "UWW7PBBOPJ"
  ],
  "tags": [
    "667d37bd1e87838451261acb",
    "667d37bd1e87838451261acb"
  ],
  "visibility": "public",
  "createdBy": "UWW7PBBOPJ",
  "isAuthorManuallyUpdated": false,
  "isDeleted": false,
  "images": [
    "48b6750b-0287-4bed-a09b-87977a3adf46"
  ],
  "openaiFileId": "file-oM98KvbyEnEtslwh4bWiyrzu",
  "lastEditedBy": "UWW7PBBOPJ",
  "lastEditedAt": "2025-05-19T08:26:28.556Z",
  "isUpdateRequired": false,
  "objectIds": [],
  "isAiGenerated": false,
  "meta": {
    "title": null,
    "description": null,
    "image": null
  },
  "createdAt": "2025-05-19T08:26:28.561Z",
  "updatedAt": "2025-05-19T08:26:28.561Z",
  "editorArticleName": "EWWESHH5ED_682c3cb454561efcea641c8c",
  "jwtSignedToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "aiToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "publishedVersion": {
    "json": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":\"left\"},\"content\":[{\"type\":\"text\",\"text\":\"Hey test\"}]}]}",
    "html": "<p>Hey test</p>",
    "version": 0,
    "publishedBy": "667d37bd1e87838451261acb",
    "publishedAt": "2024-11-20T12:08:22.583Z"
  },
  "helpCenters": [
    "671a2ddbccca6b1c3dc0d3b6"
  ],
  "collections": [
    "671b856c19d8f51c01c0d293"
  ]
}

Authorizations

​
x-api-key
string
header
required

Enter your API key

Path Parameters

​
articleId
string
required

Article ID

Example:

"507f1f77bcf86cd799439011"

Body

application/json
​
title
string

Updated title of the article

Example:

"Getting Started Guide"

​
description
string

Article description

Example:

"Learn how to get started with our platform features"

​
slug
string

URL-friendly slug for the article

Example:

"getting-started-guide"

​
authors
string[]

Array of author IDs

Example:
[
  "507f1f77bcf86cd799439011",
  "507f1f77bcf86cd799439012"
]
​
tags
string[]

Array of tag IDs

Example:
[
  "507f1f77bcf86cd799439013",
  "507f1f77bcf86cd799439014"
]
​
addToCollections
string[]

Collections to add this article to

Example:
[
  "507f1f77bcf86cd799439015",
  "507f1f77bcf86cd799439016"
]
​
removeFromCollections
string[]

Collections to remove this article from

Example:
[
  "507f1f77bcf86cd799439017",
  "507f1f77bcf86cd799439018"
]
​
meta
object

Meta information for SEO

Example:
{
  "title": "SEO Title",
  "description": "SEO Description",
  "image": "https://example.com/image.jpg"
}

Response

Article updated successfully

​
_id
string
required
Example:

"682c3cb454561efcea641c8c"

​
orgId
string
required
Example:

"EWWESHH5ED"

​
uid
number
required
Example:

4275918855

​
title
string
required
Example:

"Getting Started Guide"

​
description
string
required
Example:

"A comprehensive guide to get started"

​
slug
string
required
Example:

"8588462216-getting-started-guide"

​
state
enum<string>
required
Available options:
draft,
published
Example:

"draft"

​
authors
string[]
required
Example:
["UWW7PBBOPJ"]
​
tags
string[]
required
Example:
[
  "667d37bd1e87838451261acb",
  "667d37bd1e87838451261acb"
]
​
visibility
enum<string>
required
Available options:
public,
private,
customer
Example:

"public"

​
createdBy
string
required
Example:

"UWW7PBBOPJ"

​
isAuthorManuallyUpdated
boolean
required
Example:

false

​
isDeleted
boolean
required
Example:

false

​
images
string[]
required
Example:
["48b6750b-0287-4bed-a09b-87977a3adf46"]
​
openaiFileId
string
required
Example:

"file-oM98KvbyEnEtslwh4bWiyrzu"

​
lastEditedBy
string
required
Example:

"UWW7PBBOPJ"

​
lastEditedAt
string
required
Example:

"2025-05-19T08:26:28.556Z"

​
isUpdateRequired
boolean
required
Example:

false

​
objectIds
string[]
required
Example:
[]
​
isAiGenerated
boolean
required
Example:

false

​
meta
object
required
Example:
{
  "title": null,
  "description": null,
  "image": null
}
​
createdAt
string
required
Example:

"2025-05-19T08:26:28.561Z"

​
updatedAt
string
required
Example:

"2025-05-19T08:26:28.561Z"

​
editorArticleName
string
required
Example:

"EWWESHH5ED_682c3cb454561efcea641c8c"

​
jwtSignedToken
string
required
Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
aiToken
string
required
Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
publishedVersion
object
​
helpCenters
string[]
Example:
["671a2ddbccca6b1c3dc0d3b6"]
​
collections
string[]
Example:
["671b856c19d8f51c01c0d293"]