HubSpot: Event definitions schemas (part 2)

← Event definitions operations · All schemas

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By range Type: BETWEEN, NOT BETWEEN, type: Absolute Ranged Timestamp Refine By

Field	Type	Presence	Description and constraints
$	object	Root
lowerTimestamp	JSON	Required within parent
lowerTimestamp (anyOf 1)	integer	Alternative	An integer representing the lower bound of the timestamp range, in milliseconds since the Unix epoch. Format: int64
lowerTimestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rangeType	string	Required within parent	A string that indicates the type of range comparison. Valid values are 'BETWEEN' and 'NOT_BETWEEN'. Known values: BETWEEN, NOT_BETWEEN
type	string	Required within parent	A string that specifies the type of the component, which is 'AbsoluteRangedTimestampRefineBy'. Known values: AbsoluteRangedTimestampRefineBy Default: AbsoluteRangedTimestampRefineBy
upperTimestamp	JSON	Required within parent
upperTimestamp (anyOf 1)	integer	Alternative	An integer representing the upper bound of the timestamp range, in milliseconds since the Unix epoch. Format: int64
upperTimestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By range Type: BETWEEN, NOT BETWEEN, type: Relative Ranged Timestamp Refine By

Field	Type	Presence	Description and constraints
$	object	Root
lowerBoundOffset	Model	Required within parent	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By time Offset
rangeType	string	Required within parent	A string indicating the type of range operation, with valid values 'BETWEEN' and 'NOT_BETWEEN'. Known values: BETWEEN, NOT_BETWEEN
type	string	Required within parent	A string indicating the type of refinement, with a default value of 'RelativeRangedTimestampRefineBy'. Known values: RelativeRangedTimestampRefineBy Default: RelativeRangedTimestampRefineBy
upperBoundOffset	Model	Required within parent	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By time Offset

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By comparison: AFTER, BEFORE, type: Relative Comparative Timestamp Refine By time Offset

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: multistring pruning Refine By type: All History Refine By

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string that specifies the type of refinement. The default value is 'AllHistoryRefineBy', and it is the only valid value for this property. Known values: AllHistoryRefineBy Default: AllHistoryRefineBy

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: number

Field	Type	Presence	Description and constraints
$	object	Root
defaultValue	string	Optional	A string representing the default value for the operation.
includeObjectsWithNoValueSet	boolean	Required within parent	A boolean indicating whether objects with no value set should be included in the operation.
operationType	string	Required within parent	A string that specifies the type of operation being performed.
operator	string	Required within parent	A string representing the operation to be performed on the number property. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'IS_GREATER_THAN', 'IS_GREATER_THAN_OR_EQUAL_TO', 'IS_LESS_THAN', 'IS_LESS_THAN_OR_EQUAL_TO', 'HAS_EVER_BEEN_EQUAL_TO', and 'HAS_NEVER_BEEN_EQUAL_TO'. Known values: HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, IS_EQUAL_TO, IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL_TO, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL_TO, IS_NOT_EQUAL_TO
operatorName	string	Required within parent	A string representing the name of the operator used in the operation.
propertyAspect	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
propertyType	string	Required within parent	A string that specifies the type of property operation, with a default value of 'number'. Known values: number Default: number
renderSpec	string	Optional	A string that provides specifications for rendering the operation.
value	JSON	Required within parent
value (anyOf 1)	number	Alternative	A number that represents the value to be used in the operation.
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: number-comparative

Field	Type	Presence	Description and constraints
$	object	Root
comparisonPropertyName	string	Required within parent	A string representing the name of the property to compare against.
defaultValue	string	Optional	A string representing the default value to use if no comparison value is set.
includeObjectsWithNoValueSet	boolean	Required within parent	A boolean indicating whether to include objects that have no value set for the property being compared.
operationType	string	Required within parent	A string representing the type of operation being performed.
operator	string	Required within parent	A string representing the comparison operator. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'IS_GREATER_THAN', 'IS_GREATER_THAN_OR_EQUAL_TO', 'IS_LESS_THAN', and 'IS_LESS_THAN_OR_EQUAL_TO'. Known values: IS_EQUAL_TO, IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL_TO, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL_TO, IS_NOT_EQUAL_TO
operatorName	string	Required within parent	A string representing the name of the operator.
propertyAspect	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
propertyType	string	Required within parent	A string indicating the type of property operation. Defaults to 'number-comparative'. Known values: number-comparative Default: number-comparative
renderSpec	string	Optional	A string that specifies how the operation should be rendered.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: string

