Update team list

  • Updated on Sep 3, 2025
  • Published on Sep 2, 2025
Prev Next
Patch
/team/list/{list_id}

Update an existing team list

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Path parameters
list_id
stringRequired

Supermetrics team list ID

Body parameters
object
list_name
string Required

List name, used in product UI.

show_in_products

List of Supermetrics products this list should be shown in. If not provided or empty list, not shown in any product.

OneOf
string
string
Valid values[ "API", "DWH", "MND" ]
array
array
string
Valid values[ "API", "DWH", "MND" ]
Responses
200

Team list updated successfully

Expand All
object
meta
object
request_id
string

API request ID

data
object (TeamList)
list_id
string

Supermetrics list ID

list_slug
string

User-defined ID, used to reference list in queries

list_name
string

List name

list_type
string

List type

Valid values[ "account_ids" ]
ds_id
string

Data source ID. Empty string when list is global.

ds_name
string

Data source name. Empty string when list is global.

show_in_products
Array of string

List of Supermetrics products this list should be shown in. If empty, not shown in any product.

string
Valid values[ "API", "DWH", "MND" ]
404

Requested team list was not found

object
error
string
Valid values[ "LIST_NOT_FOUND" ]
message
string
500

Failed to update team list

object
error
string
Valid values[ "LIST_UPDATE_FAILED" ]
message
string