Skip to main content
PUT
Update List

Authorizations

Authorization
string
header
required

Enter your API key

Path Parameters

list_id
string
required

Body

application/json

Request model for updating an existing list

name
string | null

Updated name of the list

Required string length: 1 - 255
description
string | null

Updated description of the list

Maximum string length: 1000
emoji
string | null

Updated emoji icon for the list

Maximum string length: 10
tags
string[] | null

Updated list of tag names

Response

Successful Response

Response model for a target list

id
string
required

Unique identifier for the list

name
string
required

Name of the list

created_at
string
required

ISO timestamp when the list was created

updated_at
string
required

ISO timestamp when the list was last updated

description
string | null

Optional description of the list

emoji
string | null

Optional emoji icon for the list

items
ListItemResponse ยท object[]

List of entities in this list

tags
TagResponse ยท object[]

Tags associated with this list

is_watchlist
boolean
default:false

Whether this list is a watchlist with active monitoring