Skip to main content
PATCH
Update article

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:
tags
string[]

Array of tag IDs

Example:
addToCollections
string[]

Collections to add this article to

Example:
removeFromCollections
string[]

Collections to remove this article from

Example:
meta
object

Meta information for SEO

Example:

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:
tags
string[]
required
Example:
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:
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:
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:
collections
string[]
Example: