Skip to main content
PUT
/
crm
/
v3
/
lists
/
{listId}
/
update-list-filters
Update List Filter Definition
curl --request PUT \
  --url https://api.hubapi.com/crm/v3/lists/{listId}/update-list-filters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filterBranch": {
    "filterBranchType": "OR",
    "filterBranches": [
      {
        "filterBranchType": "AND",
        "filters": [
          {
            "filterType": "PROPERTY",
            "operation": {
              "operationType": "NUMBER",
              "operator": "IS_GREATER_THAN_OR_EQUAL_TO",
              "value": 12
            },
            "property": "hs_predictivecontactscore_v2"
          },
          {
            "filterType": "PROPERTY",
            "operation": {
              "operationType": "ALL_PROPERTY",
              "operator": "IS_UNKNOWN"
            },
            "property": "engagements_last_meeting_booked_source"
          },
          {
            "acceptedStatuses": [
              "OPT_IN"
            ],
            "filterType": "EMAIL_SUBSCRIPTION",
            "subscriptionIds": [
              "81537745",
              "321981152"
            ]
          }
        ]
      }
    ]
  }
}
'
{
  "updatedList": {
    "createdAt": "2023-11-15T20:11:50.293Z",
    "createdById": "123",
    "filterBranch": {
      "filterBranchOperator": "OR",
      "filterBranchType": "OR",
      "filterBranches": [
        {
          "filterBranchOperator": "AND",
          "filterBranchType": "AND",
          "filters": [
            {
              "filterType": "PROPERTY",
              "operation": {
                "includeObjectsWithNoValueSet": false,
                "operationType": "NUMBER",
                "operator": "IS_GREATER_THAN_OR_EQUAL_TO",
                "value": 12
              },
              "property": "hs_predictivecontactscore_v2"
            },
            {
              "filterType": "PROPERTY",
              "operation": {
                "includeObjectsWithNoValueSet": false,
                "operationType": "ALL_PROPERTY",
                "operator": "IS_UNKNOWN"
              },
              "property": "engagements_last_meeting_booked_source"
            },
            {
              "acceptedStatuses": [
                "OPT_IN"
              ],
              "filterType": "EMAIL_SUBSCRIPTION",
              "subscriptionIds": [
                "321981152",
                "81537745"
              ],
              "subscriptionType": "SUBSCRIPTION"
            }
          ]
        }
      ]
    },
    "filtersUpdatedAt": "2023-11-15T23:50:12.690Z",
    "listId": "1",
    "listVersion": 2,
    "name": "Zero Size Test",
    "objectTypeId": "0-1",
    "processingStatus": "PROCESSING",
    "processingType": "DYNAMIC",
    "updatedAt": "2023-11-15T23:50:12.771Z",
    "updatedById": "123"
  }
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Free
Data HubData Hub -Free

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

listId
string
required

The ILS ID of the list to update.

Query Parameters

enrollObjectsInWorkflows
boolean
default:false

A flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list.

Body

application/json

The definition of the list filter branch update request.

filterBranch
OR · object
required

Updated filtering criteria for the list

Response

Successful response

The updated definition of the list in response to a list update request.

updatedList
object

An object list definition.

Last modified on December 16, 2025