> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. --- id: 8663023c-8308-4499-a4da-bf02383fef11 --- # Update list name > Update the name of a list. The name must be globally unique relative to all other public lists in the portal. export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
; }; export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, crm, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel, crmLevel}) => { const translations = { description: "Requires one of the following products or higher.", productNames: { marketing: "Marketing Hub", sales: "Sales Hub", service: "Service Hub", cms: "Content Hub", data: "Data Hub", commerce: "Revenue Hub", crm: "Smart CRM" }, tiers: { free: "Free", starter: "Starter", professional: "Professional", enterprise: "Enterprise" } }; const translateTier = tier => { if (!tier) return ''; const lowerTier = tier.toLowerCase(); return translations.tiers[lowerTier] || tier; }; const products = [{ name: marketing ? translations.productNames.marketing : '', level: translateTier(marketingLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/MarketingHub.svg", alt: "Marketing Hub" }, { name: sales ? translations.productNames.sales : '', level: translateTier(salesLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SalesHub.svg", alt: "Sales Hub" }, { name: service ? translations.productNames.service : '', level: translateTier(serviceLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ServiceHub.svg", alt: "Service Hub" }, { name: cms ? translations.productNames.cms : '', level: translateTier(cmsLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ContentHub.svg", alt: "Content Hub" }, { name: data ? translations.productNames.data : '', level: translateTier(dataLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/DataHub.svg", alt: "Data Hub" }, { name: commerce ? translations.productNames.commerce : '', level: translateTier(commerceLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg", alt: "Revenue Hub" }, { name: crm ? translations.productNames.crm : '', level: translateTier(crmLevel), icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SmartCRM.svg", alt: "Smart CRM" }].filter(product => product.name && product.level); if (products.length === 0) return null; return
{translations.description}
{products.map((product, index) =>
{product.alt} {product.name} - {product.level}
)}
; }; ## OpenAPI ````yaml specs/2026-03/crm-lists-v2026-03.json PUT /crm/lists/2026-03/{listId}/update-list-name openapi: 3.0.1 info: title: CRM Lists description: Basepom for all HubSpot Projects version: 2026-03 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Batch - name: Search paths: /crm/lists/2026-03/{listId}/update-list-name: put: tags: - Basic summary: Update List Name description: >- Update the name of a list. The name must be globally unique relative to all other public lists in the portal. operationId: >- put-/crm/lists/2026-03/{listId}/update-list-name_/crm/lists/v3/{listId}/update-list-name parameters: - name: listId in: path description: The **ILS ID** of the list to update. required: true style: simple explode: false schema: type: string - name: includeFilters in: query description: >- A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. required: false style: form explode: true schema: type: boolean default: false - name: listName in: query description: The name to update the list to. required: false style: form explode: true schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ListUpdateResponse' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - crm.lists.write - crm.segments.read - oauth2: - cms.membership.access_groups.write - crm.lists.read - oauth2: - crm.segments.read - crm.segments.write - oauth2: - crm.lists.read - crm.segments.write - oauth2: - crm.lists.read - crm.lists.write - oauth2: - cms.membership.access_groups.write - crm.segments.read components: schemas: ListUpdateResponse: type: object properties: updatedList: $ref: '#/components/schemas/PublicObjectList' PublicObjectList: required: - listId - listVersion - name - objectTypeId - processingStatus - processingType type: object properties: createdAt: type: string description: The time when the list was created. format: date-time createdById: type: string description: The ID of the user that created the list. deletedAt: type: string description: The time when the list was deleted. format: date-time filterBranch: description: >- Defines the filter criteria for the list, allowing for complex logical operations and nested filter branches to determine list membership. oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filtersUpdatedAt: type: string description: The time when the filters for this list were last updated. format: date-time listId: type: string description: The **ILS ID** of the list. listPermissions: $ref: '#/components/schemas/PublicListPermissions' listVersion: type: integer description: The version of the list. format: int32 membershipSettings: $ref: '#/components/schemas/PublicMembershipSettings' name: type: string description: The name of the list. objectTypeId: type: string description: The object type of the list. processingStatus: type: string description: The processing status of the list. processingType: type: string description: The processing type of the list. size: type: integer description: Size of the list format: int64 updatedAt: type: string description: The time the list was last updated. format: date-time updatedById: type: string description: The ID of the user that last updated the list. Error: required: - category - correlationId - message type: object properties: category: type: string description: The error category context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- A unique identifier for the request. Include this value with any error reports or support tickets format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: further information about the error items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- A map of link names to associated URIs containing documentation about the error or recommended remediation steps message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate example: An error occurred subCategory: type: string description: >- A specific category that contains more specific detail about the error description: >- Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base PublicOrFilterBranch: title: OR required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: >- The logical operator used to combine the filters within the branch (OR). filterBranchType: type: string description: The type of the filter branch (OR). default: OR enum: - OR filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicAndFilterBranch: title: AND required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: Filter branch operator (AND) filterBranchType: type: string description: Type of filter branch (AND) default: AND enum: - AND filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAllFilterBranch: title: NOT_ALL required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: The operator used to combine filters within the branch (NOT_ALL). filterBranchType: type: string description: The type of the filter branch (NOT_ALL). default: NOT_ALL enum: - NOT_ALL filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAnyFilterBranch: title: NOT_ANY required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: >- Specifies the logical operator used to combine filters within the branch (NOT_ANY). filterBranchType: type: string description: Indicates the type of filter branch (NOT_ANY). default: NOT_ANY enum: - NOT_ANY filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicRestrictedFilterBranch: title: RESTRICTED required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: >- The logical operator used to combine filters within the restricted filter branch. filterBranchType: type: string description: Specifies the type of the filter branch (RESTRICTED). default: RESTRICTED enum: - RESTRICTED filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicUnifiedEventsFilterBranch: title: UNIFIED_EVENTS required: - eventTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - operator type: object properties: coalescingRefineBy: description: Specifies the criteria for refining the filter by coalescing. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: >- The identifier for the type of event associated with the filter branch. filterBranchOperator: type: string description: >- The logical operator used to combine filters within the branch (AND). filterBranchType: type: string description: The type of the filter branch (UNIFIED_EVENTS). default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' operator: type: string description: >- Defines the operation to be applied within the filter branch (HAS_COMPLETED, HAS_NOT_COMPLETED). enum: - HAS_COMPLETED - HAS_NOT_COMPLETED pruningRefineBy: oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicAssociationFilterBranch: title: ASSOCIATION required: - associationCategory - associationTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - objectTypeId - operator type: object properties: associationCategory: type: string description: >- Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). associationTypeId: type: integer description: Type id of the association format: int32 filterBranchOperator: type: string description: Filter branch operator (AND) filterBranchType: type: string description: Type of the filter branch (ASSOCIATION) default: ASSOCIATION enum: - ASSOCIATION filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' objectTypeId: type: string description: >- The ID representing the type of object associated with the filter branch. operator: type: string description: >- Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST). x-hubspot-sub-type-impl: true PublicListPermissions: required: - teamsWithEditAccess - usersWithEditAccess type: object properties: teamsWithEditAccess: type: array items: type: integer format: int32 usersWithEditAccess: type: array items: type: integer format: int32 PublicMembershipSettings: type: object properties: includeUnassigned: type: boolean description: Indicates whether unassigned memberships should be included. membershipTeamId: type: integer description: The ID of the team associated with the membership. format: int32 ErrorDetail: required: - message type: object properties: code: type: string description: The status code associated with the error detail context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: '{missingScopes=[scope1, scope2]}' in: type: string description: The name of the field or parameter in which the error was found. message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate subCategory: type: string description: >- A specific category that contains more specific detail about the error description: >- Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response. PublicPropertyFilter: title: PROPERTY required: - filterType - operation - property type: object properties: filterType: type: string description: Indicates that the filter (PROPERTY). default: PROPERTY enum: - PROPERTY operation: description: >- Defines the operation to be performed on the property, such as comparison or value matching. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' property: type: string description: Specifies the name of the property that the filter is applied to. x-hubspot-sub-type-impl: true PublicAssociationInListFilter: title: ASSOCIATION required: - associationCategory - associationTypeId - coalescingRefineBy - filterType - listId - operator type: object properties: associationCategory: type: string description: >- Defines the category of the association, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK). associationTypeId: type: integer description: The ID representing the type of association being filtered. format: int32 coalescingRefineBy: description: Specifies the criteria for refining the association filter. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: >- Indicates the type of filter being applied, which is 'ASSOCIATION' by default. default: ASSOCIATION enum: - ASSOCIATION listId: type: string description: The ID of the list used in the association filter. operator: type: string description: >- Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'. toObjectType: type: string description: The type of object that the association filter is targeting. toObjectTypeId: type: string description: >- The ID representing the type of object that the association filter is targeting. x-hubspot-sub-type-impl: true PublicPageViewAnalyticsFilter: title: PAGE_VIEW required: - filterType - operator - pageUrl type: object properties: coalescingRefineBy: description: Specifies the criteria for refining the filter by coalescing. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' enableTracking: type: boolean description: Indicates whether tracking is enabled for the page view. filterType: type: string description: Indicates the type of filter being applied (PAGE_VIEW). default: PAGE_VIEW enum: - PAGE_VIEW operator: type: string description: >- Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS). pageUrl: type: string description: The URL of the page to be used in the filter. pruningRefineBy: description: Specifies the criteria for refining the filter by pruning. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicCtaAnalyticsFilter: title: CTA required: - ctaName - filterType - operator type: object properties: coalescingRefineBy: description: Specifies the criteria for refining the filter by coalescing. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' ctaName: type: string description: The name of the Call-to-Action (CTA) to be used in the filter. filterType: type: string description: Indicates the type of filter being applied, which is (CTA). default: CTA enum: - CTA operator: type: string description: >- Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT). pruningRefineBy: description: Specifies the criteria for refining the filter by pruning. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicEventAnalyticsFilter: title: EVENT required: - eventId - filterType - operator type: object properties: coalescingRefineBy: description: Specifies the criteria for refining the event filter by coalescing. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventId: type: string description: The ID of the event to be used in the filter. filterType: type: string description: Indicates the type of filter being applied (EVENT). default: EVENT enum: - EVENT operator: type: string description: >- Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT). pruningRefineBy: description: Specifies the criteria for refining the event filter by pruning. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionFilter: title: FORM_SUBMISSION required: - filterType - operator type: object properties: coalescingRefineBy: description: Specifies the criteria for refining the filter by coalescing. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: Indicates the type of filter (FORM_SUBMISSION). default: FORM_SUBMISSION enum: - FORM_SUBMISSION formId: type: string description: The ID of the form used in the filter. operator: type: string description: >- Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT). enum: - FILLED_OUT - NOT_FILLED_OUT pruningRefineBy: description: Specifies the criteria for refining the filter by pruning. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionOnPageFilter: title: FORM_SUBMISSION_ON_PAGE required: - filterType - operator - pageId type: object properties: coalescingRefineBy: description: Defines the criteria for refining the filter by coalescing. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: Indicates the type of filter (FORM_SUBMISSION_ON_PAGE). default: FORM_SUBMISSION_ON_PAGE enum: - FORM_SUBMISSION_ON_PAGE formId: type: string description: The ID of the form associated with the submission filter. operator: type: string description: Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT). enum: - FILLED_OUT - NOT_FILLED_OUT pageId: type: string description: The ID of the page where the form submission occurred. pruningRefineBy: description: Specifies the criteria for refining the filter by pruning. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicIntegrationEventFilter: title: INTEGRATION_EVENT required: - eventTypeId - filterLines - filterType type: object properties: eventTypeId: type: integer description: >- The ID representing the type of event for the integration event filter. format: int32 filterLines: type: array items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: Indicates the type of filter (INTEGRATION_EVENT). default: INTEGRATION_EVENT enum: - INTEGRATION_EVENT x-hubspot-sub-type-impl: true PublicEmailSubscriptionFilter: title: EMAIL_SUBSCRIPTION required: - acceptedStatuses - filterType - subscriptionIds type: object properties: acceptedStatuses: type: array items: type: string filterType: type: string description: Indicates the type of filter (EMAIL_SUBSCRIPTION). default: EMAIL_SUBSCRIPTION enum: - EMAIL_SUBSCRIPTION subscriptionIds: type: array items: type: string subscriptionType: type: string description: >- The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT). x-hubspot-sub-type-impl: true PublicCommunicationSubscriptionFilter: title: COMMUNICATION_SUBSCRIPTION required: - acceptedOptStates - channel - filterType - subscriptionIds - subscriptionType type: object properties: acceptedOptStates: type: array items: type: string businessUnitId: type: string description: The ID of the business unit associated with the subscription filter. channel: type: string description: >- Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS). filterType: type: string description: Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION) default: COMMUNICATION_SUBSCRIPTION enum: - COMMUNICATION_SUBSCRIPTION subscriptionIds: type: array items: type: string subscriptionType: type: string description: >- Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION) x-hubspot-sub-type-impl: true PublicSurveyMonkeyFilter: title: SURVEY_MONKEY required: - filterType - operator - surveyId type: object properties: filterType: type: string description: Indicates the type of filter being applied (SURVEY_MONKEY). default: SURVEY_MONKEY enum: - SURVEY_MONKEY operator: type: string description: >- Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY). surveyId: type: string description: The ID of the survey associated with the filter. x-hubspot-sub-type-impl: true PublicSurveyMonkeyValueFilter: title: SURVEY_MONKEY_VALUE required: - filterType - operator - surveyId - surveyQuestion - valueComparison type: object properties: filterType: type: string description: Defines the type of filter (SURVEY_MONKEY_VALUE). default: SURVEY_MONKEY_VALUE enum: - SURVEY_MONKEY_VALUE operator: type: string description: >- Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE). surveyAnswerColId: type: string description: The column ID of the survey answer used in the filter. surveyAnswerRowId: type: string description: The row ID of the survey answer used in the filter. surveyId: type: string description: The ID of the survey used in the filter. surveyQuestion: type: string description: The question from the survey used in the filter. valueComparison: description: Specifies the operation used to compare the survey answer value. oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' x-hubspot-sub-type-impl: true PublicWebinarFilter: title: WEBINAR required: - filterType - operator type: object properties: filterType: type: string description: Indicates the type of filter, (WEBINAR). default: WEBINAR enum: - WEBINAR operator: type: string description: >- Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE). webinarId: type: string description: The ID of the webinar associated with the filter. x-hubspot-sub-type-impl: true PublicEmailEventFilter: title: EMAIL_EVENT required: - appId - emailId - filterType - level - operator type: object properties: appId: type: string description: The ID of the application associated with the email event filter. clickUrl: type: string description: The URL that was clicked in the email event. emailId: type: string description: The ID of the email associated with the event filter. filterType: type: string description: Indicates the type of filter (EMAIL_EVENT). default: EMAIL_EVENT enum: - EMAIL_EVENT level: type: string description: >- Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP. operator: type: string description: >- Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED). enum: - BOUNCED - LINK_CLICKED - MARKED_SPAM - OPENED - OPENED_BUT_LINK_NOT_CLICKED - OPENED_BUT_NOT_REPLIED - RECEIVED - RECEIVED_BUT_NOT_OPENED - REPLIED - SENT - SENT_BUT_LINK_NOT_CLICKED - SENT_BUT_NOT_RECEIVED - UNSUBSCRIBED pruningRefineBy: description: Specifies the criteria for refining the filter by pruning. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicPrivacyAnalyticsFilter: title: PRIVACY required: - filterType - operator - privacyName type: object properties: filterType: type: string description: Specifies the type of filter (PRIVACY). default: PRIVACY enum: - PRIVACY operator: type: string description: >- Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED). privacyName: type: string description: The name of the privacy setting used in the filter. x-hubspot-sub-type-impl: true PublicAdsSearchFilter: title: ADS_SEARCH required: - adNetwork - entityType - filterType - operator - searchTermType - searchTerms type: object properties: adNetwork: type: string description: Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL) entityType: type: string description: Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN) filterType: type: string description: Type of the filter (ADS_SEARCH) default: ADS_SEARCH enum: - ADS_SEARCH operator: type: string description: >- Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN) searchTermType: type: string description: Search term to match an ad searchTerms: type: array items: type: string x-hubspot-sub-type-impl: true PublicAdsTimeFilter: title: ADS_TIME required: - filterType - pruningRefineBy type: object properties: filterType: type: string description: Filter type (ADS_TIME) default: ADS_TIME enum: - ADS_TIME pruningRefineBy: description: Refinement criteria oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicInListFilter: title: IN_LIST required: - filterType - listId - operator type: object properties: filterType: type: string description: Indicates the type of filter being applied (IN_LIST). default: IN_LIST enum: - IN_LIST listId: type: string description: The ID of the list used in the association filter. metadata: $ref: '#/components/schemas/PublicInListFilterMetadata' operator: type: string description: >- Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST). x-hubspot-sub-type-impl: true PublicUnifiedEventsFilter: title: UNIFIED_EVENTS required: - filterLines - filterType type: object properties: coalescingRefineBy: description: Specifies the criteria for refining the filter by coalescing. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: The identifier for the type of event in the unified events filter. filterLines: type: array items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: Indicates the type of filter being applied (UNIFIED_EVENTS). default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS pruningRefineBy: description: Specifies the criteria for refining the filter by pruning. oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicConstantFilter: title: CONSTANT required: - filterType - shouldAccept type: object properties: filterType: type: string description: Specifies the type of filter, which is (CONSTANT). default: CONSTANT enum: - CONSTANT shouldAccept: type: boolean description: Indicates whether the filter should accept the condition. source: type: string description: Defines the source of the constant filter. x-hubspot-sub-type-impl: true PublicNumOccurrencesRefineBy: title: NUM_OCCURRENCES required: - type type: object properties: maxOccurrences: type: integer description: The maximum number of occurrences allowed. format: int32 minOccurrences: type: integer description: The minimum number of occurrences required. format: int32 type: type: string description: The type of refinement (NUM_OCCURRENCES). default: NUM_OCCURRENCES enum: - NUM_OCCURRENCES x-hubspot-sub-type-impl: true PublicSetOccurrencesRefineBy: title: SET_OCCURRENCES required: - setType - type type: object properties: setType: type: string description: >- Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY). type: type: string description: Specifies the type of refinement (SET_OCCURRENCES). default: SET_OCCURRENCES enum: - SET_OCCURRENCES x-hubspot-sub-type-impl: true PublicRelativeComparativeTimestampRefineBy: title: RELATIVE_COMPARATIVE required: - comparison - timeOffset - type type: object properties: comparison: type: string description: >- Defines the comparison operation to be used in the refinement (BEFORE, AFTER). timeOffset: $ref: '#/components/schemas/PublicTimeOffset' type: type: string description: Specifies the type of refinement, (RELATIVE_COMPARATIVE). default: RELATIVE_COMPARATIVE enum: - RELATIVE_COMPARATIVE x-hubspot-sub-type-impl: true PublicRelativeRangedTimestampRefineBy: title: RELATIVE_RANGED required: - lowerBoundOffset - rangeType - type - upperBoundOffset type: object properties: lowerBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' rangeType: type: string description: >- Specifies the type of range for the refinement criteria (BETWEEN, NOT_BETWEEN). type: type: string description: Indicates the type of refinement (RELATIVE_RANGED). default: RELATIVE_RANGED enum: - RELATIVE_RANGED upperBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' x-hubspot-sub-type-impl: true PublicAbsoluteComparativeTimestampRefineBy: title: ABSOLUTE_COMPARATIVE required: - comparison - timestamp - type type: object properties: comparison: type: string description: Timestamp comparison options (BEFORE, AFTER) timestamp: type: integer description: Timestamp to be used in refine by criteria format: int64 type: type: string description: type of refine by criteria (ABSOLUTE_COMPARATIVE) default: ABSOLUTE_COMPARATIVE enum: - ABSOLUTE_COMPARATIVE x-hubspot-sub-type-impl: true PublicAbsoluteRangedTimestampRefineBy: title: ABSOLUTE_RANGED required: - lowerTimestamp - rangeType - type - upperTimestamp type: object properties: lowerTimestamp: type: integer description: Lower range timestamp of refinement criteria format: int64 rangeType: type: string description: Type of range of refinement critaria (BETWEEN, NOT_BETWEEN) type: type: string description: type of refine by criteria (ABSOLUTE_RANGED) default: ABSOLUTE_RANGED enum: - ABSOLUTE_RANGED upperTimestamp: type: integer description: Upper range timestamp of refinement criteria format: int64 x-hubspot-sub-type-impl: true PublicAllHistoryRefineBy: title: ALL_HISTORY required: - type type: object properties: type: type: string description: Type of refine by (ALL_HISTORY) default: ALL_HISTORY enum: - ALL_HISTORY x-hubspot-sub-type-impl: true PublicTimePointOperation: title: TIME_POINT required: - includeObjectsWithNoValueSet - operationType - operator - timePoint - type type: object properties: endpointBehavior: type: string description: Describes the behavior at the endpoint of the time point operation. includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: Specifies the type of operation (TIME_POINT). default: TIME_POINT enum: - TIME_POINT operator: type: string description: >- Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER). propertyParser: type: string description: >- Specifies the parser used for interpreting the property in the operation. timePoint: description: >- Defines the specific point in time for the operation, which can be a date, indexed time, or property-referenced time. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' type: type: string description: Defines the type of operation being performed. x-hubspot-sub-type-impl: true PublicRangedTimeOperation: title: TIME_RANGED required: - includeObjectsWithNoValueSet - lowerBoundTimePoint - operationType - operator - type - upperBoundTimePoint type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. lowerBoundEndpointBehavior: type: string description: >- Describes the behavior at the lower bound endpoint of the time range. lowerBoundTimePoint: description: Defines the lower bound time point for the operation. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' operationType: type: string description: Specifies the type of operation (TIME_RANGED). operator: type: string description: >- Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN). propertyParser: type: string description: Specifies the parser used for the property in the operation. type: type: string description: Specifies the type of operation (TIME_RANGED). default: TIME_RANGED enum: - TIME_RANGED upperBoundEndpointBehavior: type: string description: >- Describes the behavior at the upper bound endpoint of the time range. upperBoundTimePoint: description: Defines the upper bound time point for the operation. oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' x-hubspot-sub-type-impl: true PublicBoolPropertyOperation: title: BOOL required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: Specifies the type of operation (BOOL). default: BOOL enum: - BOOL operator: type: string description: >- Defines the operation to be applied in the boolean property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO). value: type: boolean description: The boolean value to be used in the operation. x-hubspot-sub-type-impl: true PublicNumberPropertyOperation: title: NUMBER required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: Specifies the type of operation (NUMBER). default: NUMBER enum: - NUMBER operator: type: string description: >- Defines the operation to be applied in the number property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL_TO, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO). value: type: number description: The numeric value to be used in the operation. x-hubspot-sub-type-impl: true PublicStringPropertyOperation: title: STRING required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: Specifies the type of operation (STRING). default: STRING enum: - STRING operator: type: string description: >- Defines the operation to be applied in the string property operation ()IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, HAS_EVER_CONTAINED, HAS_NEVER_CONTAINED). value: type: string description: The string value to be used in the operation. x-hubspot-sub-type-impl: true PublicDateTimePropertyOperation: title: DATETIME required: - includeObjectsWithNoValueSet - operationType - operator - requiresTimeZoneConversion - timestamp type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Specifies whether objects without a set value should be included in the operation. operationType: type: string description: The type of operation (DATETIME). default: DATETIME enum: - DATETIME operator: type: string description: >- Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER). requiresTimeZoneConversion: type: boolean description: >- Indicates whether the timestamp requires conversion to a different time zone. timestamp: type: integer description: The specific point in time used in the operation. format: int64 x-hubspot-sub-type-impl: true PublicRangedDatePropertyOperation: title: RANGED_DATE required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - requiresTimeZoneConversion - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Specifies whether objects without a set value should be included in the operation. lowerBound: type: integer description: The lower limit of the date range for the operation. format: int64 operationType: type: string description: Specifies the type of operation (RANGED_DATE). default: RANGED_DATE enum: - RANGED_DATE operator: type: string description: >- Defines the operation to be applied in the ranged date property operation (IS_BETWEEN, IS_NOT_BETWEEN). requiresTimeZoneConversion: type: boolean description: >- Indicates whether the operation requires conversion to a different time zone. upperBound: type: integer description: The upper limit of the date range for the operation. format: int64 x-hubspot-sub-type-impl: true PublicComparativePropertyUpdatedOperation: title: COMPARATIVE_PROPERTY_UPDATED required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: The name of the property to compare against in the operation. defaultComparisonValue: type: string description: >- The default value used for comparison if the actual comparison property value is not set. includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: Specifies the type of operation (COMPARATIVE_PROPERTY_UPDATED). default: COMPARATIVE_PROPERTY_UPDATED enum: - COMPARATIVE_PROPERTY_UPDATED operator: type: string description: >- Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER). x-hubspot-sub-type-impl: true PublicComparativeDatePropertyOperation: title: COMPARATIVE_DATE required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: The name of the property to compare against in the operation. defaultComparisonValue: type: string description: >- The default value used for comparison if the actual comparison property value is not set. includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: The type of operation (COMPARATIVE_DATE). default: COMPARATIVE_DATE enum: - COMPARATIVE_DATE operator: type: string description: >- Defines the operation to be applied in the comparative date property operation (IS_BEFORE, IS_AFTER). x-hubspot-sub-type-impl: true PublicRollingDateRangePropertyOperation: title: ROLLING_DATE_RANGE required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator - requiresTimeZoneConversion type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. numberOfDays: type: integer description: >- The number of days to be considered in the rolling date range operation. format: int32 operationType: type: string description: Specifies the type of operation (ROLLING_DATE_RANGE). default: ROLLING_DATE_RANGE enum: - ROLLING_DATE_RANGE operator: type: string description: >- Defines the operation to be applied within the rolling date range property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW). requiresTimeZoneConversion: type: boolean description: >- Specifies whether the operation requires conversion to a different time zone. x-hubspot-sub-type-impl: true PublicRollingPropertyUpdatedOperation: title: ROLLING_PROPERTY_UPDATED required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. numberOfDays: type: integer description: >- The number of days to be considered in the rolling property updated operation. format: int32 operationType: type: string description: Specifies the type of operation (ROLLING_PROPERTY_UPDATED). default: ROLLING_PROPERTY_UPDATED enum: - ROLLING_PROPERTY_UPDATED operator: type: string description: >- Defines the operation to be applied within the rolling property updated operation (UPDATED_IN_LAST_X_DAYS, NOT_UPDATED_IN_LAST_X_DAYS). x-hubspot-sub-type-impl: true PublicEnumerationPropertyOperation: title: ENUMERATION required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: Specifies the type of operation (ENUMERATION). default: ENUMERATION enum: - ENUMERATION operator: type: string description: >- Defines the operation to be applied in the enumeration property operation (IS_ANY_OF, IS_NONE_OF, IS_EXACTLY, IS_NOT_EXACTLY, CONTAINS_ALL, DOES_NOT_CONTAIN_ALL, HAS_EVER_BEEN_ANY_OF, HAS_NEVER_BEEN_ANY_OF, HAS_EVER_BEEN_EXACTLY, HAS_NEVER_BEEN_EXACTLY, HAS_EVER_CONTAINED_ALL, HAS_NEVER_CONTAINED_ALL). values: type: array items: type: string x-hubspot-sub-type-impl: true PublicAllPropertyTypesOperation: title: ALL_PROPERTY required: - includeObjectsWithNoValueSet - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean description: Indication of whether objects with no value should be included operationType: type: string description: Type of operation (ALL_PROPERTY) default: ALL_PROPERTY enum: - ALL_PROPERTY operator: type: string description: Operator to be applied (IS_KNOWN, IS_UNKNOWN) x-hubspot-sub-type-impl: true PublicRangedNumberPropertyOperation: title: NUMBER_RANGED required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. lowerBound: type: integer description: The lower limit of the number range for the operation. format: int64 operationType: type: string description: Specifies the type of operation (NUMBER_RANGED). default: NUMBER_RANGED enum: - NUMBER_RANGED operator: type: string description: >- Defines the operation to be applied in the ranged number property operation (IS_BETWEEN, IS_NOT_BETWEEN). upperBound: type: integer description: The upper limit of the number range for the operation. format: int64 x-hubspot-sub-type-impl: true PublicMultiStringPropertyOperation: title: MULTISTRING required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included in the operation. operationType: type: string description: Specifies the type of operation (MULTISTRING). default: MULTISTRING enum: - MULTISTRING operator: type: string description: >- Defines the operation to be applied in the multi-string property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, CONTAINS_EXACTLY, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_EXACTLY, STARTS_WITH, ENDS_WITH). values: type: array items: type: string x-hubspot-sub-type-impl: true PublicDatePropertyOperation: title: DATE required: - day - includeObjectsWithNoValueSet - month - operationType - operator - year type: object properties: day: type: integer description: The day of the month for the date operation. format: int32 includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included. month: type: string description: The month for the date operation. operationType: type: string description: Specifies the type of operation (DATE). default: DATE enum: - DATE operator: type: string description: >- Defines the operation to be applied in the date property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW). year: type: integer description: The year for the date operation. format: int32 x-hubspot-sub-type-impl: true PublicCalendarDatePropertyOperation: title: CALENDAR_DATE required: - includeObjectsWithNoValueSet - operationType - operator - timeUnit type: object properties: fiscalYearStart: type: string description: The month in which the fiscal year starts. enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER includeObjectsWithNoValueSet: type: boolean description: >- Indicates whether objects with no value set for the property should be included. operationType: type: string description: The type of operation, which is (CALENDAR_DATE). default: CALENDAR_DATE enum: - CALENDAR_DATE operator: type: string description: >- Defines the operation to be applied to the calendar date property (IN_THIS_TIME_UNIT, IN_THIS_TIME_UNIT_SO_FAR, IN_NEXT_TIME_UNIT, IN_LAST_TIME_UNIT). timeUnit: type: string description: >- The unit of time to be used in the operation (DAY, WEEK, MONTH, QUARTER, YEAR). timeUnitCount: type: integer description: The count of time units to be applied in the operation (1). format: int32 useFiscalYear: type: boolean description: Specifies whether the fiscal year should be used in the operation. x-hubspot-sub-type-impl: true PublicComparativeStringPropertyOperation: title: COMPARATIVE_STRING required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string defaultComparisonValue: type: string includeObjectsWithNoValueSet: type: boolean operationType: type: string default: COMPARATIVE_STRING enum: - COMPARATIVE_STRING operator: type: string x-hubspot-sub-type-impl: true PublicEventFilterMetadata: required: - operation - property type: object properties: operation: description: Defines the operation to be performed on the property oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' - $ref: '#/components/schemas/PublicComparativeStringPropertyOperation' property: type: string description: Specifies the property on which the operation is to be applied. PublicInListFilterMetadata: required: - id - inListType type: object properties: id: type: string description: The identifier for the filter metadata. inListType: type: string description: >- Specifies the type of list for the filter (WORKFLOWS_ENROLLMENT, WORKFLOWS_ACTIVE, WORKFLOWS_GOAL, WORKFLOWS_COMPLETED, IMPORT, DATASET, DATASETS). PublicTimeOffset: required: - amount - offsetDirection - timeUnit type: object properties: amount: type: integer description: The numerical value representing the quantity of the time offset. format: int64 offsetDirection: type: string description: >- Indicates the direction of the time offset, such as forward or backward. timeUnit: type: string description: >- Specifies the unit of time for the offset, such as days, hours, or minutes. PublicDatePoint: title: DATE required: - day - month - timeType - year - zoneId type: object properties: day: type: integer description: The day component of the date. format: int32 hour: type: integer description: The hour component of the time. format: int32 millisecond: type: integer description: The millisecond component of the time. format: int32 minute: type: integer description: The minute component of the time. format: int32 month: type: integer description: The month component of the date. format: int32 second: type: integer description: The second component of the time. format: int32 timeType: type: string description: Specifies the type of time (DATE). default: DATE enum: - DATE timezoneSource: type: string description: The source of the time zone information. year: type: integer description: The year component of the date. format: int32 zoneId: type: string description: The identifier for the time zone. x-hubspot-sub-type-impl: true PublicIndexedTimePoint: title: INDEXED required: - indexReference - timeType - zoneId type: object properties: indexReference: description: Specifies the reference point in time for the indexed time point. oneOf: - $ref: '#/components/schemas/PublicNowReference' - $ref: '#/components/schemas/PublicTodayReference' - $ref: '#/components/schemas/PublicWeekReference' - $ref: '#/components/schemas/PublicFiscalQuarterReference' - $ref: '#/components/schemas/PublicFiscalYearReference' - $ref: '#/components/schemas/PublicYearReference' - $ref: '#/components/schemas/PublicQuarterReference' - $ref: '#/components/schemas/PublicMonthReference' offset: $ref: '#/components/schemas/PublicIndexOffset' timeType: type: string description: Defines the type of time (INDEXED). default: INDEXED enum: - INDEXED timezoneSource: type: string description: >- Specifies the source of the time zone information for the indexed time point (CUSTOM, USER, PORTAL). zoneId: type: string description: >- Indicates the identifier for the time zone associated with the indexed time point. x-hubspot-sub-type-impl: true PublicPropertyReferencedTime: title: PROPERTY_REFERENCED required: - property - referenceType - timeType - zoneId type: object properties: property: type: string description: >- Specifies the name of the property that the time reference is applied to. referenceType: type: string description: >- Specifies the type of reference for the property (VALUE, UPDATED_AT, ANNIVERSARY, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION). timeType: type: string description: Defines the type of time (PROPERTY_REFERENCED). default: PROPERTY_REFERENCED enum: - PROPERTY_REFERENCED timezoneSource: type: string description: >- Specifies the source of the time zone information for the property (CUSTOM, USER, PORTAL). zoneId: type: string description: >- Indicates the identifier for the time zone associated with the property. x-hubspot-sub-type-impl: true PublicNowReference: title: NOW required: - referenceType type: object properties: hour: type: integer description: The hour component of the current time reference. format: int32 millisecond: type: integer description: The millisecond component of the current time reference. format: int32 minute: type: integer description: The minute component of the current time reference. format: int32 referenceType: type: string description: Indicates the type of reference (NOW). default: NOW enum: - NOW second: type: integer description: The second component of the current time reference. format: int32 x-hubspot-sub-type-impl: true PublicTodayReference: title: TODAY required: - referenceType type: object properties: hour: type: integer description: The hour component of the current day reference. format: int32 millisecond: type: integer description: The millisecond component of the current day reference. format: int32 minute: type: integer description: The minute component of the current day reference. format: int32 referenceType: type: string description: Indicates the type of reference (TODAY). default: TODAY enum: - TODAY second: type: integer description: The second component of the current day reference. format: int32 x-hubspot-sub-type-impl: true PublicWeekReference: title: WEEK required: - dayOfWeek - referenceType type: object properties: dayOfWeek: type: string description: >- The day of the week (SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY). enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY hour: type: integer description: The hour component of the week reference. format: int32 millisecond: type: integer description: The millisecond component of the week reference. format: int32 minute: type: integer description: The minute component of the week reference. format: int32 referenceType: type: string description: Indicates the type of reference (WEEK). default: WEEK enum: - WEEK second: type: integer description: The second component of the week reference. format: int32 x-hubspot-sub-type-impl: true PublicFiscalQuarterReference: title: FISCAL_QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: The day component of the fiscal quarter reference. format: int32 hour: type: integer description: The hour component of the fiscal quarter reference. format: int32 millisecond: type: integer description: The millisecond component of the fiscal quarter reference. format: int32 minute: type: integer description: The minute component of the fiscal quarter reference. format: int32 month: type: integer description: The month component of the fiscal quarter reference. format: int32 referenceType: type: string description: Indicates the type of reference (FISCAL_QUARTER). default: FISCAL_QUARTER enum: - FISCAL_QUARTER second: type: integer description: The second component of the fiscal quarter reference. format: int32 x-hubspot-sub-type-impl: true PublicFiscalYearReference: title: FISCAL_YEAR required: - day - month - referenceType type: object properties: day: type: integer description: The day component of the fiscal year reference. format: int32 hour: type: integer description: The hour component of the fiscal year reference. format: int32 millisecond: type: integer description: The millisecond component of the fiscal year reference. format: int32 minute: type: integer description: The minute component of the fiscal year reference. format: int32 month: type: integer description: The month component of the fiscal year reference. format: int32 referenceType: type: string description: Indicates the type of reference (FISCAL_YEAR). default: FISCAL_YEAR enum: - FISCAL_YEAR second: type: integer description: The second component of the fiscal year reference. format: int32 x-hubspot-sub-type-impl: true PublicYearReference: title: YEAR required: - day - month - referenceType type: object properties: day: type: integer description: The day component of the year reference. format: int32 hour: type: integer description: The hour component of the year reference. format: int32 millisecond: type: integer description: The millisecond component of the year reference. format: int32 minute: type: integer description: The minute component of the year reference. format: int32 month: type: integer description: The month component of the year reference. format: int32 referenceType: type: string description: Indicates the type of reference (YEAR). default: YEAR enum: - YEAR second: type: integer description: The second component of the year reference. format: int32 x-hubspot-sub-type-impl: true PublicQuarterReference: title: QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: The day component of the quarter reference. format: int32 hour: type: integer description: The hour component of the quarter reference. format: int32 millisecond: type: integer description: The millisecond component of the quarter reference. format: int32 minute: type: integer description: The minute component of the quarter reference. format: int32 month: type: integer description: The month component of the quarter reference. format: int32 referenceType: type: string description: Indicates the type of reference (QUARTER). default: QUARTER enum: - QUARTER second: type: integer description: The second component of the quarter reference. format: int32 x-hubspot-sub-type-impl: true PublicMonthReference: title: MONTH required: - day - referenceType type: object properties: day: type: integer description: The day component of the month reference. format: int32 hour: type: integer description: The hour component of the month reference. format: int32 millisecond: type: integer description: The millisecond component of the month reference. format: int32 minute: type: integer description: The minute component of the month reference. format: int32 referenceType: type: string description: Indicates the type of reference, (MONTH). default: MONTH enum: - MONTH second: type: integer description: The second component of the month reference. format: int32 x-hubspot-sub-type-impl: true PublicIndexOffset: type: object properties: days: type: integer description: The number of days to offset. format: int32 hours: type: integer description: The number of hours to offset. format: int32 milliseconds: type: integer description: The number of milliseconds to offset. format: int32 minutes: type: integer description: The number of minutes to offset. format: int32 months: type: integer description: The number of months to offset. format: int32 quarters: type: integer description: The number of quarters to offset. format: int32 seconds: type: integer description: The number of seconds to offset. format: int32 weeks: type: integer description: The number of weeks to offset. format: int32 years: type: integer description: The number of years to offset. format: int32 responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: cms.membership.access_groups.write: '' crm.lists.read: '' crm.lists.write: '' crm.segments.read: '' crm.segments.write: '' ````