Sign in
Basic

post/crm/v3/lists

Request body

customPropertiesobject

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

listFolderIdinteger

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.

namestring required

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

objectTypeIdstring required

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

processingTypestring required

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

Example request

{
  "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"
}

Response

successful operation

Example response

{
  "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"
  }
}