Skip to main content
POST
Create a list

Authorizations

Authorization
string
header
required

Send your workspace API key as a bearer token:

Keys are scoped to a single workspace. See Authentication.

Body

application/json
name
string
required
entity_type
enum<string>
required
Available options:
shop,
product,
creator,
video,
livestream,
category
description
string
item_ids
string[]
Maximum array length: 1000

Response

The created list.

id
string
Example:

"lst_01k3m9x7v2q8r4t6y0b1n5d7fa"

object
string
Allowed value: "list"
name
string
description
string | null
entity_type
enum<string>
Available options:
shop,
product,
creator,
video,
livestream,
category
item_count
integer
created_at
string<date-time>
updated_at
string<date-time>