Board Mutations

Update Board

Updates the configuration and settings of your board. This mutation requires authentication via an API key in the headers.

Mutation Structure

mutation UpdateBoard(
  $name: String
  $description: String
  $domain: String
  $faviconUrl: String
  $headerLink: String
  $isRoadmapEnabled: Boolean
  $locale: String
  $logoUrl: String
) {
  updateBoard(
    name: $name
    description: $description
    domain: $domain
    faviconUrl: $faviconUrl
    headerLink: $headerLink
    isRoadmapEnabled: $isRoadmapEnabled
    locale: $locale
    logoUrl: $logoUrl
  ) {
    id
    name
    description
    domain
    faviconUrl
    headerLink
    isRoadmapEnabled
    locale
    logoUrl
  }
}

Input Fields

All fields are optional. Only include the fields you want to update.

Field	Type	Description
name	String	Name of the board
description	String	Description of the board
domain	String	Custom domain field for your board
faviconUrl	String	URL of the board favicon
headerLink	String	URL of the board header link
isRoadmapEnabled	Boolean	Whether the roadmap is enabled
locale	String	Locale of the board (e.g., en-US)
logoUrl	String	URL of the board logo

Example

mutation {
  updateBoard(
    name: "Updated Product Feedback"
    description: "New description for our feedback board"
    isRoadmapEnabled: true
  ) {
    id
    name
    description
    isRoadmapEnabled
  }
}

Example Response:

{
  "data": {
    "updateBoard": {
      "id": "board_123",
      "name": "Updated Product Feedback",
      "description": "New description for our feedback board",
      "isRoadmapEnabled": true
    }
  }
}

Authentication

This mutation requires authentication. You must include your API key in the HTTP headers:

{
  "apikey": "YOUR_API_KEY"
}

You can also make requests using curl:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "apikey: YOUR_API_KEY" \
  -d "query" \
  https://api.nolt.io/api/v1/graphql

Error Handling

The mutation may return errors in the following cases:

• Invalid API key or missing authentication
• Invalid input values (e.g., invalid locale format)
• Server-side validation failures

Example error response:

{
  "errors": [
    {
      "message": "Invalid locale format. Expected format: xx-XX",
      "path": ["updateBoard"]
    }
  ]
}