HubSpot · Schema

Association

Represents an association between two CRM objects

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
toObjectId string ID of the target object
associationTypes array Types of associations between the objects
View JSON Schema on GitHub

JSON Schema

hubspot-crm-associations-association-schema.json Raw ↑
{
  "type": "object",
  "description": "Represents an association between two CRM objects",
  "properties": {
    "toObjectId": {
      "type": "string",
      "description": "ID of the target object",
      "example": "500123"
    },
    "associationTypes": {
      "type": "array",
      "description": "Types of associations between the objects",
      "example": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 500123,
          "label": "Example Record"
        }
      ],
      "items": {
        "type": "object",
        "description": "Defines the type of association",
        "properties": {
          "associationCategory": {
            "type": "string",
            "description": "Category of the association type",
            "example": "HUBSPOT_DEFINED",
            "enum": [
              "HUBSPOT_DEFINED",
              "USER_DEFINED",
              "INTEGRATOR_DEFINED"
            ]
          },
          "associationTypeId": {
            "type": "integer",
            "description": "Numeric identifier for the association type",
            "example": 500123
          },
          "label": {
            "type": "string",
            "description": "Human-readable label for the association",
            "example": "Example Record"
          }
        },
        "required": [
          "associationCategory",
          "associationTypeId"
        ]
      }
    }
  },
  "required": [
    "toObjectId",
    "associationTypes"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Association"
}