Zum Hauptinhalt springen
POST
/
crm
/
v3
/
lists
/
リストを作成
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"
  }
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
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.

objectTypeId
string
required

リストに保存するオブジェクトタイプのオブジェクトタイプID。

processingType
string
required

リストの処理タイプ。「SNAPSHOT」、「MANUA」、または「DYNAMIC」のいずれかになります。

name
string
required

リストの名前。ポータルの全ての公開リストでグローバルに固有である必要があります。

membershipSettings
object
customProperties
object

リストに関連付けるカスタムプロパティーのリスト。カスタムプロパティー名はkeyで、値はvalueです。

listFolderId
integer

リストが作成されるフォルダーのID。空白のままにすると、リストフォルダー構造のルートにリストが作成されます。

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

Response

successful operation

The response for a list create request.

list
object
required

An object list definition.