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.
The help center index defines the order in which article groups and articles appear in the help center navigation, as well as the parent-child relationships between them. updateHelpCenterIndex replaces the entire navigation tree in a single call. To avoid clobbering concurrent edits, you must include the hash returned by the previous helpCenterIndex query — if the help center has been re-indexed since you read it, the call will fail and you should re-fetch the latest index and re-apply your changes. Each entry references an existing article or article group by ID, and optionally a parent group ID to nest it within a group.
Mutation
mutation updateHelpCenterIndex($input: UpdateHelpCenterIndexInput!) {
  updateHelpCenterIndex(input: $input) {
    helpCenterIndex {
      helpCenterId
      hash
      navIndex {
        type
        id
        title
        slug
        parentId
        status
      }
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}
Variables
{
  "input": {
    "helpCenterId": "hc_01HXXXXXXXXXXXXXXXXXXXXXXX",
    "hash": "previous-hash-from-helpCenterIndex-query",
    "helpCenterIndex": [
      { "type": "ARTICLE_GROUP", "entityId": "hcag_01...", "parentId": null },
      { "type": "ARTICLE", "entityId": "hca_01...", "parentId": "hcag_01..." }
    ]
  }
}