HubSpot · Schema

AssociationDefinition

Definition of an association type between two object types

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
id	string	Unique identifier for the association definition
fromObjectTypeId	string	Source object type ID
toObjectTypeId	string	Target object type ID
name	string	Name of the association type
label	string	Display label for the association
inverseLabel	string	Label for the inverse association
category	string	Category of the association definition

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "Definition of an association type between two object types",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the association definition",
      "example": "500123"
    },
    "fromObjectTypeId": {
      "type": "string",
      "description": "Source object type ID",
      "example": "500123"
    },
    "toObjectTypeId": {
      "type": "string",
      "description": "Target object type ID",
      "example": "500123"
    },
    "name": {
      "type": "string",
      "description": "Name of the association type",
      "example": "Example Record"
    },
    "label": {
      "type": "string",
      "description": "Display label for the association",
      "example": "Example Record"
    },
    "inverseLabel": {
      "type": "string",
      "description": "Label for the inverse association",
      "example": "Example Record"
    },
    "category": {
      "type": "string",
      "description": "Category of the association definition",
      "example": "HUBSPOT_DEFINED",
      "enum": [
        "HUBSPOT_DEFINED",
        "USER_DEFINED",
        "INTEGRATOR_DEFINED"
      ]
    }
  },
  "required": [
    "id",
    "fromObjectTypeId",
    "toObjectTypeId"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AssociationDefinition"
}