Articles can be added to:

1. Guides
2. Chapters

Note: You can add up to 500 guides, chapters, and articles. Contact Support to update the limit.

To add your KB articles under a guide, use the addArticlesToGuide mutation.

Fields

Use the below fields to add KB articles to a guide.

Field	Description	Required
ids	The ID of the KB articles to add to a guide ID. You can add multiple article IDs.	Required
guideId	The guide ID where you want to add the articles	Required

Example

To add an article (UID: 10412) to your guide (ID: 598) in the "KB board: AIBoard", use the addArticlesToGuide mutation.

mutation {
  addArticlesToGuide(ids: ["message:10412"], guideId: "guide:598") {
    result {
      existingArticles
    }
    errors {
      __typename
      ... on AddArticleError {
        fields
        message
      }
      ... on PermissionDeniedError {
        fields
        message
      }
      ... on UnsupportedConversationStyleError {
        fields
        message
      }
      ... on GuideNotEnabledError {
        fields
        message
      }
      ... on InvalidGuideError {
        fields
        message
      }
      ... on InvalidArticleError {
        fields
        message
      }
      ... on MaximumEntriesAdded {
        fields
        message
      }
    }
  }
}

GraphQL response:

{
  "data": {
    "addArticlesToGuide": {
      "result": {
        "existingArticles": []
      },
      "errors": null
    }
  }
}

Adding an Article to a Chapter

To add your KB articles under a chapter, use the addArticlesToChapter mutation.

Fields

Use the below fields to add KB articles to a chapter.

Field	Description	Required
ids	The ID of the KB articles to add to a chapter ID. You can add multiple article IDs.	Required
chapterId	The chapter ID where you want to add the articles	Required

Example

To add articles (UID: 11941, 11885) to your parent chapter (ID: 154) in the "KB board: AIBoard", use the addArticlesToChapter mutation.

mutation {
  addArticlesToChapter(ids: ["message:11941", "message:11885"], chapterId: "chapter:154") {
    result {
      addedArticles
      existingArticles
    }
    errors {
      __typename
      ... on AddArticleError {
        fields
        message
      }
      ... on PermissionDeniedError {
        fields
        message
      }
      ... on UnsupportedConversationStyleError {
        fields
        message
      }
      ... on GuideNotEnabledError {
        fields
        message
      }
      ... on InvalidChapterError {
        fields
        message
      }
      ... on InvalidArticleError {
        fields
        message
      }
      ... on MaximumEntriesAdded {
        fields
        message
      }
    }
  }
}

GraphQL response:

{
  "data": {
    "addArticlesToChapter": {
      "result": {
        "addedArticles": [
          "message:11941",
          "message:11885"
        ],
        "existingArticles": []
      },
      "errors": null
    }
  }
}