PATCH/v3/live/lists/{id}

Update a person list

Renames a person list or changes its description. Omitted fields are left as they are. A list a web app user created and shared can be changed only by that user.

Version
v3
Rate limit
Tier 4 · 10–500 rps by plan
Billing
No entitlement required · Update a person list

Path parameters

  • idstringRequired
    List ID

Request body

  • descriptionstringOptional
    New description, at most 1,000 characters. An empty string clears it.
  • namestringOptional
    New list name, at most 255 characters.
Headers
x-api-key Required · API key for authentication

Response

  • createdAtstring
    When the list was created (ISO-8601, UTC).
  • descriptionstring
    Free-text description, or null when the list has none.
  • idstring
    List identifier (UUID).
  • memberCountinteger (int64)
    Number of people on the list.
  • namestring
    List name.
  • updatedAtstring
    When the list's name or description last changed (ISO-8601, UTC).

Status codes