HubSpot · JSON Structure

Crm Associations Api Association Definition Structure

Definition of an association type between two object types

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

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

Properties

id fromObjectTypeId toObjectTypeId name label inverseLabel category

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-associations-api-association-definition-structure.json",
  "name": "AssociationDefinition",
  "description": "Definition of an association type between two object types",
  "type": "object",
  "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",
      "enum": [
        "HUBSPOT_DEFINED",
        "USER_DEFINED",
        "INTEGRATOR_DEFINED"
      ],
      "description": "Category of the association definition",
      "example": "HUBSPOT_DEFINED"
    }
  },
  "required": [
    "id",
    "fromObjectTypeId",
    "toObjectTypeId"
  ]
}