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.

SecurityAuthorization Token
Request
path Parameters
list_id
required
string
Request Body schema: application/json
name
required
string
content
required
string
due_date
required
integer <int64>
due_date_time
required
boolean
priority
required
integer <int32>
assignee
required
string
status
required
string

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

unset_status
required
boolean

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

include_markdown_description
boolean

To return List descriptions in Markdown format, use ?include_markdown_description=true.

Responses
200
put/list/{list_id}
Request samples
application/json
{
  • "name": "Updated List Name",
  • "content": "Updated List Content",
  • "due_date": 1567780450202,
  • "due_date_time": true,
  • "priority": 2,
  • "assignee": "none",
  • "status": "red",
  • "unset_status": true
}
Response samples
application/json
{
  • "id": "124",
  • "name": "Updated List Name",
  • "orderindex": 1,
  • "content": "Updated List Content",
  • "status": {
    },
  • "priority": {
    },
  • "assignee": null,
  • "task_count": null,
  • "due_date": "1567780450202",
  • "due_date_time": true,
  • "start_date": null,
  • "start_date_time": null,
  • "folder": {
    },
  • "space": {
    },
  • "statuses": [
    ],
  • "inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}