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"
  }
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubStarter
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

Required Scopes

This API requires one of the following scopes:
  • cms.membership.access_groups.write
  • crm.lists.write

Authorizations

Authorization
string
header
required

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

Body

application/json

The request object used when creating a new object list.

Response

200
application/json

successful operation

The response for a list create request.