HubSpot · JSON Structure

Crm Lists Api List Create Request Structure

Request body for creating a new CRM list.

Type: object Properties: 4 Required: 3
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

ListCreateRequest is a JSON Structure definition published by HubSpot, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name objectTypeId processingType filterBranch

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-lists-api-list-create-request-structure.json",
  "name": "ListCreateRequest",
  "description": "Request body for creating a new CRM list.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the list.",
      "example": "Example Record"
    },
    "objectTypeId": {
      "type": "string",
      "description": "The object type ID for the list (e.g., 0-1 for contacts).",
      "example": "500123"
    },
    "processingType": {
      "type": "string",
      "enum": [
        "MANUAL",
        "DYNAMIC",
        "SNAPSHOT"
      ],
      "description": "The type of list processing.",
      "example": "MANUAL"
    },
    "filterBranch": {
      "type": "object",
      "description": "The filter branch definition for dynamic lists.",
      "example": {}
    }
  },
  "required": [
    "name",
    "objectTypeId",
    "processingType"
  ]
}