Skip to main content
MUTATION
knowledgeBaseArticlesEdit(_id: String!, doc: KnowledgeBaseArticleDoc!): KnowledgeBaseArticle

Arguments

_id
String!
required
doc
KnowledgeBaseArticleDoc!
required

Returns

KnowledgeBaseArticle
_id
String!
code
String

Unique code identifier for programmatic access.

title
String

The article title.

summary
String

Brief summary or excerpt of the article content.

content
String

Full article content (HTML).

status
String

Publication status: 'draft', 'publish', or 'scheduled'.

isPrivate
Boolean

Whether this article is only visible to team members.

reactionChoices
[String]

Available emoji reaction types for this article.

reactionCounts
JSON

Count of each reaction type received.

createdBy
String

User ID of the article creator.

createdUser
User

The resolved user who created this article.

createdDate
Date

When this article was created.

modifiedBy
String

User ID of the last modifier.

modifiedDate
Date

When this article was last modified.

topicId
String

The topic this article belongs to.

categoryId
String

The category this article belongs to.

viewCount
Int

Total number of times this article has been viewed.

attachments
[Attachment]

File attachments included with this article.

image
Attachment

Featured image for the article.

pdfAttachment
PdfAttachment

PDF attachment with extracted page images.

publishedUserId
String

User ID of who published this article.

publishedUser
User

The resolved user who published this article.

scheduledDate
Date

Scheduled publication date (for status 'scheduled').

forms
[FormCode]

Forms embedded in this article.

Mutation
Variables
Response
Last modified on August 8, 2026

Related topics

KnowledgeBaseArticleknowledgeBaseArticlesknowledgeBaseArticlesRemoveKnowledgeBaseArticlesPaginatedknowledgeBaseArticlesAdd