Sign in
Lists

Update list

Updates a list. Can move lists between boards. Requires board editor permissions.

patch/lists/{id}

Request

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

Path parameters

idstring required
Example:1357158568008091264

ID of the list to update

Request body

boardIdstring

ID of the board to move list to

type'active' | 'closed'

Type/status of the list

positionnumber

Position of the list within the board

namestring

Name/title of the list

color'berry-red' | 'pumpkin-orange' | 'lagoon-blue' | 'pink-tulip' | 'light-mud' | 'orange-peel' | 'bright-moss' | 'antique-blue' | 'dark-granite' | 'turquoise-sea' nullable

Color for the list

Example request

{
  "boardId": "1357158568008091265",
  "type": "active",
  "position": 65536,
  "name": "To Do",
  "color": "lagoon-blue"
}

Response

List updated 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.