Skip to content

Update List

PATCH
/lists/{list_id}

Update a list’s name and/or its agent-readable description (#16641).

Authorizations

Parameters

Path Parameters

list_id
required

List ID

integer

List ID

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Request body for updating an existing list’s name and/or description.

object
description
Any of:
string
<= 2000 characters
title
required

New name for the list

string
>= 1 characters

Responses

200

Successful Response

object
data
required

Audience/list representation for the public API.

object
created_at
Any of:
string format: date-time
created_by
Any of:
string
description
Any of:
string
id
required
integer
is_dynamic
boolean
source
Any of:
string
status
Any of:
string
tags
Array<string>
title
required
string
total
integer
type
Any of:
string
updated_at
Any of:
string format: date-time
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string