Configure Idea Status Settings Using GraphQL

How to set Idea Status configurations for your community using the GraphQL API.

Aurora's Ideas feature is a great way to leverage your community to generate feedback and suggestions to help your products and services improve over time. These suggestions are tracked within an Idea board using several different status designations.

An Idea Status represents the present state of a user's Idea in the Aurora community. The settings for these statuses are accessible through the GraphQL API and can be set at the node level.

Warning
Only Administrators and Moderators can query or configure these settings.

Aurora's GraphQL API enables you to configure the status settings for an Ideas board using the setIdeaStatusSettingsOnNode mutation. This mutation and its included fields tell Aurora which Idea board you want to configure and which Idea-specific status settings you wish to update.

In this example, we will configure the status settings for the Idea board idea1.

mutation {
  setIdeaStatusSettingsOnNode(
    nodeId: "board:idea1",
    settingsInput: {
      isIdeaStatusEnabled: false,
      stopVotesOnClosedIdeas: true,
      defaultStatusValue: "new"
    }
  ) {
    result
    errors {
      ... on Error{
        message
      }
    }
  }
}

In this example, we have indicated the target Idea board by its nodeId and configured its status properties using the settingsInput object. We've made three changes to the settings of the Idea board:

• isIdeaStatusEnabled: If the boolean value is set to true, the idea status feature is turned on for the Idea Board.
• stopVotesOnClosedIdeas: If the boolean value is set to true, voting ends when an Idea is closed.
• defaultStatusValue: The value of this string is the default Idea status value for any new ideas added to the board.

The API's response should look like the following if the mutation is successful:

{
  "data": {
    "setIdeaStatusSettingsOnNode": {
      "result": true,
      "errors": null
    }
  }
}