Skip to main content
PATCH
/
lists
/
{listId}
Update list
curl --request PATCH \
  --url https://inboxapp.com/api/v1/lists/{listId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "color": "red",
  "description": "Updated description"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "description": "Leads scraped from Product Hunt launches",
  "profilesCount": 123,
  "reachableEstimate": 123,
  "reachableCount": 123,
  "columns": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
listId
string
required

The ID of the list to update.

Pattern: ^[0-9a-z]+$

Body

application/json
​
name
string

New name for the list.

Required string length: 1 - 255
Example:

"Hot Leads"

​
icon
enum<string>

New icon name for the list.

Available options:
anchor,
aperture,
apple,
at-sign,
atom,
badge-check,
banana,
beef,
biceps-flexed,
bike,
badge-dollar-sign,
bitcoin,
bone,
book,
box,
braces,
brain,
building-2,
cake,
calendar,
camera,
castle,
chart-column-increasing,
chart-pie,
chef-hat,
circle-alert,
circle-help,
clapperboard,
clock,
cloud,
cloud-drizzle,
cloud-sun,
code,
coffee,
construction,
cooking-pot,
cpu,
crown,
disc-3,
dices,
dna,
door-open,
drafting-compass,
drama,
droplet,
dumbbell,
earth,
egg,
eye,
fingerprint,
flag,
flame,
flask-conical,
gavel,
ghost,
git-merge,
graduation-cap,
guitar,
hash,
headphones,
heart,
hourglass,
ice-cream-cone,
image,
instagram,
key,
keyboard,
landmark,
languages,
laptop,
leaf,
lightbulb,
lock,
lock-open,
magnet,
mail,
map,
map-pin,
martini,
medal,
megaphone,
message-circle,
messages-square,
mic-vocal,
milestone,
moon,
mouse-pointer-2,
music,
octagon,
package,
paintbrush-vertical,
palette,
party-popper,
pause,
phone,
percent,
pencil,
pin,
plane,
play,
popcorn,
puzzle,
pyramid,
quote,
rainbow,
radio-tower,
refresh-cw,
rocket,
sailboat,
scissors,
send,
settings,
shapes,
shield-check,
sigma,
signpost,
snowflake,
speaker,
star,
stethoscope,
sun,
superscript,
swords,
syringe,
tags,
tally-5,
telescope,
tent-tree,
test-tubes,
thermometer,
thumbs-down,
thumbs-up,
ticket,
timer,
tornado,
traffic-cone,
trash,
trending-down,
trending-up,
trophy,
twitter,
tv,
umbrella,
user,
users,
utensils,
volume-2,
volume-x,
wand-sparkles,
watch,
x,
wine,
wind,
youtube,
zap,
cog,
circle-user-round
Examples:

"rocket"

"star"

"users"

​
color
string | null

Color for the item. Can be a predefined color name (red, blue, green, etc.) or a hex code (#ef4444).

Example:

"red"

​
description
string | null

New description for the list. Pass null to clear.

Maximum string length: 1000
Example:

"Updated description"

Response

200 - application/json

OK

​
id
string
required

Unique identifier for the list.

Pattern: ^[0-9a-z]+$
​
name
string
required

Display name of the list.

Example:

"Product Hunt Leads"

​
slug
string
required

URL-friendly slug for the list.

Example:

"product-hunt-leads"

​
icon
string
required

Icon name for the list.

Example:

"list"

​
color
string
required

Hex color code for the list.

Example:

"#3b82f6"

​
description
string | null
required

Optional description of the list.

Example:

"Leads scraped from Product Hunt launches"

​
profilesCount
number
required

Total number of profiles in the list.

Example:

1520

​
reachableEstimate
number | null
required

Estimated number of reachable profiles in the list.

​
reachableCount
number
required

Number of profiles that can be contacted.

Example:

1200

​
columns
object
required

Column definitions for the list.

​
createdAt
string<date-time>
required

When the list was created.

​
updatedAt
string<date-time> | null
required

When the list was last updated.