HubSpot: Pipeline governance schemas (part 3)
35 HubSpot schemas with complete fields and constraints.
← Pipeline governance operations · All schemas
Retrieve rules — response 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. Known values: PROPERTY_REFERENCED Default: 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. |
Retrieve rules — response 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 | JSON | Required within parent | |
timestamp (anyOf 1) | integer | Alternative | An integer representing the specific point in time to be used for the comparison, formatted as a Unix timestamp in milliseconds. Format: int64 |
timestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | A string indicating the type of refinement, which is 'ABSOLUTE_COMPARATIVE'. Known values: ABSOLUTE_COMPARATIVE Default: ABSOLUTE_COMPARATIVE |
Retrieve rules — response 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 | JSON | Required within parent | |
lowerTimestamp (anyOf 1) | integer | Alternative | An integer representing the lower bound of the timestamp range, specified as a Unix timestamp in milliseconds. Format: int64 |
lowerTimestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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'. Known values: ABSOLUTE_RANGED Default: ABSOLUTE_RANGED |
upperTimestamp | JSON | Required within parent | |
upperTimestamp (anyOf 1) | integer | Alternative | An integer representing the upper bound of the timestamp range, specified as a Unix timestamp in milliseconds. Format: int64 |
upperTimestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve rules — response 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'. Known values: ALL_HISTORY Default: ALL_HISTORY |
Retrieve rules — response 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 | JSON | Optional | |
maxOccurrences (anyOf 1) | integer | Alternative | An integer specifying the maximum number of occurrences allowed. Format: int32 |
maxOccurrences (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minOccurrences | JSON | Optional | |
minOccurrences (anyOf 1) | integer | Alternative | An integer specifying the minimum number of occurrences required. Format: int32 |
minOccurrences (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | A string indicating the type of refinement, which is 'NUM_OCCURRENCES'. Known values: NUM_OCCURRENCES Default: NUM_OCCURRENCES |
Retrieve rules — response 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 Retrieve rules — response 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'. Known values: RELATIVE_COMPARATIVE Default: RELATIVE_COMPARATIVE |
Retrieve rules — response 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 | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | An integer specifying the amount of time units for the offset. Format: int64 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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. |
Retrieve rules — response 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 Retrieve rules — response 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'. Known values: RELATIVE_RANGED Default: RELATIVE_RANGED |
upperBoundOffset | Model | Required within parent | Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset |
Retrieve rules — response 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'. Known values: SET_OCCURRENCES Default: SET_OCCURRENCES |
Retrieve rules — response 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 (anyOf 1) | Model | Alternative | Expand Retrieve rules — response 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 (anyOf 2) | Model | Alternative | Expand Retrieve rules — response 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 (anyOf 3) | Model | Alternative | Expand Retrieve rules — response 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'. Known values: TIME_RANGED Default: 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 (anyOf 1) | Model | Alternative | Expand Retrieve rules — response 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 (anyOf 2) | Model | Alternative | Expand Retrieve rules — response 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 (anyOf 3) | Model | Alternative | Expand Retrieve rules — response 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: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED, Retrieve rules — response 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
Retrieve rules — response body — governance Validation Rules
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
noBackwardsMovementRule | Model | Required within parent | Expand Retrieve rules — response body — governance Validation Rules no Skipping Stages Rule |
noSkippingStagesRule | Model | Required within parent | Expand Retrieve rules — response body — governance Validation Rules no Skipping Stages Rule |
objectCreationRule | Model | Required within parent | Expand Retrieve rules — response body — governance Validation Rules object Creation Rule |
Referenced models: Retrieve rules — response body — governance Validation Rules object Creation Rule, Retrieve rules — response body — governance Validation Rules no Skipping Stages Rule
Retrieve rules — response body — governance Validation Rules no Skipping Stages Rule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enabledForAllStages | boolean | Required within parent | A boolean indicating whether the validation rule is enabled for all stages in the pipeline. |
pipelineStageIds | array | Required within parent | An array of strings representing the specific pipeline stage IDs for which the validation rule is applicable. |
pipelineStageIds[] | string | Each item |
Retrieve rules — response body — governance Validation Rules object Creation Rule
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
pipelineStageIds | array | Required within parent | An array of strings representing the IDs of pipeline stages where objects can be created. |
pipelineStageIds[] | string | Each item |
Start Approval — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
objectId | integer | Required within parent | The unique identifier of the object for which the approval request is being created. It is an integer formatted as int64. Format: int64 |
Start Approval — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approvalId | string | Optional | The unique identifier for the approval process instance associated with this object. |
approvalStatus | string | Required within parent | The current approval status of the object. This indicates whether the object is approved, pending approval, or rejected. Known values: APPROVED, NO_APPROVAL_NEEDED, NOT_APPLICABLE, PENDING, REJECTED |
createdAt | string | Required within parent | The date and time when this approval status record was created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique identifier for this approval status object. |
objectId | string | Required within parent | The unique identifier of the object whose approval status is being tracked. |
objectTypeId | string | Required within parent | The type identifier of the object, indicating what kind of object is being approved. |
pipelineId | string | Required within parent | The unique identifier of the pipeline in which the object is located. |
pipelineStageId | string | Required within parent | The unique identifier of the pipeline stage where the object currently resides. |
updatedAt | string | Required within parent | The date and time when this approval status record was last updated, in ISO 8601 format. Format: date-time |
Update permissions — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
stages | array | Required within parent | An array of stage permission requests, each defined by the PublicStagePermissionRequest schema. This property specifies the permissions to be updated for each stage in the pipeline. |
stages[] | Model | Each item | Expand Update permissions — request body — body stages item |
Referenced models: Update permissions — request body — body stages item
Update permissions — request body — body stages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
permissionMode | string | Required within parent | The mode of permission for the stage. It is a string that can be either 'OPEN' or 'RESTRICTED', indicating the level of access allowed. One of: OPEN, RESTRICTED |
pipelineStageId | string | Required within parent | The unique identifier for the pipeline stage. It is a string that specifies which stage the permissions apply to. |
superAdmin | boolean | Required within parent | A boolean indicating whether super admin users have permission to edit the stage. |
teamIds | array | Required within parent | An array of strings representing the IDs of teams that have permission to edit the stage. |
teamIds[] | string | Each item | |
userIds | array | Required within parent | An array of strings representing the IDs of individual users who have permission to edit the stage. |
userIds[] | string | Each item |
Update permissions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdAt | string | Required within parent | The date and time when these permissions were created, in ISO 8601 format. Format: date-time |
id | string | Required within parent | The unique identifier for this set of pipeline stage permissions. |
objectTypeId | string | Required within parent | The identifier for the type of object associated with these permissions. |
pipelineId | string | Required within parent | The unique identifier for the pipeline to which these stage permissions apply. |
stages | array | Required within parent | An array of stage permissions, each defining access rules for a specific stage within the pipeline. |
stages[] | Model | Each item | Expand Update permissions — response body — stages item |
updatedAt | string | Required within parent | The date and time when these permissions were last updated, in ISO 8601 format. Format: date-time |
Referenced models: Update permissions — response body — stages item
Update permissions — response body — stages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Required within parent | A descriptive label for the stage, used for display purposes. It is a string that helps identify the stage's purpose or function. |
permissionMode | string | Required within parent | Defines the mode of permission for the stage. It is a string that can be either 'OPEN' or 'RESTRICTED', indicating whether the stage is accessible to all users or restricted to certain users or teams. Known values: OPEN, RESTRICTED |
pipelineStageId | string | Required within parent | The unique identifier for the pipeline stage. It is a string that distinguishes this stage from others within the pipeline. |
superAdmin | boolean | Required within parent | A boolean value indicating whether super administrators have access to this stage. If true, super admins can access the stage regardless of other permissions. |
teamIds | array | Required within parent | An array of strings representing the IDs of teams that have access to this stage. This property is used to specify which teams are allowed to interact with the stage. |
teamIds[] | string | Each item | |
userIds | array | Required within parent | An array of strings representing the IDs of individual users who have access to this stage. This property allows for specifying user-level access control. |
userIds[] | string | Each item |
Update rules (Partial) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approvalStage | object | Optional | A rule that defines the approval process for a specific pipeline stage. It is defined using the PublicApprovalStageRuleRequest schema. |
noBackwardsMovementRule | object | Optional | A rule that prevents moving backwards in the pipeline stages. It is defined using the PublicSequenceValidationRule schema. |
noSkippingStagesRule | object | Optional | A rule that prevents skipping stages in the pipeline. It is defined using the PublicSequenceValidationRule schema. |
objectCreationRule | object | Optional | A rule that specifies conditions for object creation within the pipeline. It is defined using the PublicObjectCreationRule schema. |
Update rules (Replace) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approvalStage | Model | Optional | Expand Update rules (Replace) — request body — body approval Stage |
governanceValidationRules | Model | Required within parent | Expand Retrieve rules — response body — governance Validation Rules |
Referenced models: Retrieve rules — response body — governance Validation Rules, Update rules (Replace) — request body — body approval Stage
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, 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: OR filters item filter Type: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, 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: OR filters item filter Type: PAGE VIEW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, 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: OR filters item filter Type: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, 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: OR filters item filter Type: PAGE VIEW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, 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: OR filters item filter Type: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, 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: OR filters item filter Type: PAGE VIEW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, 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: OR filters item filter Type: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, 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: OR filters item filter Type: PAGE VIEW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, 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: OR filters item filter Type: ASSOCIATION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, 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: OR filters item filter Type: PAGE VIEW, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adNetwork | string | Required within parent | A string identifying the ad network where the search is performed. |
entityType | string | Required within parent | A string representing the type of entity being filtered. |
filterType | string | Required within parent | A string indicating the type of filter being applied. Default value is 'ADS_SEARCH'. Default: ADS_SEARCH One of: ADS_SEARCH |
operator | string | Required within parent | A string that specifies the operation or condition applied to the filter. |
searchTermType | string | Required within parent | A string specifying the type of search term used in the filter. |
searchTerms | array | Required within parent | An array of strings containing the terms used to search within the ad network. |
searchTerms[] | string | Each item |
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
acceptedOptStates | array | Required within parent | An array of strings representing the accepted opt-in states for the subscription. |
acceptedOptStates[] | string | Each item | |
businessUnitId | string | Optional | A string representing the ID of the business unit associated with the subscription. |
channel | string | Required within parent | A string indicating the communication channel associated with the subscription. |
filterType | string | Required within parent | A string that indicates the type of filter. The default value is 'COMMUNICATION_SUBSCRIPTION'. Default: COMMUNICATION_SUBSCRIPTION One of: COMMUNICATION_SUBSCRIPTION |
subscriptionIds | array | Required within parent | An array of strings representing the IDs of the subscriptions to be filtered. |
subscriptionIds[] | string | Each item | |
subscriptionType | string | Required within parent | A string indicating the type of subscription. |
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filterType | string | Required within parent | A string indicating the type of filter. It defaults to 'CONSTANT' and must be one of the predefined filter types. Default: CONSTANT One of: CONSTANT |
shouldAccept | boolean | Required within parent | A boolean indicating whether the filter should accept the criteria it evaluates. |
source | string | Optional | A string representing the origin or context from which the filter is applied. |
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
appId | string | Required within parent | A string that identifies the application associated with the email event. |
clickUrl | string | Optional | A string representing the URL that was clicked in the email event. |
emailId | string | Required within parent | A string that uniquely identifies the email associated with the event. |
filterType | string | Required within parent | A string that specifies the type of filter. The default value is 'EMAIL_EVENT'. Default: EMAIL_EVENT One of: EMAIL_EVENT |
level | string | Required within parent | A string representing the level of the email event. |
operator | string | Required within parent | A string that defines the operation or event type for filtering. Valid values include 'LINK_CLICKED', 'MARKED_SPAM', 'OPENED', 'OPENED_BUT_LINK_NOT_CLICKED', 'OPENED_BUT_NOT_REPLIED', 'REPLIED', 'UNSUBSCRIBED', 'BOUNCED', 'RECEIVED', 'RECEIVED_BUT_NOT_OPENED', 'SENT', 'SENT_BUT_LINK_NOT_CLICKED', and 'SENT_BUT_NOT_RECEIVED'. One of: BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED |
pruningRefineBy | JSON | Optional | An object that specifies additional criteria for refining the filter, which can be one of several types such as 'PublicNumOccurrencesRefineBy', 'PublicSetOccurrencesRefineBy', 'PublicRelativeComparativeTimestampRefineBy', 'PublicRelativeRangedTimestampRefineBy', 'PublicAbsoluteComparativeTimestampRefineBy', 'PublicAbsoluteRangedTimestampRefineBy', 'PublicAllHistoryRefineBy', 'PublicTimePointOperation', or 'PublicRangedTimeOperation'. |
pruningRefineBy (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 type: NUM OCCURRENCES |
pruningRefineBy (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 type: SET OCCURRENCES |
pruningRefineBy (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 type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | 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 |
pruningRefineBy (oneOf 9) | Model | Alternative | Expand Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
acceptedStatuses | array | Required within parent | An array of strings indicating the statuses that are accepted for the filter. |
acceptedStatuses[] | string | Each item | |
filterType | string | Required within parent | A string indicating the type of filter, which is 'EMAIL_SUBSCRIPTION' for this component. Default: EMAIL_SUBSCRIPTION One of: EMAIL_SUBSCRIPTION |
subscriptionIds | array | Required within parent | An array of strings representing the IDs of the subscriptions to be filtered. |
subscriptionIds[] | string | Each item | |
subscriptionType | string | Optional | A string representing the type of subscription. |
Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
Referenced models: Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: 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, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Update rules (Replace) — request body — body / approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT