HubSpot · Schema

ListCreateRequest

Request body for creating a new CRM list.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
name string The name of the list.
objectTypeId string The object type ID for the list (e.g., 0-1 for contacts).
processingType string The type of list processing.
filterBranch object The filter branch definition for dynamic lists.
View JSON Schema on GitHub

JSON Schema

hubspot-crm-lists-list-create-request-schema.json Raw ↑ 
{
  "type": "object",
  "description": "Request body for creating a new CRM list.",
  "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",
      "description": "The type of list processing.",
      "example": "MANUAL",
      "enum": [
        "MANUAL",
        "DYNAMIC",
        "SNAPSHOT"
      ]
    },
    "filterBranch": {
      "type": "object",
      "description": "The filter branch definition for dynamic lists.",
      "example": {}
    }
  },
  "required": [
    "name",
    "objectTypeId",
    "processingType"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ListCreateRequest"
}