HubSpot: Pipeline governance schemas (part 5)

← Pipeline governance operations · All schemas

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK

Field	Type	Presence	Description and constraints
$	object	Root
dayOfWeek	string	Required within parent	A string representing the day of the week. Valid values include 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY'. One of: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
hour	integer	Optional	An integer representing the hour of the day. Format: int32
millisecond	integer	Optional	An integer representing the millisecond within the second. Format: int32
minute	integer	Optional	An integer representing the minute within the hour. Format: int32
referenceType	string	Required within parent	A string indicating the type of reference, which is 'WEEK' by default. Default: WEEK One of: WEEK
second	integer	Optional	An integer representing the second within the minute. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER

Field	Type	Presence	Description and constraints
$	object	Root
day	integer	Required within parent	An integer representing the day of the month within the fiscal quarter. Format: int32
hour	integer	Optional	An integer representing the hour of the day. Format: int32
millisecond	integer	Optional	An integer representing the millisecond within the second. Format: int32
minute	integer	Optional	An integer representing the minute within the hour. Format: int32
month	integer	Required within parent	An integer representing the month of the fiscal quarter. Format: int32
referenceType	string	Required within parent	A string indicating the type of reference, which is 'FISCAL_QUARTER' by default. Default: FISCAL_QUARTER One of: FISCAL_QUARTER
second	integer	Optional	An integer representing the second within the minute. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR

Field	Type	Presence	Description and constraints
$	object	Root
day	integer	Required within parent	An integer representing the day component of the date. Format: int32
hour	integer	Optional	An integer representing the hour component of the time. Format: int32
millisecond	integer	Optional	An integer representing the millisecond component of the time. Format: int32
minute	integer	Optional	An integer representing the minute component of the time. Format: int32
month	integer	Required within parent	An integer representing the month component of the date. Format: int32
referenceType	string	Required within parent	A string that specifies the type of reference, defaulting to 'FISCAL_YEAR'. Default: FISCAL_YEAR One of: FISCAL_YEAR
second	integer	Optional	An integer representing the second component of the time. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH

Field	Type	Presence	Description and constraints
$	object	Root
day	integer	Required within parent	An integer representing the day of the month. Format: int32
hour	integer	Optional	An integer representing the hour of the day. Format: int32
millisecond	integer	Optional	An integer representing the millisecond within the second. Format: int32
minute	integer	Optional	An integer representing the minute within the hour. Format: int32
referenceType	string	Required within parent	A string indicating the type of reference, which is 'MONTH' by default. Default: MONTH One of: MONTH
second	integer	Optional	An integer representing the second within the minute. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW

Field	Type	Presence	Description and constraints
$	object	Root
hour	integer	Optional	An integer representing the hour of the current time. Format: int32
millisecond	integer	Optional	An integer representing the millisecond of the current time. Format: int32
minute	integer	Optional	An integer representing the minute of the current time. Format: int32
referenceType	string	Required within parent	A string that indicates the type of reference, which is always 'NOW' for this component. Default: NOW One of: NOW
second	integer	Optional	An integer representing the second of the current time. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER

Field	Type	Presence	Description and constraints
$	object	Root
day	integer	Required within parent	An integer representing the day within the month. Format: int32
hour	integer	Optional	An integer representing the hour of the day. Format: int32
millisecond	integer	Optional	An integer representing the millisecond within the second. Format: int32
minute	integer	Optional	An integer representing the minute within the hour. Format: int32
month	integer	Required within parent	An integer representing the month within the quarter. Format: int32
referenceType	string	Required within parent	A string indicating the type of reference, which is 'QUARTER' for this component. Default: QUARTER One of: QUARTER
second	integer	Optional	An integer representing the second within the minute. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY

Field	Type	Presence	Description and constraints
$	object	Root
hour	integer	Optional	An integer representing the hour of the day. Format: int32
millisecond	integer	Optional	An integer representing the millisecond within the second. Format: int32
minute	integer	Optional	An integer representing the minute within the hour. Format: int32
referenceType	string	Required within parent	A string indicating the type of reference, which is 'TODAY' by default. Default: TODAY One of: TODAY
second	integer	Optional	An integer representing the second within the minute. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR

