POST/v3/live/lists

Create a person list

Creates an empty person list, shared with everyone in your organization. A list created through the API belongs to the organization rather than to any one user, so any web app user can rename or delete it.

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

Request body

  • descriptionstringOptional
    Optional description, at most 1,000 characters.
  • namestringRequired
    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