--- title: "Update a workflow" method: PUT path: "/automation/v4/flows/{flowId}" tags: ["Basic"] --- # Update a workflow `PUT /automation/v4/flows/{flowId}` Update the details of an existing automation flow by providing the necessary information in the request body. ## Path parameters - `flowId` string, required ## Request body - union - object - `actions` union[], required - union - ApiStaticBranchAction - `actionId` string, required — The unique identifier for this static branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the static branch action. - `inputValue` union, required — Represents the input value for the static branch action, which can be of various types such as action data, object property, or static value. - ApiActionDataValue - … - ApiObjectPropertyValue - … - ApiStaticValue - … - ApiRelativeDateTimeValue - … - ApiTimestampValue - … - ApiIncrementValue - … - ApiFetchedObjectPropertyValue - … - ApiAppendObjectPropertyValue - … - ApiStaticAppendValue - … - ApiEnrollmentEventPropertyValue - … - ApiActionOutputObjectPropertyValue - … - `staticBranches` ApiStaticBranch[], required - `branchValue` string, required — Specifies the value associated with the static branch. - `connection` ApiConnection - … - `type` 'STATIC_BRANCH', required — Indicates the type of the action, which defaults to STATIC_BRANCH. - ApiListBranchAction - `actionId` string, required — The unique identifier for the list branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the list action. - `listBranches` ApiListBranch[], required - `branchName` string — Specifies the name of the branch. - `connection` ApiConnection - … - `filterBranch` union — Defines the filter criteria for the branch, using logical operators and conditions. - … - `type` 'LIST_BRANCH', required — Indicates the type of action, which defaults to LIST_BRANCH. - ApiABTestBranchAction - `actionId` string, required — The unique identifier for the A/B test branch action. - `testBranches` ApiABTestBranch[], required - `connection` ApiConnection, required - … - `percentage` integer - `type` 'AB_TEST_BRANCH', required — Indicates the type of action, which defaults to AB_TEST_BRANCH. - ApiCustomCodeAction - `actionId` string, required — The unique identifier for the custom code action. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `inputFields` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `outputFields` ApiEnumerationOutputField[], required - `name` string, required — The name of the enumeration output field. - `options` string[], required - `type` 'ENUMERATION', required — Specifies that the type of the field is 'ENUMERATION'. - `runtime` string, required — Specifies the runtime environment for the custom code action. - `secretNames` string[], required - `sourceCode` string, required — Contains the source code for the custom code action. - `type` 'CUSTOM_CODE', required — Indicates the type of the action, which defaults to CUSTOM_CODE. - ApiWebhookAction - `actionId` string, required — The unique identifier for the webhook action. - `authSettings` union — Defines the authentication settings for the webhook, which can include an authentication key or a signature. - ApiAuthKeyWebhookAuthSettings - … - ApiSignatureWebhookAuthSettings - … - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `method` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required — Specifies the HTTP method to be used for the webhook request, with accepted values including CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE. - `queryParams` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `type` 'WEBHOOK', required — Indicates the type of action, which defaults to WEBHOOK. - `webhookUrl` string, required — The URL to which the webhook request will be sent. - ApiSingleConnectionAction - `actionId` string, required — The unique identifier for the single connection action. - `actionTypeId` string, required — The identifier for the type of action being performed. - `actionTypeVersion` integer, required — Specifies the version of the action type. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `fields` object, required — Contains the fields associated with the single connection action. - `type` 'SINGLE_CONNECTION', required — Indicates the type of the action, which defaults to SINGLE_CONNECTION. - `blockedDates` ApiBlockedDate[], required - `dayOfMonth` integer, required — The day of the month for the blocked date. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month of the blocked date, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `year` integer — The year of the blocked date. - `canEnrollFromSalesforce` boolean, required - `customProperties` object, required - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required — Defines the filter branch used to determine list-based enrollment criteria. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `reEnrollmentTriggersFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'LIST_BASED', required — Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'. - `unEnrollObjectsNotMeetingCriteria` boolean, required — Indicates whether objects not meeting the criteria should be unenrolled. - ApiEventBasedEnrollmentCriteria - `eventFilterBranches` PublicUnifiedEventsFilterBranch[], required - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - … - `filters` union[], required - union - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `listMembershipFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `refinementCriteria` union — Specifies additional criteria for refining the enrollment process. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'EVENT_BASED', required — Specifies the type of enrollment criteria, which defaults to 'EVENT_BASED'. - ApiManualEnrollmentCriteria - `shouldReEnroll` boolean, required — Indicates whether the enrollment should be repeated. - `type` 'MANUAL', required — Specifies the type of enrollment criteria, which is 'MANUAL'. - ApiDatasetBasedEnrollmentCriteria - `datasetId` integer, required - `shouldReEnroll` boolean, required - `subviewId` string - `type` 'DATASET', required - `enrollmentSchedule` union - ApiDailyEnrollmentSchedule - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'DAILY', required — Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'WEEKLY', required — Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_SPECIFIC_DAYS', required — Specifies the type of enrollment schedule, which is 'MONTHLY_SPECIFIC_DAYS'. - ApiMonthlyRelativeDaysEnrollmentSchedule - `monthlyRelativeDays` 'FIRST_MONDAY_OF_MONTH' | 'LAST_DAY_OF_MONTH', required — One of the possible relative days to enroll can be: LAST_DAY_OF_MONTH, or FIRST_MONDAY_OF_MONTH - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_RELATIVE_DAYS', required — The type of schedule, always: MONTHLY_RELATIVE_DAYS - ApiYearlyEnrollmentSchedule - `dayOfMonth` integer, required — The day of the month for the yearly enrollment schedule. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month for the yearly enrollment schedule, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'YEARLY', required — Indicates the type of enrollment schedule, which defaults to 'YEARLY'. - ApiPropertyBasedEnrollmentSchedule - `dateProperty` string, required — The property used to determine the date for enrollment scheduling. - `daysDelta` integer, required — The number of days to adjust the enrollment date relative to the dateProperty. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'PROPERTY_BASED', required — Specifies the type of enrollment schedule, which is 'PROPERTY_BASED'. - `yearly` boolean, required — Indicates whether the enrollment schedule is set to repeat annually. - `eventAnchor` union - ApiContactPropertyAnchor - `contactProperty` string, required — Specifies the contact property associated with the anchor. - `type` 'CONTACT_PROPERTY_ANCHOR', required — Indicates the type of the contact property anchor, which defaults to CONTACT_PROPERTY_ANCHOR. - ApiStaticDateAnchor - `dayOfMonth` integer, required — The day of the month for the static date anchor. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month component of the static date anchor, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `type` 'STATIC_DATE_ANCHOR', required — Indicates the type of the date anchor, which defaults to STATIC_DATE_ANCHOR. - `year` integer — The year component of the static date anchor. - `goalFilterBranch` union - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - union - PublicOrFilterBranch — recursive - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch — recursive - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch — recursive - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch — recursive - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch — recursive - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch — recursive - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch — recursive - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `isEnabled` boolean, required - `name` string - `revisionId` string, required - `startActionId` string - `suppressionListIds` integer[], required - `timeWindows` ApiTimeWindow[], required - `day` 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY', required — Specifies the day of the week for the time window, with accepted values being: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY. - `endTime` ApiTimeOfDay - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `startTime` ApiTimeOfDay - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'CONTACT_FLOW', required - `unEnrollmentSetting` ApiUnEnrollmentSetting - `flowIds` string[], required - `type` 'ALL' | 'SELECTIVE', required — Specifies the type of unenrollment setting, with possible values being ALL or SELECTIVE. - `uuid` string - object - `actions` union[], required - union - ApiStaticBranchAction - `actionId` string, required — The unique identifier for this static branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the static branch action. - `inputValue` union, required — Represents the input value for the static branch action, which can be of various types such as action data, object property, or static value. - ApiActionDataValue - … - ApiObjectPropertyValue - … - ApiStaticValue - … - ApiRelativeDateTimeValue - … - ApiTimestampValue - … - ApiIncrementValue - … - ApiFetchedObjectPropertyValue - … - ApiAppendObjectPropertyValue - … - ApiStaticAppendValue - … - ApiEnrollmentEventPropertyValue - … - ApiActionOutputObjectPropertyValue - … - `staticBranches` ApiStaticBranch[], required - `branchValue` string, required — Specifies the value associated with the static branch. - `connection` ApiConnection - … - `type` 'STATIC_BRANCH', required — Indicates the type of the action, which defaults to STATIC_BRANCH. - ApiListBranchAction - `actionId` string, required — The unique identifier for the list branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the list action. - `listBranches` ApiListBranch[], required - `branchName` string — Specifies the name of the branch. - `connection` ApiConnection - … - `filterBranch` union — Defines the filter criteria for the branch, using logical operators and conditions. - … - `type` 'LIST_BRANCH', required — Indicates the type of action, which defaults to LIST_BRANCH. - ApiABTestBranchAction - `actionId` string, required — The unique identifier for the A/B test branch action. - `testBranches` ApiABTestBranch[], required - `connection` ApiConnection, required - … - `percentage` integer - `type` 'AB_TEST_BRANCH', required — Indicates the type of action, which defaults to AB_TEST_BRANCH. - ApiCustomCodeAction - `actionId` string, required — The unique identifier for the custom code action. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `inputFields` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `outputFields` ApiEnumerationOutputField[], required - `name` string, required — The name of the enumeration output field. - `options` string[], required - `type` 'ENUMERATION', required — Specifies that the type of the field is 'ENUMERATION'. - `runtime` string, required — Specifies the runtime environment for the custom code action. - `secretNames` string[], required - `sourceCode` string, required — Contains the source code for the custom code action. - `type` 'CUSTOM_CODE', required — Indicates the type of the action, which defaults to CUSTOM_CODE. - ApiWebhookAction - `actionId` string, required — The unique identifier for the webhook action. - `authSettings` union — Defines the authentication settings for the webhook, which can include an authentication key or a signature. - ApiAuthKeyWebhookAuthSettings - … - ApiSignatureWebhookAuthSettings - … - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `method` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required — Specifies the HTTP method to be used for the webhook request, with accepted values including CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE. - `queryParams` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `type` 'WEBHOOK', required — Indicates the type of action, which defaults to WEBHOOK. - `webhookUrl` string, required — The URL to which the webhook request will be sent. - ApiSingleConnectionAction - `actionId` string, required — The unique identifier for the single connection action. - `actionTypeId` string, required — The identifier for the type of action being performed. - `actionTypeVersion` integer, required — Specifies the version of the action type. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `fields` object, required — Contains the fields associated with the single connection action. - `type` 'SINGLE_CONNECTION', required — Indicates the type of the action, which defaults to SINGLE_CONNECTION. - `blockedDates` ApiBlockedDate[], required - `dayOfMonth` integer, required — The day of the month for the blocked date. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month of the blocked date, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `year` integer — The year of the blocked date. - `customProperties` object, required - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required — Defines the filter branch used to determine list-based enrollment criteria. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `reEnrollmentTriggersFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'LIST_BASED', required — Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'. - `unEnrollObjectsNotMeetingCriteria` boolean, required — Indicates whether objects not meeting the criteria should be unenrolled. - ApiEventBasedEnrollmentCriteria - `eventFilterBranches` PublicUnifiedEventsFilterBranch[], required - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - … - `filters` union[], required - union - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `listMembershipFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `refinementCriteria` union — Specifies additional criteria for refining the enrollment process. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'EVENT_BASED', required — Specifies the type of enrollment criteria, which defaults to 'EVENT_BASED'. - ApiManualEnrollmentCriteria - `shouldReEnroll` boolean, required — Indicates whether the enrollment should be repeated. - `type` 'MANUAL', required — Specifies the type of enrollment criteria, which is 'MANUAL'. - ApiDatasetBasedEnrollmentCriteria - `datasetId` integer, required - `shouldReEnroll` boolean, required - `subviewId` string - `type` 'DATASET', required - `enrollmentSchedule` union - ApiDailyEnrollmentSchedule - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'DAILY', required — Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'WEEKLY', required — Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_SPECIFIC_DAYS', required — Specifies the type of enrollment schedule, which is 'MONTHLY_SPECIFIC_DAYS'. - ApiMonthlyRelativeDaysEnrollmentSchedule - `monthlyRelativeDays` 'FIRST_MONDAY_OF_MONTH' | 'LAST_DAY_OF_MONTH', required — One of the possible relative days to enroll can be: LAST_DAY_OF_MONTH, or FIRST_MONDAY_OF_MONTH - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_RELATIVE_DAYS', required — The type of schedule, always: MONTHLY_RELATIVE_DAYS - ApiYearlyEnrollmentSchedule - `dayOfMonth` integer, required — The day of the month for the yearly enrollment schedule. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month for the yearly enrollment schedule, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'YEARLY', required — Indicates the type of enrollment schedule, which defaults to 'YEARLY'. - ApiPropertyBasedEnrollmentSchedule - `dateProperty` string, required — The property used to determine the date for enrollment scheduling. - `daysDelta` integer, required — The number of days to adjust the enrollment date relative to the dateProperty. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'PROPERTY_BASED', required — Specifies the type of enrollment schedule, which is 'PROPERTY_BASED'. - `yearly` boolean, required — Indicates whether the enrollment schedule is set to repeat annually. - `isEnabled` boolean, required - `name` string - `revisionId` string, required - `startActionId` string - `suppressionFilterBranch` union - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - union - PublicOrFilterBranch — recursive - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch — recursive - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch — recursive - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch — recursive - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch — recursive - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch — recursive - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch — recursive - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `timeWindows` ApiTimeWindow[], required - `day` 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY', required — Specifies the day of the week for the time window, with accepted values being: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY. - `endTime` ApiTimeOfDay - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `startTime` ApiTimeOfDay - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'PLATFORM_FLOW', required - `uuid` string ## Response `200` successful operation - union - object - `actions` union[], required - union - ApiStaticBranchAction - `actionId` string, required — The unique identifier for this static branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the static branch action. - `inputValue` union, required — Represents the input value for the static branch action, which can be of various types such as action data, object property, or static value. - ApiActionDataValue - … - ApiObjectPropertyValue - … - ApiStaticValue - … - ApiRelativeDateTimeValue - … - ApiTimestampValue - … - ApiIncrementValue - … - ApiFetchedObjectPropertyValue - … - ApiAppendObjectPropertyValue - … - ApiStaticAppendValue - … - ApiEnrollmentEventPropertyValue - … - ApiActionOutputObjectPropertyValue - … - `staticBranches` ApiStaticBranch[], required - `branchValue` string, required — Specifies the value associated with the static branch. - `connection` ApiConnection - … - `type` 'STATIC_BRANCH', required — Indicates the type of the action, which defaults to STATIC_BRANCH. - ApiListBranchAction - `actionId` string, required — The unique identifier for the list branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the list action. - `listBranches` ApiListBranch[], required - `branchName` string — Specifies the name of the branch. - `connection` ApiConnection - … - `filterBranch` union — Defines the filter criteria for the branch, using logical operators and conditions. - … - `type` 'LIST_BRANCH', required — Indicates the type of action, which defaults to LIST_BRANCH. - ApiABTestBranchAction - `actionId` string, required — The unique identifier for the A/B test branch action. - `testBranches` ApiABTestBranch[], required - `connection` ApiConnection, required - … - `percentage` integer - `type` 'AB_TEST_BRANCH', required — Indicates the type of action, which defaults to AB_TEST_BRANCH. - ApiCustomCodeAction - `actionId` string, required — The unique identifier for the custom code action. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `inputFields` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `outputFields` ApiEnumerationOutputField[], required - `name` string, required — The name of the enumeration output field. - `options` string[], required - `type` 'ENUMERATION', required — Specifies that the type of the field is 'ENUMERATION'. - `runtime` string, required — Specifies the runtime environment for the custom code action. - `secretNames` string[], required - `sourceCode` string, required — Contains the source code for the custom code action. - `type` 'CUSTOM_CODE', required — Indicates the type of the action, which defaults to CUSTOM_CODE. - ApiWebhookAction - `actionId` string, required — The unique identifier for the webhook action. - `authSettings` union — Defines the authentication settings for the webhook, which can include an authentication key or a signature. - ApiAuthKeyWebhookAuthSettings - … - ApiSignatureWebhookAuthSettings - … - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `method` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required — Specifies the HTTP method to be used for the webhook request, with accepted values including CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE. - `queryParams` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `type` 'WEBHOOK', required — Indicates the type of action, which defaults to WEBHOOK. - `webhookUrl` string, required — The URL to which the webhook request will be sent. - ApiSingleConnectionAction - `actionId` string, required — The unique identifier for the single connection action. - `actionTypeId` string, required — The identifier for the type of action being performed. - `actionTypeVersion` integer, required — Specifies the version of the action type. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `fields` object, required — Contains the fields associated with the single connection action. - `type` 'SINGLE_CONNECTION', required — Indicates the type of the action, which defaults to SINGLE_CONNECTION. - `blockedDates` ApiBlockedDate[], required - `dayOfMonth` integer, required — The day of the month for the blocked date. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month of the blocked date, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `year` integer — The year of the blocked date. - `canEnrollFromSalesforce` boolean, required - `createdAt` string, date-time, required - `crmObjectCreationStatus` 'COMPLETE' | 'PENDING', required - `customProperties` object, required - `dataSources` union[], required - union - ApiAssociationDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required — Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required — The ID representing the type of association. - `name` string, required — The name of the data source. - `objectTypeId` string, required — Represents the ID of the object type associated with the data source. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'ASSOCIATION', required — Indicates the type of data source, which defaults to ASSOCIATION. - ApiAssociationTimestampDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required — Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required — The ID representing the type of association. - `name` string, required — Specifies the name of the data source. - `objectTypeId` string, required — Represents the ID of the object type associated with the data source. - `type` 'ASSOCIATION_TIMESTAMP', required — Indicates the type of the data source, which defaults to ASSOCIATION_TIMESTAMP. - ApiStaticPropertyFilterDataSource - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the static property filter. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `staticValue` string, required — Represents the static value used in the property filter. - `type` 'STATIC_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to STATIC_PROPERTY_FILTER. - ApiEnrolledRecordPropertyFilterDataSource - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the enrolled record property filter. - `recordFieldName` string, required — The name of the field in the record that is being filtered. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'ENROLLED_RECORD_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to ENROLLED_RECORD_PROPERTY_FILTER. - ApiDatasetFieldPropertyFilterDataSource - `datasetFieldName` string, required — Specifies the name of the dataset field used in the property filter. - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the dataset field property filter. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'DATASET_FIELD_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to DATASET_FIELD_PROPERTY_FILTER. - ApiEnrolledArgumentPropertyFilterDataSource - `argumentName` string, required — The name of the argument used in the enrolled argument property filter. - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the enrolled argument property filter. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'ENROLLED_ARGUMENT_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to ENROLLED_ARGUMENT_PROPERTY_FILTER. - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required — Defines the filter branch used to determine list-based enrollment criteria. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `reEnrollmentTriggersFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'LIST_BASED', required — Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'. - `unEnrollObjectsNotMeetingCriteria` boolean, required — Indicates whether objects not meeting the criteria should be unenrolled. - ApiEventBasedEnrollmentCriteria - `eventFilterBranches` PublicUnifiedEventsFilterBranch[], required - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - … - `filters` union[], required - union - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `listMembershipFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `refinementCriteria` union — Specifies additional criteria for refining the enrollment process. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'EVENT_BASED', required — Specifies the type of enrollment criteria, which defaults to 'EVENT_BASED'. - ApiManualEnrollmentCriteria - `shouldReEnroll` boolean, required — Indicates whether the enrollment should be repeated. - `type` 'MANUAL', required — Specifies the type of enrollment criteria, which is 'MANUAL'. - ApiDatasetBasedEnrollmentCriteria - `datasetId` integer, required - `shouldReEnroll` boolean, required - `subviewId` string - `type` 'DATASET', required - `enrollmentSchedule` union - ApiDailyEnrollmentSchedule - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'DAILY', required — Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'WEEKLY', required — Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_SPECIFIC_DAYS', required — Specifies the type of enrollment schedule, which is 'MONTHLY_SPECIFIC_DAYS'. - ApiMonthlyRelativeDaysEnrollmentSchedule - `monthlyRelativeDays` 'FIRST_MONDAY_OF_MONTH' | 'LAST_DAY_OF_MONTH', required — One of the possible relative days to enroll can be: LAST_DAY_OF_MONTH, or FIRST_MONDAY_OF_MONTH - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_RELATIVE_DAYS', required — The type of schedule, always: MONTHLY_RELATIVE_DAYS - ApiYearlyEnrollmentSchedule - `dayOfMonth` integer, required — The day of the month for the yearly enrollment schedule. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month for the yearly enrollment schedule, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'YEARLY', required — Indicates the type of enrollment schedule, which defaults to 'YEARLY'. - ApiPropertyBasedEnrollmentSchedule - `dateProperty` string, required — The property used to determine the date for enrollment scheduling. - `daysDelta` integer, required — The number of days to adjust the enrollment date relative to the dateProperty. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'PROPERTY_BASED', required — Specifies the type of enrollment schedule, which is 'PROPERTY_BASED'. - `yearly` boolean, required — Indicates whether the enrollment schedule is set to repeat annually. - `eventAnchor` union - ApiContactPropertyAnchor - `contactProperty` string, required — Specifies the contact property associated with the anchor. - `type` 'CONTACT_PROPERTY_ANCHOR', required — Indicates the type of the contact property anchor, which defaults to CONTACT_PROPERTY_ANCHOR. - ApiStaticDateAnchor - `dayOfMonth` integer, required — The day of the month for the static date anchor. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month component of the static date anchor, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `type` 'STATIC_DATE_ANCHOR', required — Indicates the type of the date anchor, which defaults to STATIC_DATE_ANCHOR. - `year` integer — The year component of the static date anchor. - `flowType` 'ACTION_SET' | 'UNKNOWN' | 'WORKFLOW', required - `goalFilterBranch` union - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - union - PublicOrFilterBranch — recursive - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch — recursive - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch — recursive - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch — recursive - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch — recursive - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch — recursive - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch — recursive - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `id` string, required - `isEnabled` boolean, required - `name` string - `nextAvailableActionId` string, required - `objectTypeId` string, required - `revisionId` string, required - `startActionId` string - `suppressionListIds` integer[], required - `timeWindows` ApiTimeWindow[], required - `day` 'FRIDAY' | 'MONDAY' | 'SATURDAY' | 'SUNDAY' | 'THURSDAY' | 'TUESDAY' | 'WEDNESDAY', required — Specifies the day of the week for the time window, with accepted values being: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY. - `endTime` ApiTimeOfDay - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `startTime` ApiTimeOfDay - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'CONTACT_FLOW', required - `unEnrollmentSetting` ApiUnEnrollmentSetting - `flowIds` string[], required - `type` 'ALL' | 'SELECTIVE', required — Specifies the type of unenrollment setting, with possible values being ALL or SELECTIVE. - `updatedAt` string, date-time, required - `uuid` string - object - `actions` union[], required - union - ApiStaticBranchAction - `actionId` string, required — The unique identifier for this static branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the static branch action. - `inputValue` union, required — Represents the input value for the static branch action, which can be of various types such as action data, object property, or static value. - ApiActionDataValue - … - ApiObjectPropertyValue - … - ApiStaticValue - … - ApiRelativeDateTimeValue - … - ApiTimestampValue - … - ApiIncrementValue - … - ApiFetchedObjectPropertyValue - … - ApiAppendObjectPropertyValue - … - ApiStaticAppendValue - … - ApiEnrollmentEventPropertyValue - … - ApiActionOutputObjectPropertyValue - … - `staticBranches` ApiStaticBranch[], required - `branchValue` string, required — Specifies the value associated with the static branch. - `connection` ApiConnection - … - `type` 'STATIC_BRANCH', required — Indicates the type of the action, which defaults to STATIC_BRANCH. - ApiListBranchAction - `actionId` string, required — The unique identifier for the list branch action. - `defaultBranch` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `defaultBranchName` string — The name of the default branch in the list action. - `listBranches` ApiListBranch[], required - `branchName` string — Specifies the name of the branch. - `connection` ApiConnection - … - `filterBranch` union — Defines the filter criteria for the branch, using logical operators and conditions. - … - `type` 'LIST_BRANCH', required — Indicates the type of action, which defaults to LIST_BRANCH. - ApiABTestBranchAction - `actionId` string, required — The unique identifier for the A/B test branch action. - `testBranches` ApiABTestBranch[], required - `connection` ApiConnection, required - … - `percentage` integer - `type` 'AB_TEST_BRANCH', required — Indicates the type of action, which defaults to AB_TEST_BRANCH. - ApiCustomCodeAction - `actionId` string, required — The unique identifier for the custom code action. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `inputFields` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `outputFields` ApiEnumerationOutputField[], required - `name` string, required — The name of the enumeration output field. - `options` string[], required - `type` 'ENUMERATION', required — Specifies that the type of the field is 'ENUMERATION'. - `runtime` string, required — Specifies the runtime environment for the custom code action. - `secretNames` string[], required - `sourceCode` string, required — Contains the source code for the custom code action. - `type` 'CUSTOM_CODE', required — Indicates the type of the action, which defaults to CUSTOM_CODE. - ApiWebhookAction - `actionId` string, required — The unique identifier for the webhook action. - `authSettings` union — Defines the authentication settings for the webhook, which can include an authentication key or a signature. - ApiAuthKeyWebhookAuthSettings - … - ApiSignatureWebhookAuthSettings - … - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `method` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE', required — Specifies the HTTP method to be used for the webhook request, with accepted values including CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE. - `queryParams` ApiInputVariable[], required - `name` string, required — The name of the input variable. - `value` union, required — The value associated with the input variable, which can be of various types such as action data, object property, static value, relative date-time, timestamp, increment value, fetched object property, appended object property, static appended value, or enrollment event property. - … - `type` 'WEBHOOK', required — Indicates the type of action, which defaults to WEBHOOK. - `webhookUrl` string, required — The URL to which the webhook request will be sent. - ApiSingleConnectionAction - `actionId` string, required — The unique identifier for the single connection action. - `actionTypeId` string, required — The identifier for the type of action being performed. - `actionTypeVersion` integer, required — Specifies the version of the action type. - `connection` ApiConnection - `edgeType` 'GOTO' | 'STANDARD', required — Specifies the type of connection between actions in the automation flow. - `nextActionId` string, required — The identifier for the subsequent action in the automation sequence. - `fields` object, required — Contains the fields associated with the single connection action. - `type` 'SINGLE_CONNECTION', required — Indicates the type of the action, which defaults to SINGLE_CONNECTION. - `blockedDates` ApiBlockedDate[], required - `dayOfMonth` integer, required — The day of the month for the blocked date. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month of the blocked date, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `year` integer — The year of the blocked date. - `createdAt` string, date-time, required - `crmObjectCreationStatus` 'COMPLETE' | 'PENDING', required - `customProperties` object, required - `dataSources` union[], required - union - ApiAssociationDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required — Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required — The ID representing the type of association. - `name` string, required — The name of the data source. - `objectTypeId` string, required — Represents the ID of the object type associated with the data source. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'ASSOCIATION', required — Indicates the type of data source, which defaults to ASSOCIATION. - ApiAssociationTimestampDataSource - `associationCategory` 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK', required — Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. - `associationTypeId` integer, required — The ID representing the type of association. - `name` string, required — Specifies the name of the data source. - `objectTypeId` string, required — Represents the ID of the object type associated with the data source. - `type` 'ASSOCIATION_TIMESTAMP', required — Indicates the type of the data source, which defaults to ASSOCIATION_TIMESTAMP. - ApiStaticPropertyFilterDataSource - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the static property filter. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `staticValue` string, required — Represents the static value used in the property filter. - `type` 'STATIC_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to STATIC_PROPERTY_FILTER. - ApiEnrolledRecordPropertyFilterDataSource - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the enrolled record property filter. - `recordFieldName` string, required — The name of the field in the record that is being filtered. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'ENROLLED_RECORD_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to ENROLLED_RECORD_PROPERTY_FILTER. - ApiDatasetFieldPropertyFilterDataSource - `datasetFieldName` string, required — Specifies the name of the dataset field used in the property filter. - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the dataset field property filter. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'DATASET_FIELD_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to DATASET_FIELD_PROPERTY_FILTER. - ApiEnrolledArgumentPropertyFilterDataSource - `argumentName` string, required — The name of the argument used in the enrolled argument property filter. - `name` string, required — Defines the name of the data source. - `propertyName` string, required — Specifies the name of the property used in the enrolled argument property filter. - `sortBy` ApiSort - `missing` string — Specifies how to handle sorting when the property is missing. - `order` 'ASC' | 'DESC', required — The order of sorting, with accepted values being ASC for ascending and DESC for descending. - `property` string, required — The name of the property to sort by. - `type` 'ENROLLED_ARGUMENT_PROPERTY_FILTER', required — Indicates the type of data source, which defaults to ENROLLED_ARGUMENT_PROPERTY_FILTER. - `description` string - `enrollmentCriteria` union - ApiListBasedEnrollmentCriteria - `listFilterBranch` union, required — Defines the filter branch used to determine list-based enrollment criteria. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `reEnrollmentTriggersFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'LIST_BASED', required — Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'. - `unEnrollObjectsNotMeetingCriteria` boolean, required — Indicates whether objects not meeting the criteria should be unenrolled. - ApiEventBasedEnrollmentCriteria - `eventFilterBranches` PublicUnifiedEventsFilterBranch[], required - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - … - `filters` union[], required - union - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - … - PublicSetOccurrencesRefineBy - … - PublicRelativeComparativeTimestampRefineBy - … - PublicRelativeRangedTimestampRefineBy - … - PublicAbsoluteComparativeTimestampRefineBy - … - PublicAbsoluteRangedTimestampRefineBy - … - PublicAllHistoryRefineBy - … - PublicTimePointOperation - … - PublicRangedTimeOperation - … - `listMembershipFilterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `refinementCriteria` union — Specifies additional criteria for refining the enrollment process. - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - … - `filters` union[], required - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - … - `filters` union[], required - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - … - `filters` union[], required - … - `objectTypeId` string, required — Represents the ID of the object type associated with the filter branch. - `operator` string, required — Specifies the operator applied to the association filter. - `shouldReEnroll` boolean, required — Determines if objects should be re-enrolled when they meet the criteria again. - `type` 'EVENT_BASED', required — Specifies the type of enrollment criteria, which defaults to 'EVENT_BASED'. - ApiManualEnrollmentCriteria - `shouldReEnroll` boolean, required — Indicates whether the enrollment should be repeated. - `type` 'MANUAL', required — Specifies the type of enrollment criteria, which is 'MANUAL'. - ApiDatasetBasedEnrollmentCriteria - `datasetId` integer, required - `shouldReEnroll` boolean, required - `subviewId` string - `type` 'DATASET', required - `enrollmentSchedule` union - ApiDailyEnrollmentSchedule - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'DAILY', required — Specifies the type of enrollment schedule, which is 'DAILY'. - ApiWeeklyEnrollmentSchedule - `daysOfWeek` string[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'WEEKLY', required — Indicates the type of enrollment schedule, which is 'WEEKLY'. - ApiMonthlySpecificDaysEnrollmentSchedule - `daysOfMonth` integer[], required - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_SPECIFIC_DAYS', required — Specifies the type of enrollment schedule, which is 'MONTHLY_SPECIFIC_DAYS'. - ApiMonthlyRelativeDaysEnrollmentSchedule - `monthlyRelativeDays` 'FIRST_MONDAY_OF_MONTH' | 'LAST_DAY_OF_MONTH', required — One of the possible relative days to enroll can be: LAST_DAY_OF_MONTH, or FIRST_MONDAY_OF_MONTH - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'MONTHLY_RELATIVE_DAYS', required — The type of schedule, always: MONTHLY_RELATIVE_DAYS - ApiYearlyEnrollmentSchedule - `dayOfMonth` integer, required — The day of the month for the yearly enrollment schedule. - `month` 'APRIL' | 'AUGUST' | 'DECEMBER' | 'FEBRUARY' | 'JANUARY' | 'JULY' | 'JUNE' | 'MARCH' | 'MAY' | 'NOVEMBER' | 'OCTOBER' | 'SEPTEMBER', required — The month for the yearly enrollment schedule, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'YEARLY', required — Indicates the type of enrollment schedule, which defaults to 'YEARLY'. - ApiPropertyBasedEnrollmentSchedule - `dateProperty` string, required — The property used to determine the date for enrollment scheduling. - `daysDelta` integer, required — The number of days to adjust the enrollment date relative to the dateProperty. - `timeOfDay` ApiTimeOfDay, required - `hour` integer, required — The hour component of the time, represented as an integer. - `minute` integer, required — The minute component of the time, represented as an integer. - `type` 'PROPERTY_BASED', required — Specifies the type of enrollment schedule, which is 'PROPERTY_BASED'. - `yearly` boolean, required — Indicates whether the enrollment schedule is set to repeat annually. - `flowType` 'ACTION_SET' | 'UNKNOWN' | 'WORKFLOW', required - `id` string, required - `isEnabled` boolean, required - `name` string - `nextAvailableActionId` string, required - `objectTypeId` string, required - `revisionId` string, required - `startActionId` string - `suppressionFilterBranch` union - PublicOrFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'OR', required — Indicates the type of filter branch, defaulting to OR. - `filterBranches` union[], required - union - PublicOrFilterBranch — recursive - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicAndFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'AND', required — Indicates the type of filter branch, defaulting to AND. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch — recursive - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAllFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ALL', required — Indicates the type of filter branch, defaulting to NOT_ALL. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch — recursive - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicNotAnyFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'NOT_ANY', required — Indicates the type of filter branch, defaulting to NOT_ANY. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch — recursive - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicRestrictedFilterBranch - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'RESTRICTED', required — Indicates the type of filter branch, defaulting to RESTRICTED. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch — recursive - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - PublicUnifiedEventsFilterBranch - `coalescingRefineBy` union — Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy. - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - `eventTypeId` string, required — The identifier for the type of event associated with the unified events filter branch. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'UNIFIED_EVENTS', required — Indicates the type of filter branch, defaulting to UNIFIED_EVENTS. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch — recursive - PublicAssociationFilterBranch - … - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - PublicPrivacyAnalyticsFilter - … - PublicAdsSearchFilter - … - PublicAdsTimeFilter - … - PublicInListFilter - … - PublicUnifiedEventsFilter - … - PublicConstantFilter - … - `operator` 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED', required — Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED. - `pruningRefineBy` union - PublicNumOccurrencesRefineBy - `maxOccurrences` integer — Specifies the maximum number of occurrences allowed. - `minOccurrences` integer — Specifies the minimum number of occurrences required. - `type` 'NUM_OCCURRENCES', required — Indicates the type of refinement, which defaults to NUM_OCCURRENCES. - PublicSetOccurrencesRefineBy - `setType` string, required — Defines the set type used for occurrences refinement. - `type` 'SET_OCCURRENCES', required — Specifies the type of refinement, which defaults to SET_OCCURRENCES. - PublicRelativeComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the relative comparative timestamp refinement. - `timeOffset` PublicTimeOffset, required - … - `type` 'RELATIVE_COMPARATIVE', required — Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE. - PublicRelativeRangedTimestampRefineBy - `lowerBoundOffset` PublicTimeOffset, required - … - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'RELATIVE_RANGED', required — Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED. - `upperBoundOffset` PublicTimeOffset, required - … - PublicAbsoluteComparativeTimestampRefineBy - `comparison` string, required — Defines the comparison operation used in the absolute comparative timestamp refinement. - `timestamp` integer, required — Specifies the timestamp used for the absolute comparative refinement, represented as an integer. - `type` 'ABSOLUTE_COMPARATIVE', required — Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE. - PublicAbsoluteRangedTimestampRefineBy - `lowerTimestamp` integer, required — Specifies the lower limit of the timestamp range. - `rangeType` string, required — Specifies the type of range used for the timestamp refinement. - `type` 'ABSOLUTE_RANGED', required — Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED. - `upperTimestamp` integer, required — Specifies the upper limit of the timestamp range. - PublicAllHistoryRefineBy - `type` 'ALL_HISTORY', required — Specifies the type of refinement, which defaults to ALL_HISTORY. - PublicTimePointOperation - `endpointBehavior` string — Describes the behavior of the endpoint in relation to the operation. - `includeObjectsWithNoValueSet` boolean, required — Indicates whether objects without a set value should be included in the operation. - `operationType` 'TIME_POINT', required — Specifies the type of operation, which defaults to 'TIME_POINT'. - `operator` string, required — Defines the operator used in the time point operation. - `propertyParser` string — Defines the parser used to interpret the property value in the operation. - `timePoint` union, required — Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time. - … - `type` string, required — Indicates the specific type of the operation. - PublicRangedTimeOperation - `includeObjectsWithNoValueSet` boolean, required — Determines if objects without a set value should be included in the operation. - `lowerBoundEndpointBehavior` string — Indicates the behavior at the lower bound endpoint of the time range. - `lowerBoundTimePoint` union, required — Defines the lower limit for the time range. - … - `operationType` string, required — Specifies the type of operation, which is 'TIME_RANGED'. - `operator` string, required — Defines the operator used in the time range operation. - `propertyParser` string — Specifies the parser used for the property in the operation. - `type` 'TIME_RANGED', required — Specifies the type of operation, which defaults to 'TIME_RANGED'. - `upperBoundEndpointBehavior` string — Indicates the behavior at the upper bound endpoint of the time range. - `upperBoundTimePoint` union, required — Defines the upper limit for the time range. - … - PublicAssociationFilterBranch - `associationCategory` string, required — Defines the category of the association. - `associationTypeId` integer, required — The ID representing the type of association. - `filterBranchOperator` string, required — Defines the logical operator used to combine multiple filter branches. - `filterBranchType` 'ASSOCIATION', required — Indicates the type of filter branch, defaulting to ASSOCIATION. - `filterBranches` union[], required - union - PublicOrFilterBranch - … - PublicAndFilterBranch - … - PublicNotAllFilterBranch - … - PublicNotAnyFilterBranch - … - PublicRestrictedFilterBranch - … - PublicUnifiedEventsFilterBranch - … - PublicAssociationFilterBranch — recursive - `filters` union[], required - union - PublicPropertyFilter - … - PublicAssociationInListFilter - … - PublicPageViewAnalyticsFilter - … - PublicCtaAnalyticsFilter - … - PublicEventAnalyticsFilter - … - PublicFormSubmissionFilter - … - PublicFormSubmissionOnPageFilter - … - PublicIntegrationEventFilter - … - PublicEmailSubscriptionFilter - … - PublicCommunicationSubscriptionFilter - … - PublicSurveyMonkeyFilter - … - PublicSurveyMonkeyValueFilter - … - PublicWebinarFilter - … - PublicEmailEventFilter - … - … truncated; see the full OpenAPI document linked below ## Other responses - `default` — An error occurred. --- [API](https://skmtc.net/hubspot/apis/automation-automation-v4.md) · [All operations](https://skmtc.net/hubspot/apis/automation-automation-v4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hubspot/automation-automation-v4/versions/614f5ff8daff/schema)