## knowledgeBaseTopicsAdd **Type:** GraphQL mutations **Description:** Create a new knowledge base topic. ### Arguments - doc (KnowledgeBaseTopicDoc, Not Null): undefined - code (String): Unique code identifier. - title (String): The topic title (required). - description (String): Description of the topic. - categoryIds (String): Category IDs to include in this topic. - color (String) - backgroundImage (String): Background image URL. - languageCode (String): ISO language code. ### Response **Type:** KnowledgeBaseTopic **Description:** A knowledge base topic — the top-level organizational unit. Topics are associated with a brand and contain categories of articles. They can be styled with custom colors and background images. #### Fields - _id (String) - code (String): Unique code identifier for programmatic access. - title (String): The topic title. - description (String): Description of the topic. - categories (KnowledgeBaseCategory): Categories within this topic. - workspace (Workspace) - color (String) - backgroundImage (String): URL of the background image for the topic page. - languageCode (String): ISO language code for the topic content (e.g. 'en', 'ar'). - createdBy (String): User ID of the topic creator. - createdDate (Date): When this topic was created. - modifiedBy (String): User ID of the last modifier. - modifiedDate (Date): When this topic was last modified. - parentCategories (KnowledgeBaseParentCategory): Top-level parent categories within this topic. --- ## knowledgeBaseTopicsEdit **Type:** GraphQL mutations **Description:** Update an existing knowledge base topic. ### Arguments - _id (String) - doc (KnowledgeBaseTopicDoc, Not Null): undefined - code (String): Unique code identifier. - title (String): The topic title (required). - description (String): Description of the topic. - categoryIds (String): Category IDs to include in this topic. - color (String) - backgroundImage (String): Background image URL. - languageCode (String): ISO language code. ### Response **Type:** KnowledgeBaseTopic **Description:** A knowledge base topic — the top-level organizational unit. Topics are associated with a brand and contain categories of articles. They can be styled with custom colors and background images. #### Fields - _id (String) - code (String): Unique code identifier for programmatic access. - title (String): The topic title. - description (String): Description of the topic. - categories (KnowledgeBaseCategory): Categories within this topic. - workspace (Workspace) - color (String) - backgroundImage (String): URL of the background image for the topic page. - languageCode (String): ISO language code for the topic content (e.g. 'en', 'ar'). - createdBy (String): User ID of the topic creator. - createdDate (Date): When this topic was created. - modifiedBy (String): User ID of the last modifier. - modifiedDate (Date): When this topic was last modified. - parentCategories (KnowledgeBaseParentCategory): Top-level parent categories within this topic. --- ## knowledgeBaseTopicsRemove **Type:** GraphQL mutations **Description:** Delete a knowledge base topic and disassociate its categories. ### Arguments - _id (String) ### Response **Type:** JSON --- ## knowledgeBaseCategoriesAdd **Type:** GraphQL mutations **Description:** Create a new knowledge base category. ### Arguments - doc (KnowledgeBaseCategoryDoc, Not Null): undefined - code (String): Unique code identifier. - title (String): The category title (required). - description (String): Description of what this category covers. - articleIds (String): Article IDs to include in this category. - icon (String): Icon identifier (required). - topicIds (String): Topic IDs this category belongs to. - topicId (String): Primary topic ID. - parentCategoryId (String): Parent category ID for nesting. ### Response **Type:** KnowledgeBaseCategory **Description:** A category that groups related knowledge base articles together. Categories can be nested under parent categories for hierarchical organization. #### Fields - _id (String) - code (String): Unique code identifier for programmatic access. - title (String): The category title. - description (String): Description of what this category covers. - articles (KnowledgeBaseArticle): Articles in this category, optionally filtered by status. - icon (String): Icon identifier for the category. - createdBy (String): User ID of the category creator. - createdDate (Date): When this category was created. - modifiedBy (String): User ID of the last modifier. - modifiedDate (Date): When this category was last modified. - parentCategoryId (String): Parent category ID for nested categorization. - firstTopic (KnowledgeBaseTopic): The first topic this category belongs to. - authors (User): Users who have authored articles in this category. - numOfArticles (Float): Count of articles in this category, optionally filtered by status. - countArticles (Int): Total article count in this category. --- ## knowledgeBaseCategoriesEdit **Type:** GraphQL mutations **Description:** Update an existing knowledge base category. ### Arguments - _id (String) - doc (KnowledgeBaseCategoryDoc, Not Null): undefined - code (String): Unique code identifier. - title (String): The category title (required). - description (String): Description of what this category covers. - articleIds (String): Article IDs to include in this category. - icon (String): Icon identifier (required). - topicIds (String): Topic IDs this category belongs to. - topicId (String): Primary topic ID. - parentCategoryId (String): Parent category ID for nesting. ### Response **Type:** KnowledgeBaseCategory **Description:** A category that groups related knowledge base articles together. Categories can be nested under parent categories for hierarchical organization. #### Fields - _id (String) - code (String): Unique code identifier for programmatic access. - title (String): The category title. - description (String): Description of what this category covers. - articles (KnowledgeBaseArticle): Articles in this category, optionally filtered by status. - icon (String): Icon identifier for the category. - createdBy (String): User ID of the category creator. - createdDate (Date): When this category was created. - modifiedBy (String): User ID of the last modifier. - modifiedDate (Date): When this category was last modified. - parentCategoryId (String): Parent category ID for nested categorization. - firstTopic (KnowledgeBaseTopic): The first topic this category belongs to. - authors (User): Users who have authored articles in this category. - numOfArticles (Float): Count of articles in this category, optionally filtered by status. - countArticles (Int): Total article count in this category. --- ## knowledgeBaseCategoriesRemove **Type:** GraphQL mutations **Description:** Delete a knowledge base category and unlink its articles. ### Arguments - _id (String) ### Response **Type:** JSON --- ## knowledgeBaseArticlesAdd **Type:** GraphQL mutations **Description:** Create a new knowledge base article. ### Arguments - doc (KnowledgeBaseArticleDoc, Not Null): undefined - code (String): Unique code identifier. - title (String): The article title (required). - summary (String): Brief summary or excerpt. - content (String): Full article content in HTML (required). - status (String): Publication status: 'draft', 'publish', or 'scheduled' (required). - isPrivate (Boolean): Whether this article is only visible to team members. - reactionChoices (String): Available emoji reaction types. - categoryIds (String): Category IDs to assign this article to. - topicId (String): The topic this article belongs to. - categoryId (String): The primary category this article belongs to. - image (AttachmentInput): Featured image for the article. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - attachments (AttachmentInput): File attachments. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - pdfAttachment (PdfAttachmentInput): PDF attachment with page images. - pdf (AttachmentInput): The full PDF file. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput) - pages (AttachmentInput): Individual page images for the PDF. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput) - scheduledDate (Date): Scheduled publication date. - forms (FormCodeInput): Forms to embed in this article. - workspaceId (String) - formId (String) ### Response **Type:** KnowledgeBaseArticle **Description:** A knowledge base article containing help content, documentation, or guides. Articles belong to categories within topics and support rich content, attachments, and reactions. #### Fields - _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. --- ## knowledgeBaseArticlesEdit **Type:** GraphQL mutations **Description:** Update an existing knowledge base article. ### Arguments - _id (String) - doc (KnowledgeBaseArticleDoc, Not Null): undefined - code (String): Unique code identifier. - title (String): The article title (required). - summary (String): Brief summary or excerpt. - content (String): Full article content in HTML (required). - status (String): Publication status: 'draft', 'publish', or 'scheduled' (required). - isPrivate (Boolean): Whether this article is only visible to team members. - reactionChoices (String): Available emoji reaction types. - categoryIds (String): Category IDs to assign this article to. - topicId (String): The topic this article belongs to. - categoryId (String): The primary category this article belongs to. - image (AttachmentInput): Featured image for the article. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - attachments (AttachmentInput): File attachments. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput): undefined - latitude (Float) - longitude (Float) - name (String) - address (String) - pdfAttachment (PdfAttachmentInput): PDF attachment with page images. - pdf (AttachmentInput): The full PDF file. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput) - pages (AttachmentInput): Individual page images for the PDF. - url (String) - name (String) - type (String) - size (Float) - duration (Float) - locationData (LocationDataInput) - scheduledDate (Date): Scheduled publication date. - forms (FormCodeInput): Forms to embed in this article. - workspaceId (String) - formId (String) ### Response **Type:** KnowledgeBaseArticle **Description:** A knowledge base article containing help content, documentation, or guides. Articles belong to categories within topics and support rich content, attachments, and reactions. #### Fields - _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. --- ## knowledgeBaseArticlesRemove **Type:** GraphQL mutations **Description:** Delete a knowledge base article. ### Arguments - _id (String) ### Response **Type:** JSON