Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.plain.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Using TypeScript? Check out our GraphQL SDK for a fully typed client.
Article groups are folders that organise articles in the help center navigation. Groups can be nested by setting parentHelpCenterArticleGroupId when creating a sub-group.

​
Create an article group

Mutation
mutation createHelpCenterArticleGroup($input: CreateHelpCenterArticleGroupInput!) {
  createHelpCenterArticleGroup(input: $input) {
    helpCenterArticleGroup {
      id
      name
      slug
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}
Variables
{
  "input": {
    "helpCenterId": "hc_01HXXXXXXXXXXXXXXXXXXXXXXX",
    "name": "Getting started",
    "slug": "getting-started"
  }
}

​
Update an article group

Mutation
mutation updateHelpCenterArticleGroup($input: UpdateHelpCenterArticleGroupInput!) {
  updateHelpCenterArticleGroup(input: $input) {
    helpCenterArticleGroup {
      id
      name
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}
Variables
{
  "input": {
    "helpCenterArticleGroupId": "hcag_01HXXXXXXXXXXXXXXXXXXXXXXX",
    "name": "Getting started"
  }
}

​
Delete an article group

Deleting an article group leaves its articles intact — they are simply un-grouped. To remove an article entirely use deleteHelpCenterArticle.
Mutation
mutation deleteHelpCenterArticleGroup($input: DeleteHelpCenterArticleGroupInput!) {
  deleteHelpCenterArticleGroup(input: $input) {
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}
Variables
{
  "input": {
    "helpCenterArticleGroupId": "hcag_01HXXXXXXXXXXXXXXXXXXXXXXX"
  }
}