AIair
Boards

/boards

Changed on

Create a board at the top-level of the workspace, at the root of a library, or as a child of another board.

To create a root board in a library, pass libraryId. To create a child board, pass parentBoardId; the new board inherits the parent's library. parentBoardId and libraryId cannot be supplied together. If neither is supplied, the board is created at the root of the General library.

post/v1/boards

Request

  • Base URL
    api.air.inc (relative, and the document’s source URL is not known)
  • Auth
    • API key in header x-api-key and API key in header x-air-workspace-id
    • or HTTP bearer and API key in header x-air-workspace-id
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

titlestring

The title of the board

descriptionstring

The description of the board

parentBoardIdstring uuid

The id of the parent board that this board will be a child of. Cannot be combined with libraryId.

libraryIdstring uuid

The id of the library to create this board in, as a root board of that library. Cannot be combined with parentBoardId; supplying both returns a 400.

Response

Default

idstring
titlestring
descriptionstring
parentBoardIdstring

Changes

  • 8e6005b272a1Revision changes
    • breaking

      the request property format changed from no format to uuid

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status