--- 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 idea Add an idea to a 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 Idea" } ], "paths": { "/v1/boards/{boardId}/ideas": { "post": { "operationId": "V1BoardIdeaPost", "tags": [ "Board Idea" ], "summary": "Create board idea", "description": "Add an idea to a board\n", "requestBody": { "$ref": "#/components/requestBodies/BoardIdeaBody" }, "parameters": [ { "name": "boardId", "description": "Unique identifier for the board where you want to create the idea.", "in": "path", "required": true, "schema": { "type": "string", "example": "7ab61497-6dfb-45b1-94e1-f1ba7def0c02" }, "style": "simple" } ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "Operation success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardIdea" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "default": { "$ref": "#/components/responses/Default" } } } } }, "components": { "securitySchemes": { "oauth2": { "flows": {}, "type": "oauth2" } }, "requestBodies": { "BoardIdeaBody": { "description": "Create a Board Idea", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBoardIdea" }, { "required": [ "content" ] } ] } } } } }, "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" } } } ] } } } }, "NotFound": { "description": "The resource does not exists.", "content": { "application/problem+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "title": { "example": "Not Found" }, "detail": { "example": "" } } } ] } } } }, "Default": { "description": "Operation in error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "CreateBoardIdea": { "type": "object", "properties": { "position": { "allOf": [ { "nullable": true, "description": "Not setting a position will put the Idea in [Inbox](https://help.klaxoon.com/hc/en-us/articles/360002766457-Facilitate-a-Board)" }, { "$ref": "#/components/schemas/ObjectPosition" } ] }, "data": { "type": "object", "properties": { "content": { "type": "string", "maxLength": 500 }, "color": { "type": "object", "properties": { "id": { "type": "string", "example": "ID of the color" } }, "required": [ "id" ] }, "category": { "type": "object", "properties": { "id": { "type": "string", "example": "ID of the category" } }, "required": [ "id" ] }, "dimensions": { "type": "array", "description": "List of dimensions that you want to fill in.", "maximum": 3, "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ID of the current dimension", "description": "Dimension unique identifier on the current board.\n" }, "value": { "type": "string", "example": "Short text for the targeted dimension", "maxLength": 250, "description": "A short text to add context about the idea.\n" } }, "required": [ "id", "value" ] } } } } } }, "BoardIdea": { "allOf": [ { "type": "object", "properties": { "position": { "description": "A null position indicates an Idea in the [Inbox](https://help.klaxoon.com/hc/en-us/articles/360002766457-Facilitate-a-Board)", "nullable": true } } }, { "$ref": "#/components/schemas/BoardObject" }, { "type": "object", "properties": { "type": { "type": "string", "example": "IDEA" }, "data": { "type": "object", "properties": { "content": { "type": "string", "maxLength": 500 }, "color": { "allOf": [ { "$ref": "#/components/schemas/HttpLink" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Color unique identifier on the current board.\n" } }, "required": [ "id" ] } ] }, "category": { "allOf": [ { "$ref": "#/components/schemas/HttpLink" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Category unique identifier on the current board.\n" } }, "required": [ "id" ] } ] }, "dimensions": { "type": "array", "description": "List of dimensions that you want to fill in.", "items": { "allOf": [ { "$ref": "#/components/schemas/HttpLink" }, { "type": "object", "properties": { "id": { "type": "string", "example": "ID of the current dimension", "description": "Dimension unique identifier on the current board.\n" }, "href": { "type": "string", "format": "uri" }, "value": { "type": "string", "example": "Short text for the targeted dimension", "maxLength": 250, "description": "A short text to add context about the idea.\n" } } } ], "required": [ "id", "value" ] } }, "format": { "type": "string", "description": "Visual format of the idea. It can be either set to auto or a square.\n", "enum": [ "auto", "square" ] } } } } } ] }, "ObjectPosition": { "type": "object", "description": "Default position will be **(x: 0, y: 0, z: 1)**.\n", "properties": { "x": { "type": "number", "description": "X-axis coordinate on the board" }, "y": { "type": "number", "description": "Y-axis coordinate on the board" }, "z": { "type": "integer", "description": "Z-index on the board", "minimum": -10000, "maximum": 10000, "example": 0 } }, "required": [ "x", "y" ] }, "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" ] }, "HttpLink": { "type": "object", "properties": { "href": { "description": "Any URI that is using http or https protocol", "type": "string", "format": "uri" } }, "required": [ "href" ] }, "BoardObject": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "example": "26edac30-a6c3-490a-b73a-56689d25d66d" }, "type": { "type": "string" }, "position": { "allOf": [ { "nullable": true, "description": "An board object with a null position is placed in the inbox" }, { "$ref": "#/components/schemas/ObjectPosition" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "author": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } ] }, "isLocked": { "type": "boolean", "example": false }, "data": { "type": "object", "properties": {} } }, "required": [ "id", "type", "position", "createdAt", "updatedAt", "author", "isLocked", "data" ] } } } } ```