Skip to main content
POST
/
crm
/
v3
/
lists
/
Crear lista
curl --request POST \
  --url https://api.hubapi.com/crm/v3/lists/ \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --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"
  }
}

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.write

Authorizations

private-app
string
header
required

Body

application/json

The request object used when creating a new object list.

objectTypeId
string
required

El ID del tipo de objetos que la lista almacenará.

processingType
string
required

El tipo de procesamiento de la lista. Uno de los siguientes: "INSTANTÁNEA", "MANUAL" o "DINÁMICO".

name
string
required

El nombre de la lista, que debe ser único de forma global en todas las listas públicas del portal.

membershipSettings
object
customProperties
object

La lista de propiedades personalizadas que se vincularán a la lista. El nombre de la propiedad personalizada es la clave, el valor es el valor.

listFolderId
integer

El ID de la carpeta en la que se debe crear la lista. Si se deja en blanco, la lista se creará en la raíz de la estructura de carpetas de la lista.

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.