Skip to main content
PUT
/
crm
/
v3
/
lists
/
{listId}
/
update-list-filters
Actualizar definición de filtro de lista
curl --request PUT \
  --url https://api.hubapi.com/crm/v3/lists/{listId}/update-list-filters \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --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"
  }
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Starter
Esta API requiere uno de los siguientes ámbitos:
cms.membership.access_groups.write
crm.lists.read
crm.lists.read
crm.lists.write

Authorizations

private-app
string
header
required

Path Parameters

listId
string
required

El ID de ILS de la lista que se actualizará.

Query Parameters

enrollObjectsInWorkflows
boolean
default:false

Un marcador que indica si las membresías agregadas a la lista como resultado del cambio de filtro deben o no deben ser inscritas en los workflows que son relevantes para esta lista.

Body

application/json

The definition of the list filter branch update request.

filterBranch
object
required
  • OR
  • AND
  • NOT_ALL
  • NOT_ANY
  • RESTRICTED
  • UNIFIED_EVENTS
  • PROPERTY_ASSOCIATION
  • ASSOCIATION

Response

Successful response

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

updatedList
object

An object list definition.