HubSpot · Schema

CreateAssociationInput

Input for creating an association

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
to object Reference to a CRM object by ID
types array Association types to create
View JSON Schema on GitHub

JSON Schema

hubspot-crm-associations-create-association-input-schema.json Raw ↑
{
  "type": "object",
  "description": "Input for creating an association",
  "properties": {
    "to": {
      "type": "object",
      "description": "Reference to a CRM object by ID",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the object",
          "example": "500123"
        }
      },
      "required": [
        "id"
      ]
    },
    "types": {
      "type": "array",
      "description": "Association types to create",
      "example": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 500123
        }
      ],
      "items": {
        "type": "object",
        "description": "Input for specifying an association type",
        "properties": {
          "associationCategory": {
            "type": "string",
            "example": "HUBSPOT_DEFINED",
            "enum": [
              "HUBSPOT_DEFINED",
              "USER_DEFINED",
              "INTEGRATOR_DEFINED"
            ]
          },
          "associationTypeId": {
            "type": "integer",
            "example": 500123
          }
        },
        "required": [
          "associationCategory",
          "associationTypeId"
        ]
      }
    }
  },
  "required": [
    "to",
    "types"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateAssociationInput"
}