Pular para o conteúdo principal
POST
/
crm
/
v3
/
lists
Create List
curl --request POST \
  --url https://api.hubapi.com/crm/v3/lists/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filterBranch": {
    "filterBranchType": "OR",
    "filterBranches": [
      {
        "filterBranchType": "AND",
        "filterBranches": [
          {
            "associationCategory": "HUBSPOT_DEFINED",
            "associationTypeId": 4,
            "filterBranchType": "ASSOCIATION",
            "filters": [
              {
                "filterType": "PROPERTY",
                "operation": {
                  "operationType": "BOOL",
                  "operator": "IS_EQUAL_TO",
                  "value": true
                },
                "property": "hs_is_closed_won"
              }
            ],
            "objectTypeId": "0-3",
            "operator": "IN_LIST"
          }
        ],
        "filters": [
          {
            "filterType": "PROPERTY",
            "operation": {
              "operationType": "MULTISTRING",
              "operator": "IS_EQUAL_TO",
              "values": [
                "test",
                "name"
              ]
            },
            "property": "firstname"
          }
        ]
      }
    ]
  },
  "name": "Dynamic Association List Example",
  "objectTypeId": "0-1",
  "processingType": "DYNAMIC"
}
'
{
  "list": {
    "createdAt": "2023-11-15T18:16:52.165Z",
    "createdById": "123",
    "filterBranch": {
      "filterBranchOperator": "OR",
      "filterBranchType": "OR",
      "filterBranches": [
        {
          "filterBranchOperator": "AND",
          "filterBranchType": "AND",
          "filterBranches": [
            {
              "associationCategory": "HUBSPOT_DEFINED",
              "associationTypeId": 4,
              "filterBranchOperator": "AND",
              "filterBranchType": "ASSOCIATION",
              "filters": [
                {
                  "filterType": "PROPERTY",
                  "operation": {
                    "includeObjectsWithNoValueSet": false,
                    "operationType": "BOOL",
                    "operator": "IS_EQUAL_TO",
                    "value": true
                  },
                  "property": "hs_is_closed_won"
                }
              ],
              "objectTypeId": "0-3",
              "operator": "IN_LIST"
            }
          ],
          "filters": [
            {
              "filterType": "PROPERTY",
              "operation": {
                "includeObjectsWithNoValueSet": false,
                "operationType": "MULTISTRING",
                "operator": "IS_EQUAL_TO",
                "values": [
                  "test",
                  "name"
                ]
              },
              "property": "firstname"
            }
          ]
        }
      ]
    },
    "filtersUpdatedAt": "2023-11-15T18:16:52.165Z",
    "listId": "1",
    "listVersion": 1,
    "name": "Dynamic Association List Example",
    "objectTypeId": "0-1",
    "processingStatus": "PROCESSING",
    "processingType": "DYNAMIC",
    "updatedAt": "2023-11-15T18:16:52.395Z",
    "updatedById": "123"
  }
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json

The request object used when creating a new object list.

name
string
obrigatório

The name of the list, which must be globally unique across all public lists in the portal.

objectTypeId
string
obrigatório

The object type ID of the type of objects that the list will store.

processingType
string
obrigatório

The processing type of the list. One of: SNAPSHOT, MANUAL, or DYNAMIC.

customProperties
object

The list of custom properties to tie to the list. Custom property name is the key, the value is the value.

filterBranch
OR · object

Filter branch object containing filtering criteria for the list

listFolderId
integer<int32>

The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.

listPermissions
object
membershipSettings
object

Resposta

successful operation

The response for a list create request.

list
object
obrigatório

An object list definition.

Last modified on December 16, 2025