---
updatedAt: 2025-05-19T14:05:15.000Z
agentTools:
  siteIndex: https://developers.klaxoon.com/llms.txt
  projectIndex: https://developers.klaxoon.com/klaxoon/llms.txt
---

# Create board

### Required scope

[board:write](/docs/scopes)

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "contact": {
      "email": "contact@klaxoon.com"
    },
    "description": "API Board",
    "title": "Board",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.klaxoon.com",
      "description": "First version of API"
    }
  ],
  "tags": [
    {
      "name": "Board"
    }
  ],
  "paths": {
    "/v1/boards": {
      "post": {
        "operationId": "V1BoardPost",
        "tags": [
          "Board"
        ],
        "summary": "Create board",
        "description": "",
        "requestBody": {
          "$ref": "#/components/requestBodies/BoardBody"
        },
        "security": [
          {
            "oauth2": []
          }
        ],
        "responses": {
          "201": {
            "description": "Operation success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BoardRead"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "default": {
            "$ref": "#/components/responses/Default"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "oauth2": {
        "flows": {},
        "type": "oauth2"
      }
    },
    "requestBodies": {
      "BoardBody": {
        "description": "",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/BoardWrite"
            }
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "Bad Request"
                    },
                    "detail": {
                      "example": "Expecting a string, got number."
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Unauthorized": {
        "description": "The user is not authorized to access this resource",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "No valid authentication provided."
                    },
                    "detail": {
                      "example": "The user is not authorized to access to this resource."
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Forbidden": {
        "description": "The user does not have the required permissions to access this resource",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "You do not have access to this resource."
                    },
                    "detail": {
                      "example": "You tried to access to a resource that does not belong to you"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Default": {
        "description": "Operation in error",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "schemas": {
      "Board": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "89a17345-f49b-4b4f-9626-bccec224db92",
            "readOnly": true
          },
          "href": {
            "description": "API resource URL for the board",
            "type": "string",
            "example": "https://api.klaxoon.com/v1/boards/89a17345-f49b-4b4f-9626-bccec224db92",
            "readOnly": true
          },
          "type": {
            "description": "Type of the activity",
            "type": "string",
            "example": "board",
            "readOnly": true
          },
          "title": {
            "description": "Title for the board",
            "type": "string",
            "example": "My first board",
            "maxLength": 250
          },
          "description": {
            "description": "Description for the board",
            "type": "string",
            "nullable": true,
            "example": "My awesome board"
          },
          "accessCode": {
            "description": "Share the access code with participants so they can go directly to the Board (only available on published board)",
            "type": "string",
            "nullable": true,
            "example": null,
            "readOnly": true
          },
          "state": {
            "description": "Current board state (draft | published | closed)",
            "type": "string",
            "example": "draft",
            "readOnly": true
          },
          "author": {
            "readOnly": true,
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  }
                },
                "required": [
                  "id"
                ]
              }
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "BoardWrite": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Board"
          },
          {
            "required": [
              "title"
            ]
          }
        ]
      },
      "BoardRead": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Board"
          },
          {
            "required": [
              "id",
              "href",
              "type",
              "title",
              "description",
              "state",
              "author",
              "createdAt",
              "updatedAt"
            ]
          }
        ]
      },
      "Error": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference [RFC3986] that identifies the\nproblem type.  This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]).  When\nthis member is not present, its value is assumed to be\n\"about:blank\".\n",
            "example": "about:blank"
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem\ntype.  It SHOULD NOT change from occurrence to occurrence of the\nproblem, except for purposes of localization (e.g., using\nproactive content negotiation; see [RFC7231], Section 3.4).\n",
            "example": "Bad Request"
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
            "example": "Expecting a string, got number."
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific\noccurrence of the problem.  It may or may not yield further\ninformation if dereferenced.\n",
            "example": "/138d9bea-4edf-4e9c-86f7-43672e42c5dc"
          }
        },
        "required": [
          "type",
          "title"
        ]
      }
    }
  }
}
```