Sign in
Lists

Update List

Rename a List, update the List Info description, set a due date/time, set the List's priority, set an assignee, set or remove the List color.

put/v2/list/{list_id}

Path parameters

list_idstring required
Example:124

Request body

namestring required
contentstring
markdown_contentstring

Use markdown_content instead of content to format your List description.

due_dateinteger
due_date_timeboolean
priorityinteger
assigneestring
statusstring

Status refers to the List color rather than the task Statuses available in the List.

unset_statusboolean

By default, this is false. To remove the List color use unset_status: true.

Example request

{
  "name": "Updated List Name",
  "content": "Updated List Content",
  "markdown_content": "# This is markdown\n ***bold and italicized text***",
  "due_date": 1567780450202,
  "due_date_time": true,
  "priority": 2,
  "assignee": "none",
  "status": "red",
  "unset_status": true
}

Response

idstring
namestring
orderindexinteger
contentstring
statusStatus — unresolved $ref
priorityPriority — unresolved $ref
assigneestring nullable
task_countstring nullable
due_datestring
due_date_timeboolean
start_datestring nullable
start_date_timestring nullable
folderFolder — unresolved $ref
spaceSpace — unresolved $ref
statusesStatus[] — unresolved $ref
inbound_addressstring

Example response

{
  "id": "124",
  "name": "Updated List Name",
  "orderindex": 1,
  "content": "Updated List Content",
  "status": {
    "status": "red",
    "color": "#e50000",
    "hide_label": true
  },
  "priority": {
    "priority": "high",
    "color": "#f50000"
  },
  "assignee": null,
  "task_count": null,
  "due_date": "1567780450202",
  "due_date_time": true,
  "start_date": null,
  "start_date_time": null,
  "folder": {
    "id": "456",
    "name": "Folder Name",
    "hidden": false,
    "access": true
  },
  "space": {
    "id": "789",
    "name": "Space Name",
    "access": true
  },
  "statuses": [
    {
      "status": "to do",
      "orderindex": 0,
      "color": "#d3d3d3",
      "type": "open"
    },
    {
      "status": "complete",
      "orderindex": 1,
      "color": "#6bc950",
      "type": "closed"
    }
  ],
  "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}

Changes