HubSpot: Association labels schemas

← Association labels operations · All schemas

Configure association limits — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicAssociationDefinitionConfigurationCreateRequest objects. Each item in the array specifies the configuration details for creating an association definition.
inputs[]	Model	Each item	Expand Configure association limits — request body — body inputs item

Referenced models: Configure association limits — request body — body inputs item

Configure association limits — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
category	string	Required within parent	Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
maxToObjectIds	integer	Required within parent	The maximum number of target object IDs that can be associated with a single source object. Format: int32
typeId	integer	Required within parent	An integer used to uniquely identify a specific association type within its category. Format: int32

Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed. Format: date-time
links	object	Optional	A collection of URLs linking to related documentation or resources associated with the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested. Format: date-time
results	array	Required within parent	An array of user configurations for public association definitions, representing the outcome of the batch operation.
results[]	Model	Each item	Expand Retrieve association limits — response body — results item
startedAt	string	Required within parent	The date and time when the batch operation started. Format: date-time
status	string	Required within parent	The current status of the batch operation, which can be CANCELED, COMPLETE, PENDING, or PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Retrieve association limits — response body — results item

Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each item detailing a specific error.
errors[]	Model	Each item	Expand Remove association limits — response body — errors item
links	object	Optional	An object containing key-value pairs where each key is a link name and each value is a URI string related to the operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each item representing a public association definition user configuration.
results[]	Model	Each item	Expand Retrieve association limits — response body — results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove association limits — response body — errors item, Retrieve association limits — response body — results item

Create association label — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inverseLabel	string	Optional	An optional descriptor that clarifies the reverse relationship in the association.
label	string	Required within parent	A descriptor that provides context about the relationship between two associated CRM objects.
name	string	Required within parent	The unique identifier for the association definition.

Create association label — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of association specifications with labels, where each item defines a specific association type between two object types. Each specification includes details such as category, typeId, and labels.
results[]	Model	Each item	Expand Create association label — response body — results item

Referenced models: Create association label — response body — results item

Create association label — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	The category of the association, which can be 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string indicating the object type ID from which the association originates.
label	string	Optional	A string representing the label for the association, which is optional.
toObjectTypeId	string	Optional	A string indicating the object type ID to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Remove association limits — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicAssociationSpec objects, each defining the specifications for an association. This property is required and allows multiple association specifications to be processed in a single batch operation.
inputs[]	Model	Each item	Expand Remove association limits — request body — body inputs item

Referenced models: Remove association limits — request body — body inputs item

Remove association limits — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
category	string	Required within parent	Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
typeId	integer	Required within parent	A unique integer identifier for the specific association type within its category. Format: int32

Remove association limits — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation. Each error provides details about the issue.
errors[]	Model	Each item	Expand Remove association limits — response body — errors item
links	object	Optional	A map of link names to associated URIs, providing additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array containing the results of the batch operation. Each result corresponds to an object processed in the batch.
results[]	object	Each item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove association limits — response body — errors item

Remove association limits — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string that categorizes the error.
context	object	Required within parent	An object containing additional context about the error condition, with each key mapping to an array of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing the unique identifier for this error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific details about the error category.

Referenced models: Batch insert events — response body — errors item errors item

Retrieve association limits — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of PublicAssociationDefinitionUserConfiguration objects, each representing a user configuration for an association definition.
results[]	Model	Each item	Expand Retrieve association limits — response body — results item

Referenced models: Retrieve association limits — response body — results item

Retrieve association limits — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
category	string	Required within parent	The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
label	string	Optional	A descriptor providing context about the relationship between associated records.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	A unique integer identifier for the association type within its category. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userEnforcedMaxToObjectIds	JSON	Optional
userEnforcedMaxToObjectIds (anyOf 1)	integer	Alternative	The maximum number of target object IDs that a user can enforce in an association. Format: int32
userEnforcedMaxToObjectIds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update association label — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
associationTypeId	integer	Required within parent	The unique identifier for the association type. Format: int32
inverseLabel	string	Optional	An optional descriptor for the inverse relationship between associated records.
label	string	Required within parent	A descriptor that provides context about the relationship between associated records.

Update association limits — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicAssociationDefinitionConfigurationUpdateRequest objects. Each object in the array specifies the configuration details to be updated.
inputs[]	Model	Each item	Expand Update association limits — request body — body inputs item

Referenced models: Update association limits — request body — body inputs item

Update association limits — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
category	string	Required within parent	Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
maxToObjectIds	integer	Required within parent	Defines the maximum number of target object IDs that can be associated. Format: int32
typeId	integer	Required within parent	A unique identifier for the association type. Format: int32

Update association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root
category	string	Required within parent	The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer value used to uniquely identify a specific association type within its Association Category. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userEnforcedMaxToObjectIds	JSON	Optional
userEnforcedMaxToObjectIds (anyOf 1)	integer	Alternative	The maximum number of object IDs that a user can enforce for associations. Format: int32
userEnforcedMaxToObjectIds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition Configuration Update Result

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch update operation was completed. Format: date-time
links	object	Optional	URLs linking to documentation or resources associated with the batch update operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch update operation was requested. Format: date-time
results	array	Required within parent	An array of results from the batch update operation. Each item in the array is a PublicAssociationDefinitionConfigurationUpdateResult object.
results[]	Model	Each item	Expand Update association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch update operation started. Format: date-time
status	string	Required within parent	The current status of the batch update operation, which can be CANCELED, COMPLETE, PENDING, or PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Update association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Update association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition Configuration Update Result With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each detailing a specific issue that occurred.
errors[]	Model	Each item	Expand Remove association limits — response body — errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or resources related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each representing an update result for a public association definition configuration.
results[]	Model	Each item	Expand Update association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove association limits — response body — errors item, Update association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item