Field	Type	Presence	Description and constraints
$	object	Root
defaultValue	string	Optional	A string representing the default value to be used if no other value is set.
includeObjectsWithNoValueSet	boolean	Required within parent	A boolean indicating whether objects with no value set should be included in the operation.
operationType	string	Required within parent	A string indicating the type of operation being performed.
operator	string	Required within parent	A string representing the operation to be performed, with valid values including 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH', 'ENDS_WITH', 'HAS_EVER_BEEN_EQUAL_TO', 'HAS_NEVER_BEEN_EQUAL_TO', 'HAS_EVER_CONTAINED', and 'HAS_NEVER_CONTAINED'. Known values: CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, HAS_EVER_BEEN_EQUAL_TO, HAS_EVER_CONTAINED, HAS_NEVER_BEEN_EQUAL_TO, HAS_NEVER_CONTAINED, IS_EQUAL_TO, IS_NOT_EQUAL_TO, STARTS_WITH
operatorName	string	Required within parent	A string representing the name of the operator.
propertyAspect	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
propertyType	string	Required within parent	A string indicating the type of property, defaulting to 'string'. Known values: string Default: string
renderSpec	string	Optional	A string that provides specifications for rendering the operation.
value	string	Required within parent	A string that specifies the value to be used in the operation.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: string-comparative

Field	Type	Presence	Description and constraints
$	object	Root
comparisonPropertyName	string	Required within parent	The name of the property to compare against, represented as a string.
defaultValue	string	Optional	A string representing the default value to use in the operation if no value is set.
includeObjectsWithNoValueSet	boolean	Required within parent	A boolean indicating whether to include objects that do not have a value set for the property.
operationType	string	Required within parent	A string representing the type of operation being performed.
operator	string	Required within parent	A string representing the comparison operation to perform. Valid values include 'IS_EQUAL_TO', 'IS_NOT_EQUAL_TO', 'CONTAINS', 'DOES_NOT_CONTAIN', 'STARTS_WITH', and 'ENDS_WITH'. Known values: CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, IS_EQUAL_TO, IS_NOT_EQUAL_TO, STARTS_WITH
operatorName	string	Required within parent	A string representing the name of the operator used in the operation.
propertyAspect	Model	Optional	Expand Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect
propertyType	string	Required within parent	A string indicating the type of property operation, defaulting to 'string-comparative'. Known values: string-comparative Default: string-comparative
renderSpec	string	Optional	A string specifying how the operation should be rendered.

Referenced models: Update event definition — response body — comboEventRules / composingRules / item / propertyFilters / item / operation / propertyType: bool property Aspect

Update event definition — response body — custom Matching Id

Field	Type	Presence	Description and constraints
$	object	Root
primaryObjectRule	Model	Required within parent	Expand Update event definition — response body — custom Matching Id primary Object Rule

Referenced models: Update event definition — response body — custom Matching Id primary Object Rule

Update event definition — response body — custom Matching Id primary Object Rule

Field	Type	Presence	Description and constraints
$	object	Root
eventPropertyName	string	Required within parent	The name of the property on the event that is used for resolution. It is a string.
targetObjectPropertyName	string	Required within parent	The name of the property on the target object that is used for resolution. It is a string.

Update event definition — response body — labels

Field	Type	Presence	Description and constraints
$	object	Root
plural	string	Optional	The plural form of the label for the event type. This is a string.
singular	string	Required within parent	The singular form of the label for the event type. This is a string and is required.

Update property — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A description of the property that will be shown as help text in HubSpot.
displayOrder	integer	Optional	For not hidden properties, indicates the order to display the property on the record's activity timeline (ex: displayOrder: 0 is at the top). Format: int32
hidden	boolean	Optional	Controls whether or not this property is displayed on the record's activity timeline.
label	string	Optional	Human readable label for the property. Used in HubSpot UI.
options	array	Optional	A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
options[]	Model	Each item	Expand Create Property — request body — body options item

Referenced models: Create Property — request body — body options item