Field	Type	Presence	Description and constraints
$	object	Root
day	integer	Required within parent	An integer representing the day of the month. Format: int32
hour	integer	Optional	An integer representing the hour of the day. Format: int32
millisecond	integer	Optional	An integer representing the millisecond within the second. Format: int32
minute	integer	Optional	An integer representing the minute within the hour. Format: int32
month	integer	Required within parent	An integer representing the month of the year. Format: int32
referenceType	string	Required within parent	A string that indicates the type of reference, which is 'YEAR' by default. Default: YEAR One of: YEAR
second	integer	Optional	An integer representing the second within the minute. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset

Field	Type	Presence	Description and constraints
$	object	Root
days	integer	Optional	An integer representing the number of days for the offset. Format: int32
hours	integer	Optional	An integer representing the number of hours for the offset. Format: int32
milliseconds	integer	Optional	An integer representing the number of milliseconds for the offset. Format: int32
minutes	integer	Optional	An integer representing the number of minutes for the offset. Format: int32
months	integer	Optional	An integer representing the number of months for the offset. Format: int32
quarters	integer	Optional	An integer representing the number of quarters for the offset. Format: int32
seconds	integer	Optional	An integer representing the number of seconds for the offset. Format: int32
weeks	integer	Optional	An integer representing the number of weeks for the offset. Format: int32
years	integer	Optional	An integer representing the number of years for the offset. Format: int32

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED

Field	Type	Presence	Description and constraints
$	object	Root
property	string	Required within parent	A string that denotes the property used as the reference for the time operation.
referenceType	string	Required within parent	A string indicating the type of reference used for the property.
timeType	string	Required within parent	A string indicating the type of time reference, which is 'PROPERTY_REFERENCED' by default. Default: PROPERTY_REFERENCED One of: PROPERTY_REFERENCED
timezoneSource	string	Optional	A string representing the source of the timezone information.
zoneId	string	Required within parent	A string specifying the identifier for the timezone.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE

Field	Type	Presence	Description and constraints
$	object	Root
comparison	string	Required within parent	A string representing the type of comparison to be made with the timestamp.
timestamp	integer	Required within parent	An integer representing the specific point in time to be used for the comparison, formatted as a Unix timestamp in milliseconds. Format: int64
type	string	Required within parent	A string indicating the type of refinement, which is 'ABSOLUTE_COMPARATIVE'. Default: ABSOLUTE_COMPARATIVE One of: ABSOLUTE_COMPARATIVE

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED

Field	Type	Presence	Description and constraints
$	object	Root
lowerTimestamp	integer	Required within parent	An integer representing the lower bound of the timestamp range, specified as a Unix timestamp in milliseconds. Format: int64
rangeType	string	Required within parent	A string representing the type of range being defined.
type	string	Required within parent	A string that specifies the type of refine by operation. The default value is 'ABSOLUTE_RANGED'. Default: ABSOLUTE_RANGED One of: ABSOLUTE_RANGED
upperTimestamp	integer	Required within parent	An integer representing the upper bound of the timestamp range, specified as a Unix timestamp in milliseconds. Format: int64

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	A string representing the type of refinement. The default and only valid value is 'ALL_HISTORY'. Default: ALL_HISTORY One of: ALL_HISTORY

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES

Field	Type	Presence	Description and constraints
$	object	Root
maxOccurrences	integer	Optional	An integer specifying the maximum number of occurrences allowed. Format: int32
minOccurrences	integer	Optional	An integer specifying the minimum number of occurrences required. Format: int32
type	string	Required within parent	A string indicating the type of refinement, which is 'NUM_OCCURRENCES'. Default: NUM_OCCURRENCES One of: NUM_OCCURRENCES

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE

Field	Type	Presence	Description and constraints
$	object	Root
comparison	string	Required within parent	A string representing the comparison operation to be performed.
timeOffset	Model	Required within parent	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset
type	string	Required within parent	A string indicating the type of refinement, which is 'RELATIVE_COMPARATIVE'. Default: RELATIVE_COMPARATIVE One of: RELATIVE_COMPARATIVE

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

