Skip to main content
PUT
Update an existing smart list.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

List data to update

Request body for updating a smart list. The body is the list object itself — include id plus only the fields you want to change. To publish/unpublish a list, set sharing — see field description for the three modes.

id
string
required

List ID (UUID) to update

name
string

New list name. Only the list owner can change this.

sharing
string

Visibility of the list. Only the list owner can change this value. Allowed values:

  • "Private": only the owner can view or modify the list.
  • "Shared": any user in the owner's company can view and modify the list.
  • "Public": anyone (no auth required) can read the list and its rows via GET /public/lists/ and GET /public/lists//rows. Other endpoints still require auth.
type
string

List type: "leads", "companies", or "custom"

Response

List updated

Generic success response

msg
string

Human-readable success message (typically "Success")