Beta

Edit a List

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
PATCH
/v1/lists/{list_id}

Change a List name, description, rule or the SMB data columns it shows (view.data_columns, in order) using its current version. Subject type cannot change. If a new rule makes the name untrue, send a fitting name too or say so. Columns change only when view is sent: after a List is made its columns are the person's, so to show a new filter's field send view.data_columns with it added and keep the columns already shown. A restricted or archived List can replace its definition without restoring it or erasing private context. Reopen after a stale version.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Path Parameters

list_id*string
Match^list_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

Idempotency-Key*string
Length8 <= length <= 200
SMB-Workspace-Id*string
Formatuuid

Request Body

application/json
  1. body
name*string
Length1 <= length <= 120
description?|null
definition?|
expected_version?SmbV0OperationsGetListMembersRequestExpectedVersion
Range-9007199254740991 <= value <= 9007199254740991
view?

Response Body

Successful authorized response.

application/json
  1. response
data*
request_id*string
action_receipt*
idempotent_replay*smb_v0_operations_create_list_request.__local.properties.body.__schema16
curl -X PATCH 'https://example.com/v1/lists/string' \  -H 'Idempotency-Key: stringst' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "expected_version": -9007199254740991}'
{  "data": {    "id": "string",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",    "name": "string",    "description": "string",    "definition": {      "schema_version": "smb.list.v1",      "subject_type": "business",      "rule": {        "kind": "field",        "field": "name",        "operator": "eq",        "value": "string"      }    },    "version": -9007199254740991,    "lifecycle_status": "active",    "count": {      "status": "unknown",      "value": null,      "as_of": null,      "fewer_than": -9007199254740991    },    "columns": [      {        "column_id": "8f0515e3-00f6-4dd0-8153-321f1f40863d",        "name": "string",        "value_type": "text",        "position": 0,        "options": [          {            "id": "string",            "label": "string",            "color": "gray"          }        ]      }    ],    "view": {      "data_columns": [        "string"      ]    }  },  "request_id": "string",  "action_receipt": {    "receipt_id": "64d0a161-468e-472a-b00e-a06ee9ab7de7",    "command_id": "7d510d78-7444-4252-aeac-9e473949661e",    "operation": "update_list",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"  },  "idempotent_replay": true}