Field	Type	Presence	Description and constraints
$	object	Root
amount	integer	Required within parent	An integer specifying the amount of time units for the offset. Format: int64
offsetDirection	string	Required within parent	A string indicating the direction of the time offset. Valid values are 'BEFORE' and 'AFTER'.
timeUnit	string	Required within parent	A string representing the unit of time for the offset, such as 'DAYS', 'HOURS', 'MINUTES', etc.

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED

Field	Type	Presence	Description and constraints
$	object	Root
lowerBoundOffset	Model	Required within parent	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset
rangeType	string	Required within parent	A string indicating the type of range being used for the timestamp refinement.
type	string	Required within parent	A string that specifies the type of the refine by operation, which is 'RELATIVE_RANGED'. Default: RELATIVE_RANGED One of: RELATIVE_RANGED
upperBoundOffset	Model	Required within parent	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES

Field	Type	Presence	Description and constraints
$	object	Root
setType	string	Required within parent	A string that specifies the set type for the occurrences refinement.
type	string	Required within parent	A string representing the type of refinement. The default value is 'SET_OCCURRENCES'. Default: SET_OCCURRENCES One of: SET_OCCURRENCES

Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Field	Type	Presence	Description and constraints
$	object	Root
includeObjectsWithNoValueSet	boolean	Required within parent	A boolean indicating whether to include objects that have no value set.
lowerBoundEndpointBehavior	string	Optional	A string that specifies the behavior of the lower bound endpoint in the time range.
lowerBoundTimePoint	JSON	Required within parent	An object that defines the lower bound time point of the range. It can be a date point, indexed time point, or property-referenced time.
lowerBoundTimePoint (oneOf 1)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE
lowerBoundTimePoint (oneOf 2)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED
lowerBoundTimePoint (oneOf 3)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
operationType	string	Required within parent	A string that specifies the type of operation being performed.
operator	string	Required within parent	A string that defines the operator used in the time operation.
propertyParser	string	Optional	A string that indicates the property parser used in the operation.
type	string	Required within parent	A string that specifies the type of operation, with a default value of 'TIME_RANGED'. Default: TIME_RANGED One of: TIME_RANGED
upperBoundEndpointBehavior	string	Optional	A string that specifies the behavior of the upper bound endpoint in the time range.
upperBoundTimePoint	JSON	Required within parent	An object that defines the upper bound time point of the range. It can be a date point, indexed time point, or property-referenced time.
upperBoundTimePoint (oneOf 1)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE
upperBoundTimePoint (oneOf 2)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED
upperBoundTimePoint (oneOf 3)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED

Update rules (Replace) — request body — body approval Stage

Field	Type	Presence	Description and constraints
$	object	Root
approvalComment	string	Optional	A string that allows an optional comment to be added to the approval rule.
approvalMode	string	Required within parent	Specifies the mode of approval required. It can be either 'ALL', meaning all specified users must approve, or 'ANY', meaning any one of the specified users can approve. One of: ALL, ANY
approverUserIds	array	Required within parent	An array of user IDs representing the users who are authorized to approve the stage transition. Each ID is a string.
approverUserIds[]	string	Each item
conditionalApprovalFilterBranch	JSON	Optional	Defines conditional logic for the approval process using a filter branch. It can be one of several types, such as PublicOrFilterBranch or PublicAndFilterBranch, to specify complex approval conditions.
conditionalApprovalFilterBranch (oneOf 1)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
conditionalApprovalFilterBranch (oneOf 2)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
conditionalApprovalFilterBranch (oneOf 3)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
conditionalApprovalFilterBranch (oneOf 4)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
conditionalApprovalFilterBranch (oneOf 5)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
conditionalApprovalFilterBranch (oneOf 6)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
conditionalApprovalFilterBranch (oneOf 7)	Model	Alternative	Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
pipelineStageId	string	Required within parent	The unique identifier for the pipeline stage that the approval rule applies to. It is a string.

Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED