Create list

Creates a list within a board. Requires board editor permissions.

post/boards/{boardId}/lists

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/boards/{boardId}/lists
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Path parameters

boardIdstring required

Example:1357158568008091264

ID of the board to create the list in

Request body

type'active' | 'closed' required

Type/status of the list

positionnumber required

Position of the list within the board

namestring required

Name/title of the list

Example request

{
  "type": "active",
  "position": 65536,
  "name": "To Do"
}

Response

List created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "boardId": "1357158568008091265",
    "type": "active",
    "position": 65536,
    "name": "To Do",
    "color": "lagoon-blue",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.