HubSpot · Schema
AssociationInput
Input for creating an association
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| to | object | |
| types | array | The association types |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/commerce-payments-api-association-input-schema.json",
"title": "AssociationInput",
"description": "Input for creating an association",
"type": "object",
"properties": {
"to": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the object to associate with"
}
},
"example": {
"id": "500123"
}
},
"types": {
"type": "array",
"description": "The association types",
"items": {
"type": "object",
"description": "An association type definition",
"required": [
"associationCategory",
"associationTypeId"
],
"properties": {
"associationCategory": {
"type": "string",
"enum": [
"HUBSPOT_DEFINED",
"USER_DEFINED",
"INTEGRATOR_DEFINED"
],
"description": "The category of the association",
"example": "HUBSPOT_DEFINED"
},
"associationTypeId": {
"type": "integer",
"description": "The numeric ID of the association type",
"example": 500123
}
}
},
"example": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 500123
}
]
}
},
"required": [
"to",
"types"
]
}