Skip to main content
PATCH
/
api
/
v1
/
lists
/
{id}
Update list
curl --request PATCH \
  --url https://api.getarca.app/api/v1/lists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "folder_id": "<string>"
}
'
{
  "id": 25,
  "workspace_id": 3,
  "folder_id": 10,
  "name": "API Integration Tasks",
  "icon": "folder-1",
  "color": "green",
  "position": 3,
  "created_at": "2026-03-18T11:00:00.000Z"
}
Requires the lists:write scope. Viewers cannot edit lists.

Path parameters

id
string
required
The numeric list ID.

Request body

All fields are optional. Send only the fields you want to update.
name
string
New list name. Whitespace is trimmed. HTML is sanitized.
icon
string
Icon identifier slug.
color
string
List color.
folder_id
string
Move the list to a different folder by passing a new folder ID.

Response

Returns the full updated list object.
id
number
required
List identifier.
workspace_id
number
required
Workspace this list belongs to.
folder_id
number | null
Parent folder ID. null if not inside a folder.
name
string
required
List name.
icon
string | null
Icon.
color
string | null
Color.
position
number
required
Sort position (unchanged by this endpoint).
created_at
string
required
UTC ISO-8601 creation timestamp.
{
  "id": 25,
  "workspace_id": 3,
  "folder_id": 10,
  "name": "API Integration Tasks",
  "icon": "folder-1",
  "color": "green",
  "position": 3,
  "created_at": "2026-03-18T11:00:00.000Z"
}