Skip to main content
PATCH
Update a contact list

Authorizations

Authorization
string
header
required

An API key (utk_live_...) or an app's OAuth access token (uto_...).

Path Parameters

listId
string<uuid>
required

A contact list id.

Body

application/json

Send at least one field; a field left out stays as it is. Another field is 400 PUB-001-004.

name
string
Required string length: 1 - 120
description
string | null

null clears it.

Maximum string length: 500
icon
string | null

null keeps the icon.

Pattern: ^[a-z0-9-]{1,32}$

Response

The list after the change.

id
string<uuid>
required
name
string
required
description
string | null
required
icon
string | null
required

An icon key from the dashboard's icon set; null draws the default icon.

memberCount
integer
required
createdAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

updatedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

Last modified on November 8, 2026