Update named list
Update an existing named list's metadata. All fields are optional - only provided fields will be updated. To modify list items, use the dedicated add/remove items endpoints.
Path Parameters
| Parameter | Type | Required | Description |
|---|
id | UUID | Yes | Named list identifier |
Request Body
| Field | Type | Required | Description |
|---|
name | string | No | New list name (max 255 chars, unique in org) |
type | string | No | New list type (max 100 chars) |
description | string | No | Updated description |
status | string | No | ACTIVE or INACTIVE |
items | array | No | Replace all items (use cautiously) |
metadata | object | No | Updated metadata (replaces existing) |
Status Changes
| Transition | Effect |
|---|
| ACTIVE → INACTIVE | List cannot be used in new policy conditions |
| INACTIVE → ACTIVE | List becomes available for policy use |
Note: Deactivating a list does not affect existing policies that reference it. Review policies before deactivating.
Response Fields
| Field | Type | Description |
|---|
id | UUID | Unique list identifier |
name | string | List name |
type | string | List type |
description | string | List description |
status | string | ACTIVE or INACTIVE |
items | string[] | Array of all items in the list |
organizationId | UUID | Owning organization ID |
itemCount | number | Total number of items in the list |
createdAt | string | Creation timestamp (ISO 8601) |
updatedAt | string | Last update timestamp (ISO 8601) |
Use Cases
- Rename a list for better organization
- Update list description or type
- Deactivate a list without deleting
- Reactivate a previously disabled list
- Update metadata properties
Required Permission
lists:update