{ "openapi" : "3.0.1", "info" : { "title" : "Automation Automation V4", "description" : "Basepom for all HubSpot Projects", "version" : "2026-09-beta", "x-hubspot-product-tier-requirements" : { "marketing" : "PROFESSIONAL", "sales" : "PROFESSIONAL", "service" : "PROFESSIONAL", "cms" : "PROFESSIONAL", "commerce" : "PROFESSIONAL", "crmHub" : "PROFESSIONAL", "dataHub" : "PROFESSIONAL" } }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Advanced" }, { "name" : "Basic" }, { "name" : "Batch" } ], "paths" : { "/automation/2026-09-beta/action-types" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve action types", "description" : "Retrieve a list of available workflow action types. This endpoint can be used to understand the types of actions that can be incorporated into automation workflows, which is useful for developers looking to customize or extend workflow capabilities.", "operationId" : "get-/automation/2026-09-beta/action-types_/automation/2026-09-beta/action-types", "parameters" : [ { "name" : "objectTypeId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseApiActionTypeDefinitionNoPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] } }, "/automation/2026-09-beta/flows" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve a list of automation flows.", "description" : "Retrieve a list of automation flows available in your HubSpot account. This endpoint supports pagination to navigate through large sets of flows, allowing you to specify the number of results per page and to continue from a specific point in the list using a cursor token.", "operationId" : "get-/automation/2026-09-beta/flows_/automation/2026-09-beta/flows", "parameters" : [ { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to return, with a default value of 100.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 100 } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseApiFlowListingForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] }, "post" : { "tags" : [ "Basic" ], "summary" : "Create a new automation flow.", "description" : "Create a new automation flow in your HubSpot account using the AutomationFlowApiService. This endpoint allows you to define the flow's properties and actions, enabling automated processes tailored to your business needs. Ensure that the request body is correctly structured as per the ApiFlowCreateRequest schema.", "operationId" : "post-/automation/2026-09-beta/flows_/automation/2026-09-beta/flows", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlowCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlow" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/automation/2026-09-beta/flows/batch/read" : { "post" : { "tags" : [ "Batch" ], "summary" : "Retrieve multiple automation flows in a single request.", "description" : "Retrieve multiple automation flows in a single request. This endpoint is useful for efficiently fetching data about several flows at once, reducing the need for multiple API calls. It is ideal for applications that need to process or display information about multiple flows simultaneously.", "operationId" : "post-/automation/2026-09-beta/flows/batch/read_/automation/2026-09-beta/flows/batch/read", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlowBatchInput" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseApiFlow" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseApiFlowWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] } }, "/automation/2026-09-beta/flows/email-campaigns" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve email campaigns for automation flows.", "description" : "Retrieve a list of email campaigns associated with automation flows. This endpoint allows you to filter and paginate through email campaigns using various query parameters. It is useful for obtaining detailed information about email campaigns linked to specific flows.", "operationId" : "get-/automation/2026-09-beta/flows/email-campaigns_/automation/2026-09-beta/flows/email-campaigns", "parameters" : [ { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "before", "in" : "query", "description" : "A paging cursor token for retrieving previous pages.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "flowId", "in" : "query", "description" : "A query parameter to filter email campaigns by their associated flow IDs.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseApiFlowEmailCampaign" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] } }, "/automation/2026-09-beta/flows/{flowId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve a specific automation flow.", "description" : "Retrieve detailed information about a specific automation flow in your HubSpot account using its unique identifier. This endpoint is useful for obtaining the current configuration and status of a flow, which can aid in monitoring and managing your automation processes.", "operationId" : "get-/automation/2026-09-beta/flows/{flowId}_/automation/2026-09-beta/flows/{flowId}", "parameters" : [ { "name" : "flowId", "in" : "path", "description" : "The unique identifier for the automation flow to be retrieved.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlow" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] }, "put" : { "tags" : [ "Basic" ], "summary" : "Update an existing automation flow.", "description" : "Update an existing automation flow in your HubSpot account. This endpoint allows you to modify the properties of a specific flow identified by its flowId. It is useful for making changes to the configuration or behavior of an automation flow.", "operationId" : "put-/automation/2026-09-beta/flows/{flowId}_/automation/2026-09-beta/flows/{flowId}", "parameters" : [ { "name" : "flowId", "in" : "path", "description" : "The unique identifier for the automation flow to be updated.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlowPutRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlow" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] }, "delete" : { "tags" : [ "Basic" ], "summary" : "Delete a specific automation flow.", "description" : "Delete an existing automation flow in your HubSpot account using the specified flow ID. This operation will permanently remove the flow and cannot be undone. Use this endpoint to manage and clean up automation flows that are no longer needed.", "operationId" : "delete-/automation/2026-09-beta/flows/{flowId}_/automation/2026-09-beta/flows/{flowId}", "parameters" : [ { "name" : "flowId", "in" : "path", "description" : "The unique identifier for the automation flow to be deleted.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] } }, "/automation/2026-09-beta/flows/{flowId}/revisions/{revisionId}" : { "get" : { "tags" : [ "Advanced" ], "summary" : "Retrieve revision", "description" : "Retrieve a specific revision of an automation flow using its flow ID and revision ID. This endpoint is useful for accessing historical versions of a flow to review changes or restore previous configurations.", "operationId" : "get-/automation/2026-09-beta/flows/{flowId}/revisions/{revisionId}_/automation/2026-09-beta/flows/{flowId}/revisions/{revisionId}", "parameters" : [ { "name" : "flowId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "revisionId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlowRevision" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] } }, "/automation/2026-09-beta/workflow-id-mappings/batch/read" : { "post" : { "tags" : [ "Batch" ], "summary" : "Retrieve batch workflow ID mappings.", "description" : "Retrieve batch workflow ID mappings for automation flows. This endpoint allows you to submit a batch request to read multiple workflow ID mappings in one operation, facilitating efficient data retrieval for large sets of automation flows.", "operationId" : "post-/automation/2026-09-beta/workflow-id-mappings/batch/read_/automation/2026-09-beta/workflow-id-mappings/batch/read", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiFlowBatchMigrationInput" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseFlowIdWorkflowIdMappingResponse" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseFlowIdWorkflowIdMappingResponseWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "automation" ] } ] } } }, "components" : { "schemas" : { "ApiABTestBranch" : { "required" : [ "connection" ], "type" : "object", "properties" : { "connection" : { "$ref" : "#/components/schemas/ApiConnection" }, "percentage" : { "type" : "integer", "format" : "int32", "example" : null } }, "example" : null }, "ApiABTestBranchAction" : { "title" : "AB_TEST_BRANCH", "required" : [ "actionId", "testBranches", "type" ], "type" : "object", "properties" : { "actionId" : { "type" : "string", "description" : "The unique identifier for the A/B test branch action.", "example" : null }, "testBranches" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiABTestBranch" } }, "type" : { "type" : "string", "description" : "Indicates the type of action, which defaults to AB_TEST_BRANCH.", "example" : null, "default" : "AB_TEST_BRANCH", "enum" : [ "AB_TEST_BRANCH" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiActionDataValue" : { "title" : "FIELD_DATA", "required" : [ "actionId", "dataKey", "type" ], "type" : "object", "properties" : { "actionId" : { "type" : "string", "description" : "The unique identifier for the action associated with the data value.", "example" : null }, "dataKey" : { "type" : "string", "description" : "The key used to identify the specific data value within the action.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of data value, which defaults to FIELD_DATA.", "example" : null, "default" : "FIELD_DATA", "enum" : [ "FIELD_DATA" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiActionOutputObjectPropertyValue" : { "title" : "ACTION_OUTPUT_OBJECT_PROPERTY", "required" : [ "actionOutputPropertyToken", "type" ], "type" : "object", "properties" : { "actionOutputPropertyToken" : { "type" : "string", "example" : null }, "type" : { "type" : "string", "example" : null, "default" : "ACTION_OUTPUT_OBJECT_PROPERTY", "enum" : [ "ACTION_OUTPUT_OBJECT_PROPERTY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiActionTypeDefinition" : { "required" : [ "actionName", "actionTypeId", "groupId", "inputFieldDefinitions", "objectTypeIds" ], "type" : "object", "properties" : { "actionName" : { "type" : "string", "description" : "The human-readable action name.", "example" : null }, "actionTypeId" : { "type" : "string", "description" : "The ID of the actionType", "example" : null }, "groupId" : { "type" : "string", "description" : "The group-ID of the actionType", "example" : null }, "inputFieldDefinitions" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiSimpleInputFieldDefinition" }, { "$ref" : "#/components/schemas/ApiEnumInputFieldDefinition" }, { "$ref" : "#/components/schemas/ApiExternalEnumInputFieldDefinition" } ] } }, "objectTypeIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, "example" : null }, "ApiAppendObjectPropertyValue" : { "title" : "APPEND_OBJECT_PROPERTY", "required" : [ "appendPropertyName", "type" ], "type" : "object", "properties" : { "appendPropertyName" : { "type" : "string", "description" : "The name of the property to which a value will be appended.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the action, which defaults to APPEND_OBJECT_PROPERTY.", "example" : null, "default" : "APPEND_OBJECT_PROPERTY", "enum" : [ "APPEND_OBJECT_PROPERTY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiAssociationDataSource" : { "title" : "ASSOCIATION", "required" : [ "associationCategory", "associationTypeId", "name", "objectTypeId", "type" ], "type" : "object", "properties" : { "associationCategory" : { "type" : "string", "description" : "Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.", "example" : null, "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the type of association.", "format" : "int32", "example" : null }, "name" : { "type" : "string", "description" : "The name of the data source.", "example" : null }, "objectTypeId" : { "type" : "string", "description" : "Represents the ID of the object type associated with the data source.", "example" : null }, "sortBy" : { "$ref" : "#/components/schemas/ApiSort" }, "type" : { "type" : "string", "description" : "Indicates the type of data source, which defaults to ASSOCIATION.", "example" : null, "default" : "ASSOCIATION", "enum" : [ "ASSOCIATION" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiAssociationTimestampDataSource" : { "title" : "ASSOCIATION_TIMESTAMP", "required" : [ "associationCategory", "associationTypeId", "name", "objectTypeId", "type" ], "type" : "object", "properties" : { "associationCategory" : { "type" : "string", "description" : "Defines the category of the association, with possible values being HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.", "example" : null, "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the type of association.", "format" : "int32", "example" : null }, "name" : { "type" : "string", "description" : "Specifies the name of the data source.", "example" : null }, "objectTypeId" : { "type" : "string", "description" : "Represents the ID of the object type associated with the data source.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the data source, which defaults to ASSOCIATION_TIMESTAMP.", "example" : null, "default" : "ASSOCIATION_TIMESTAMP", "enum" : [ "ASSOCIATION_TIMESTAMP" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiAuthKeyWebhookAuthSettings" : { "title" : "AUTH_KEY", "required" : [ "location", "name", "secretName", "type" ], "type" : "object", "properties" : { "location" : { "type" : "string", "description" : "Specifies where the authentication key is located, with possible values being HEADER or QUERY_PARAM.", "example" : null, "enum" : [ "HEADER", "QUERY_PARAM" ] }, "name" : { "type" : "string", "description" : "The name associated with the authentication key.", "example" : null }, "secretName" : { "type" : "string", "description" : "The name of the secret used for authentication.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of authentication, which defaults to AUTH_KEY.", "example" : null, "default" : "AUTH_KEY", "enum" : [ "AUTH_KEY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiBlockedDate" : { "required" : [ "dayOfMonth", "month" ], "type" : "object", "properties" : { "dayOfMonth" : { "type" : "integer", "description" : "The day of the month for the blocked date.", "format" : "int32", "example" : null }, "month" : { "type" : "string", "description" : "The month of the blocked date, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER.", "example" : null, "enum" : [ "APRIL", "AUGUST", "DECEMBER", "FEBRUARY", "JANUARY", "JULY", "JUNE", "MARCH", "MAY", "NOVEMBER", "OCTOBER", "SEPTEMBER" ] }, "year" : { "type" : "integer", "description" : "The year of the blocked date.", "format" : "int32", "example" : null } }, "example" : null }, "ApiConnection" : { "required" : [ "edgeType", "nextActionId" ], "type" : "object", "properties" : { "edgeType" : { "type" : "string", "description" : "Specifies the type of connection between actions in the automation flow.", "example" : null, "enum" : [ "GOTO", "STANDARD" ] }, "nextActionId" : { "type" : "string", "description" : "The identifier for the subsequent action in the automation sequence.", "example" : null } }, "example" : null }, "ApiContactFlow" : { "required" : [ "actions", "blockedDates", "canEnrollFromSalesforce", "createdAt", "crmObjectCreationStatus", "customProperties", "dataSources", "flowType", "id", "isEnabled", "nextAvailableActionId", "objectTypeId", "revisionId", "suppressionListIds", "timeWindows", "type", "updatedAt" ], "type" : "object", "properties" : { "actions" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiStaticBranchAction" }, { "$ref" : "#/components/schemas/ApiListBranchAction" }, { "$ref" : "#/components/schemas/ApiABTestBranchAction" }, { "$ref" : "#/components/schemas/ApiCustomCodeAction" }, { "$ref" : "#/components/schemas/ApiWebhookAction" }, { "$ref" : "#/components/schemas/ApiSingleConnectionAction" } ] } }, "blockedDates" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiBlockedDate" } }, "canEnrollFromSalesforce" : { "type" : "boolean", "example" : null }, "createdAt" : { "type" : "string", "format" : "date-time", "example" : null }, "crmObjectCreationStatus" : { "type" : "string", "example" : null, "enum" : [ "COMPLETE", "PENDING" ] }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "dataSources" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiAssociationDataSource" }, { "$ref" : "#/components/schemas/ApiAssociationTimestampDataSource" }, { "$ref" : "#/components/schemas/ApiStaticPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledRecordPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiDatasetFieldPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledArgumentPropertyFilterDataSource" } ] } }, "description" : { "type" : "string", "example" : null }, "enrollmentCriteria" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiListBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiEventBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiManualEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiDatasetBasedEnrollmentCriteria" } ] }, "enrollmentSchedule" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiDailyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiWeeklyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiYearlyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiPropertyBasedEnrollmentSchedule" } ] }, "eventAnchor" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiContactPropertyAnchor" }, { "$ref" : "#/components/schemas/ApiStaticDateAnchor" } ] }, "flowType" : { "type" : "string", "example" : null, "enum" : [ "ACTION_SET", "UNKNOWN", "WORKFLOW" ] }, "goalFilterBranch" : { "example" : null, "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" } ] }, "id" : { "type" : "string", "example" : null }, "isEnabled" : { "type" : "boolean", "example" : null }, "name" : { "type" : "string", "example" : null }, "nextAvailableActionId" : { "type" : "string", "example" : null }, "objectTypeId" : { "type" : "string", "example" : null }, "revisionId" : { "type" : "string", "example" : null }, "startActionId" : { "type" : "string", "example" : null }, "suppressionListIds" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int32", "example" : null } }, "timeWindows" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiTimeWindow" } }, "type" : { "type" : "string", "example" : null, "default" : "CONTACT_FLOW", "enum" : [ "CONTACT_FLOW" ] }, "unEnrollmentSetting" : { "$ref" : "#/components/schemas/ApiUnEnrollmentSetting" }, "updatedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "uuid" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiContactFlowCreateRequest" : { "required" : [ "actions", "blockedDates", "canEnrollFromSalesforce", "customProperties", "dataSources", "flowType", "isEnabled", "objectTypeId", "suppressionListIds", "timeWindows", "type" ], "type" : "object", "properties" : { "actions" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiStaticBranchAction" }, { "$ref" : "#/components/schemas/ApiListBranchAction" }, { "$ref" : "#/components/schemas/ApiABTestBranchAction" }, { "$ref" : "#/components/schemas/ApiCustomCodeAction" }, { "$ref" : "#/components/schemas/ApiWebhookAction" }, { "$ref" : "#/components/schemas/ApiSingleConnectionAction" } ] } }, "blockedDates" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiBlockedDate" } }, "canEnrollFromSalesforce" : { "type" : "boolean", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "dataSources" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiAssociationDataSource" }, { "$ref" : "#/components/schemas/ApiAssociationTimestampDataSource" }, { "$ref" : "#/components/schemas/ApiStaticPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledRecordPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiDatasetFieldPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledArgumentPropertyFilterDataSource" } ] } }, "description" : { "type" : "string", "example" : null }, "enrollmentCriteria" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiListBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiEventBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiManualEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiDatasetBasedEnrollmentCriteria" } ] }, "enrollmentSchedule" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiDailyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiWeeklyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiYearlyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiPropertyBasedEnrollmentSchedule" } ] }, "eventAnchor" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiContactPropertyAnchor" }, { "$ref" : "#/components/schemas/ApiStaticDateAnchor" } ] }, "flowType" : { "type" : "string", "example" : null, "enum" : [ "ACTION_SET", "UNKNOWN", "WORKFLOW" ] }, "goalFilterBranch" : { "example" : null, "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" } ] }, "isEnabled" : { "type" : "boolean", "example" : null }, "name" : { "type" : "string", "example" : null }, "objectTypeId" : { "type" : "string", "example" : null }, "startActionId" : { "type" : "string", "example" : null }, "suppressionListIds" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int32", "example" : null } }, "timeWindows" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiTimeWindow" } }, "type" : { "type" : "string", "example" : null, "default" : "CONTACT_FLOW", "enum" : [ "CONTACT_FLOW" ] }, "unEnrollmentSetting" : { "$ref" : "#/components/schemas/ApiUnEnrollmentSetting" }, "uuid" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiContactFlowPutRequest" : { "required" : [ "actions", "blockedDates", "canEnrollFromSalesforce", "customProperties", "isEnabled", "revisionId", "suppressionListIds", "timeWindows", "type" ], "type" : "object", "properties" : { "actions" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiStaticBranchAction" }, { "$ref" : "#/components/schemas/ApiListBranchAction" }, { "$ref" : "#/components/schemas/ApiABTestBranchAction" }, { "$ref" : "#/components/schemas/ApiCustomCodeAction" }, { "$ref" : "#/components/schemas/ApiWebhookAction" }, { "$ref" : "#/components/schemas/ApiSingleConnectionAction" } ] } }, "blockedDates" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiBlockedDate" } }, "canEnrollFromSalesforce" : { "type" : "boolean", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "description" : { "type" : "string", "example" : null }, "enrollmentCriteria" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiListBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiEventBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiManualEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiDatasetBasedEnrollmentCriteria" } ] }, "enrollmentSchedule" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiDailyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiWeeklyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiYearlyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiPropertyBasedEnrollmentSchedule" } ] }, "eventAnchor" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiContactPropertyAnchor" }, { "$ref" : "#/components/schemas/ApiStaticDateAnchor" } ] }, "goalFilterBranch" : { "example" : null, "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" } ] }, "isEnabled" : { "type" : "boolean", "example" : null }, "name" : { "type" : "string", "example" : null }, "revisionId" : { "type" : "string", "example" : null }, "startActionId" : { "type" : "string", "example" : null }, "suppressionListIds" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int32", "example" : null } }, "timeWindows" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiTimeWindow" } }, "type" : { "type" : "string", "example" : null, "default" : "CONTACT_FLOW", "enum" : [ "CONTACT_FLOW" ] }, "unEnrollmentSetting" : { "$ref" : "#/components/schemas/ApiUnEnrollmentSetting" }, "uuid" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiContactPropertyAnchor" : { "title" : "CONTACT_PROPERTY_ANCHOR", "required" : [ "contactProperty", "type" ], "type" : "object", "properties" : { "contactProperty" : { "type" : "string", "description" : "Specifies the contact property associated with the anchor.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the contact property anchor, which defaults to CONTACT_PROPERTY_ANCHOR.", "example" : null, "default" : "CONTACT_PROPERTY_ANCHOR", "enum" : [ "CONTACT_PROPERTY_ANCHOR" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiCustomCodeAction" : { "title" : "CUSTOM_CODE", "required" : [ "actionId", "inputFields", "outputFields", "runtime", "secretNames", "sourceCode", "type" ], "type" : "object", "properties" : { "actionId" : { "type" : "string", "description" : "The unique identifier for the custom code action.", "example" : null }, "connection" : { "$ref" : "#/components/schemas/ApiConnection" }, "inputFields" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiInputVariable" } }, "outputFields" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiEnumerationOutputField" } ] } }, "runtime" : { "type" : "string", "description" : "Specifies the runtime environment for the custom code action.", "example" : null }, "secretNames" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "sourceCode" : { "type" : "string", "description" : "Contains the source code for the custom code action.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the action, which defaults to CUSTOM_CODE.", "example" : null, "default" : "CUSTOM_CODE", "enum" : [ "CUSTOM_CODE" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiDailyEnrollmentSchedule" : { "title" : "DAILY", "required" : [ "timeOfDay", "type" ], "type" : "object", "properties" : { "timeOfDay" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "type" : { "type" : "string", "description" : "Specifies the type of enrollment schedule, which is 'DAILY'.", "example" : null, "default" : "DAILY", "enum" : [ "DAILY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiDatasetBasedEnrollmentCriteria" : { "title" : "DATASET", "required" : [ "datasetId", "shouldReEnroll", "type" ], "type" : "object", "properties" : { "datasetId" : { "type" : "integer", "format" : "int64", "example" : null }, "shouldReEnroll" : { "type" : "boolean", "example" : null }, "subviewId" : { "type" : "string", "example" : null }, "type" : { "type" : "string", "example" : null, "default" : "DATASET", "enum" : [ "DATASET" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiDatasetFieldPropertyFilterDataSource" : { "title" : "DATASET_FIELD_PROPERTY_FILTER", "required" : [ "datasetFieldName", "name", "propertyName", "type" ], "type" : "object", "properties" : { "datasetFieldName" : { "type" : "string", "description" : "Specifies the name of the dataset field used in the property filter.", "example" : null }, "name" : { "type" : "string", "description" : "Defines the name of the data source.", "example" : null }, "propertyName" : { "type" : "string", "description" : "Specifies the name of the property used in the dataset field property filter.", "example" : null }, "sortBy" : { "$ref" : "#/components/schemas/ApiSort" }, "type" : { "type" : "string", "description" : "Indicates the type of data source, which defaults to DATASET_FIELD_PROPERTY_FILTER.", "example" : null, "default" : "DATASET_FIELD_PROPERTY_FILTER", "enum" : [ "DATASET_FIELD_PROPERTY_FILTER" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiEnrolledArgumentPropertyFilterDataSource" : { "title" : "ENROLLED_ARGUMENT_PROPERTY_FILTER", "required" : [ "argumentName", "name", "propertyName", "type" ], "type" : "object", "properties" : { "argumentName" : { "type" : "string", "description" : "The name of the argument used in the enrolled argument property filter.", "example" : null }, "name" : { "type" : "string", "description" : "Defines the name of the data source.", "example" : null }, "propertyName" : { "type" : "string", "description" : "Specifies the name of the property used in the enrolled argument property filter.", "example" : null }, "sortBy" : { "$ref" : "#/components/schemas/ApiSort" }, "type" : { "type" : "string", "description" : "Indicates the type of data source, which defaults to ENROLLED_ARGUMENT_PROPERTY_FILTER.", "example" : null, "default" : "ENROLLED_ARGUMENT_PROPERTY_FILTER", "enum" : [ "ENROLLED_ARGUMENT_PROPERTY_FILTER" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiEnrolledRecordPropertyFilterDataSource" : { "title" : "ENROLLED_RECORD_PROPERTY_FILTER", "required" : [ "name", "propertyName", "recordFieldName", "type" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Defines the name of the data source.", "example" : null }, "propertyName" : { "type" : "string", "description" : "Specifies the name of the property used in the enrolled record property filter.", "example" : null }, "recordFieldName" : { "type" : "string", "description" : "The name of the field in the record that is being filtered.", "example" : null }, "sortBy" : { "$ref" : "#/components/schemas/ApiSort" }, "type" : { "type" : "string", "description" : "Indicates the type of data source, which defaults to ENROLLED_RECORD_PROPERTY_FILTER.", "example" : null, "default" : "ENROLLED_RECORD_PROPERTY_FILTER", "enum" : [ "ENROLLED_RECORD_PROPERTY_FILTER" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiEnrollmentDatasetColumnValue" : { "title" : "ENROLLMENT_DATASET_COLUMN", "required" : [ "enrollmentDatasetColumnToken", "type" ], "type" : "object", "properties" : { "enrollmentDatasetColumnToken" : { "type" : "string", "example" : null }, "type" : { "type" : "string", "example" : null, "default" : "ENROLLMENT_DATASET_COLUMN", "enum" : [ "ENROLLMENT_DATASET_COLUMN" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiEnrollmentEventPropertyValue" : { "title" : "ENROLLMENT_EVENT_PROPERTY", "required" : [ "enrollmentEventPropertyToken", "type" ], "type" : "object", "properties" : { "enrollmentEventPropertyToken" : { "type" : "string", "description" : "The token used to identify the specific enrollment event property.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the enrollment event property, which defaults to ENROLLMENT_EVENT_PROPERTY.", "example" : null, "default" : "ENROLLMENT_EVENT_PROPERTY", "enum" : [ "ENROLLMENT_EVENT_PROPERTY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiEnumInputFieldDefinition" : { "title" : "ENUM", "required" : [ "fieldDefinitionType", "isRequired", "name", "options", "type" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Full description of the field.", "example" : null }, "fieldDefinitionType" : { "type" : "string", "description" : "Type of field: \"ENUM\"", "example" : null, "default" : "ENUM", "enum" : [ "ENUM" ] }, "isRequired" : { "type" : "boolean", "description" : "If the field is required or not", "example" : null }, "label" : { "type" : "string", "description" : "Human-readable label of the field", "example" : null }, "name" : { "type" : "string", "description" : "Name of the field", "example" : null }, "options" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/Option" } }, "type" : { "type" : "string", "description" : "CRM type for the field:", "example" : null, "enum" : [ "bool", "currency_number", "date", "datetime", "enumeration", "json", "number", "object_coordinates", "phone_number", "string" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiEnumerationOutputField" : { "title" : "ENUMERATION", "required" : [ "name", "options", "type" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the enumeration output field.", "example" : null }, "options" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "type" : { "type" : "string", "description" : "Specifies that the type of the field is 'ENUMERATION'.", "example" : null, "default" : "ENUMERATION", "enum" : [ "ENUMERATION" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiEventBasedEnrollmentCriteria" : { "title" : "EVENT_BASED", "required" : [ "eventFilterBranches", "listMembershipFilterBranches", "shouldReEnroll", "type" ], "type" : "object", "properties" : { "eventFilterBranches" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicUnifiedEventsFilterBranch" } }, "listMembershipFilterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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" } ] } }, "refinementCriteria" : { "description" : "Specifies additional criteria for refining the enrollment process.", "example" : null, "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" } ] }, "shouldReEnroll" : { "type" : "boolean", "description" : "Determines if objects should be re-enrolled when they meet the criteria again.", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of enrollment criteria, which defaults to 'EVENT_BASED'.", "example" : null, "default" : "EVENT_BASED", "enum" : [ "EVENT_BASED" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiExternalEnumInputFieldDefinition" : { "title" : "EXTERNAL_ENUM", "required" : [ "fieldDefinitionType", "isRequired", "name", "type" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "Full description of this field", "example" : null }, "fieldDefinitionType" : { "type" : "string", "description" : "CRM type of the field", "example" : null, "default" : "EXTERNAL_ENUM", "enum" : [ "EXTERNAL_ENUM" ] }, "isRequired" : { "type" : "boolean", "description" : "Whether or not this field is required", "example" : null }, "label" : { "type" : "string", "description" : "Human-readable label of the field", "example" : null }, "name" : { "type" : "string", "description" : "Name of the field", "example" : null }, "optionsUrl" : { "type" : "string", "description" : "The URL to use to fetch the available options for this field.", "example" : null }, "type" : { "type" : "string", "description" : "Type of field: \"ENUM\"", "example" : null, "enum" : [ "bool", "currency_number", "date", "datetime", "enumeration", "json", "number", "object_coordinates", "phone_number", "string" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiFetchedObjectPropertyValue" : { "title" : "FETCHED_OBJECT_PROPERTY", "required" : [ "propertyToken", "type" ], "type" : "object", "properties" : { "propertyToken" : { "type" : "string", "description" : "The token used to identify the specific property of the fetched object.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the fetched object property, which defaults to FETCHED_OBJECT_PROPERTY.", "example" : null, "default" : "FETCHED_OBJECT_PROPERTY", "enum" : [ "FETCHED_OBJECT_PROPERTY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiFlow" : { "properties" : { }, "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiContactFlow" }, { "$ref" : "#/components/schemas/ApiPlatformFlow" } ] }, "ApiFlowBatchFetchFlowIdCoordinate" : { "title" : "FLOW_ID", "required" : [ "flowId", "type" ], "type" : "object", "properties" : { "flowId" : { "type" : "string", "description" : "The unique identifier for the automation flow.", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of coordinate:FLOW_ID.", "example" : null, "default" : "FLOW_ID", "enum" : [ "FLOW_ID" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiFlowBatchFetchMigrationFlowIdCoordinate" : { "title" : "FLOW_ID", "required" : [ "type" ], "type" : "object", "properties" : { "flowId" : { "type" : "string", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of coordinate, which defaults to FLOW_ID.", "example" : null, "default" : "FLOW_ID", "enum" : [ "FLOW_ID" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiFlowBatchFetchMigrationWorkflowIdCoordinate" : { "title" : "WORKFLOW_ID", "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Specifies the type of coordinate, which defaults to WORKFLOW_ID.", "example" : null, "default" : "WORKFLOW_ID", "enum" : [ "WORKFLOW_ID" ] }, "workflowId" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiFlowBatchInput" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiFlowBatchFetchFlowIdCoordinate" } ] } } }, "example" : null }, "ApiFlowBatchMigrationInput" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiFlowBatchFetchMigrationFlowIdCoordinate" }, { "$ref" : "#/components/schemas/ApiFlowBatchFetchMigrationWorkflowIdCoordinate" } ] } } }, "example" : null }, "ApiFlowCreateRequest" : { "properties" : { }, "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiContactFlowCreateRequest" }, { "$ref" : "#/components/schemas/ApiPlatformFlowCreateRequest" } ] }, "ApiFlowEmailCampaign" : { "required" : [ "emailCampaignId", "emailContentId", "flowId" ], "type" : "object", "properties" : { "emailCampaignId" : { "type" : "string", "description" : "The unique identifier for the email campaign associated with the automation flow.", "example" : null }, "emailContentId" : { "type" : "string", "description" : "The unique identifier for the email content used in the email campaign.", "example" : null }, "flowId" : { "type" : "string", "description" : "The unique identifier for the automation flow associated with the email campaign.", "example" : null } }, "example" : null }, "ApiFlowListing" : { "required" : [ "createdAt", "flowType", "id", "isEnabled", "objectTypeId", "revisionId", "updatedAt" ], "type" : "object", "properties" : { "createdAt" : { "type" : "string", "description" : "The date and time when the automation flow was created, formatted as a date-time string.", "format" : "date-time", "example" : null }, "flowType" : { "type" : "string", "description" : "Specifies the type of the automation flow (PLATFORM vs. CONTACT)", "example" : null, "enum" : [ "ACTION_SET", "UNKNOWN", "WORKFLOW" ] }, "id" : { "type" : "string", "description" : "The unique identifier for the automation flow.", "example" : null }, "isEnabled" : { "type" : "boolean", "description" : "Indicates whether the automation flow is currently active.", "example" : null }, "name" : { "type" : "string", "description" : "The name assigned to the automation flow.", "example" : null }, "objectTypeId" : { "type" : "string", "description" : "Represents the ID of the object type associated with the automation flow.", "example" : null }, "revisionId" : { "type" : "string", "description" : "The identifier for the current revision of the automation flow.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when the automation flow was last updated, formatted as a date-time string.", "format" : "date-time", "example" : null }, "uuid" : { "type" : "string", "description" : "The universally unique identifier for the automation flow.", "example" : null } }, "example" : null }, "ApiFlowPutRequest" : { "properties" : { }, "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiContactFlowPutRequest" }, { "$ref" : "#/components/schemas/ApiPlatformFlowPutRequest" } ] }, "ApiFlowRevision" : { "required" : [ "flow", "id", "revisionCreatedAt", "revisionId" ], "type" : "object", "properties" : { "flow" : { "description" : "The flow at this revision level", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiContactFlow" }, { "$ref" : "#/components/schemas/ApiPlatformFlow" } ] }, "id" : { "type" : "string", "description" : "The flow's ID", "example" : null }, "revisionCreatedAt" : { "type" : "string", "description" : "The timestamp this revision was created.", "format" : "date-time", "example" : null }, "revisionId" : { "type" : "string", "description" : "The revision of this flow", "example" : null } }, "example" : null }, "ApiIncrementValue" : { "title" : "INCREMENT", "required" : [ "incrementAmount", "type" ], "type" : "object", "properties" : { "incrementAmount" : { "type" : "number", "description" : "Specifies the amount to increment.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the increment value, which defaults to INCREMENT.", "example" : null, "default" : "INCREMENT", "enum" : [ "INCREMENT" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiInputVariable" : { "required" : [ "name", "value" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the input variable.", "example" : null }, "value" : { "description" : "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.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiActionDataValue" }, { "$ref" : "#/components/schemas/ApiObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiStaticValue" }, { "$ref" : "#/components/schemas/ApiRelativeDateTimeValue" }, { "$ref" : "#/components/schemas/ApiTimestampValue" }, { "$ref" : "#/components/schemas/ApiIncrementValue" }, { "$ref" : "#/components/schemas/ApiFetchedObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiAppendObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiStaticAppendValue" }, { "$ref" : "#/components/schemas/ApiEnrollmentEventPropertyValue" }, { "$ref" : "#/components/schemas/ApiEnrollmentDatasetColumnValue" }, { "$ref" : "#/components/schemas/ApiActionOutputObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiSingleObjectCoordinatesValue" }, { "$ref" : "#/components/schemas/ApiListInputValue" }, { "$ref" : "#/components/schemas/ApiMapInputValue" } ] } }, "example" : null }, "ApiListBasedEnrollmentCriteria" : { "title" : "LIST_BASED", "required" : [ "listFilterBranch", "reEnrollmentTriggersFilterBranches", "shouldReEnroll", "type", "unEnrollObjectsNotMeetingCriteria" ], "type" : "object", "properties" : { "listFilterBranch" : { "description" : "Defines the filter branch used to determine list-based enrollment criteria.", "example" : null, "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" } ] }, "reEnrollmentTriggersFilterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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" } ] } }, "shouldReEnroll" : { "type" : "boolean", "description" : "Determines if objects should be re-enrolled when they meet the criteria again.", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'.", "example" : null, "default" : "LIST_BASED", "enum" : [ "LIST_BASED" ] }, "unEnrollObjectsNotMeetingCriteria" : { "type" : "boolean", "description" : "Indicates whether objects not meeting the criteria should be unenrolled.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiListBranch" : { "type" : "object", "properties" : { "branchName" : { "type" : "string", "description" : "Specifies the name of the branch.", "example" : null }, "connection" : { "$ref" : "#/components/schemas/ApiConnection" }, "filterBranch" : { "description" : "Defines the filter criteria for the branch, using logical operators and conditions.", "example" : null, "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" } ] } }, "example" : null }, "ApiListBranchAction" : { "title" : "LIST_BRANCH", "required" : [ "actionId", "listBranches", "type" ], "type" : "object", "properties" : { "actionId" : { "type" : "string", "description" : "The unique identifier for the list branch action.", "example" : null }, "defaultBranch" : { "$ref" : "#/components/schemas/ApiConnection" }, "defaultBranchName" : { "type" : "string", "description" : "The name of the default branch in the list action.", "example" : null }, "listBranches" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiListBranch" } }, "type" : { "type" : "string", "description" : "Indicates the type of action, which defaults to LIST_BRANCH.", "example" : null, "default" : "LIST_BRANCH", "enum" : [ "LIST_BRANCH" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiListInputValue" : { "title" : "LIST", "required" : [ "type", "values" ], "type" : "object", "properties" : { "type" : { "type" : "string", "example" : null, "default" : "LIST", "enum" : [ "LIST" ] }, "values" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiActionDataValue" }, { "$ref" : "#/components/schemas/ApiObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiStaticValue" }, { "$ref" : "#/components/schemas/ApiRelativeDateTimeValue" }, { "$ref" : "#/components/schemas/ApiTimestampValue" }, { "$ref" : "#/components/schemas/ApiIncrementValue" }, { "$ref" : "#/components/schemas/ApiFetchedObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiAppendObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiStaticAppendValue" }, { "$ref" : "#/components/schemas/ApiEnrollmentEventPropertyValue" }, { "$ref" : "#/components/schemas/ApiEnrollmentDatasetColumnValue" }, { "$ref" : "#/components/schemas/ApiActionOutputObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiSingleObjectCoordinatesValue" }, { "$ref" : "#/components/schemas/ApiListInputValue" }, { "$ref" : "#/components/schemas/ApiMapInputValue" } ] } } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiManualEnrollmentCriteria" : { "title" : "MANUAL", "required" : [ "shouldReEnroll", "type" ], "type" : "object", "properties" : { "shouldReEnroll" : { "type" : "boolean", "description" : "Indicates whether the enrollment should be repeated.", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of enrollment criteria, which is 'MANUAL'.", "example" : null, "default" : "MANUAL", "enum" : [ "MANUAL" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiMapInputValue" : { "title" : "MAP", "required" : [ "type", "values" ], "type" : "object", "properties" : { "type" : { "type" : "string", "example" : null, "default" : "MAP", "enum" : [ "MAP" ] }, "values" : { "type" : "object", "properties" : { }, "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiMonthlyRelativeDaysEnrollmentSchedule" : { "title" : "MONTHLY_RELATIVE_DAYS", "required" : [ "monthlyRelativeDays", "timeOfDay", "type" ], "type" : "object", "properties" : { "monthlyRelativeDays" : { "type" : "string", "description" : "One of the possible relative days to enroll can be: LAST_DAY_OF_MONTH, or FIRST_MONDAY_OF_MONTH", "example" : null, "enum" : [ "FIRST_MONDAY_OF_MONTH", "LAST_DAY_OF_MONTH" ] }, "timeOfDay" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "type" : { "type" : "string", "description" : "The type of schedule, always: MONTHLY_RELATIVE_DAYS", "example" : null, "default" : "MONTHLY_RELATIVE_DAYS", "enum" : [ "MONTHLY_RELATIVE_DAYS" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiMonthlySpecificDaysEnrollmentSchedule" : { "title" : "MONTHLY_SPECIFIC_DAYS", "required" : [ "daysOfMonth", "timeOfDay", "type" ], "type" : "object", "properties" : { "daysOfMonth" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int32", "example" : null } }, "timeOfDay" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "type" : { "type" : "string", "description" : "Specifies the type of enrollment schedule, which is 'MONTHLY_SPECIFIC_DAYS'.", "example" : null, "default" : "MONTHLY_SPECIFIC_DAYS", "enum" : [ "MONTHLY_SPECIFIC_DAYS" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiObjectPropertyValue" : { "title" : "OBJECT_PROPERTY", "required" : [ "propertyName", "type" ], "type" : "object", "properties" : { "propertyName" : { "type" : "string", "description" : "Specifies the name of the property used in the object.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the object property, which defaults to OBJECT_PROPERTY.", "example" : null, "default" : "OBJECT_PROPERTY", "enum" : [ "OBJECT_PROPERTY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiPlatformFlow" : { "required" : [ "actions", "blockedDates", "createdAt", "crmObjectCreationStatus", "customProperties", "dataSources", "flowType", "id", "isEnabled", "nextAvailableActionId", "objectTypeId", "revisionId", "timeWindows", "type", "updatedAt" ], "type" : "object", "properties" : { "actions" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiStaticBranchAction" }, { "$ref" : "#/components/schemas/ApiListBranchAction" }, { "$ref" : "#/components/schemas/ApiABTestBranchAction" }, { "$ref" : "#/components/schemas/ApiCustomCodeAction" }, { "$ref" : "#/components/schemas/ApiWebhookAction" }, { "$ref" : "#/components/schemas/ApiSingleConnectionAction" } ] } }, "blockedDates" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiBlockedDate" } }, "createdAt" : { "type" : "string", "format" : "date-time", "example" : null }, "crmObjectCreationStatus" : { "type" : "string", "example" : null, "enum" : [ "COMPLETE", "PENDING" ] }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "dataSources" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiAssociationDataSource" }, { "$ref" : "#/components/schemas/ApiAssociationTimestampDataSource" }, { "$ref" : "#/components/schemas/ApiStaticPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledRecordPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiDatasetFieldPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledArgumentPropertyFilterDataSource" } ] } }, "description" : { "type" : "string", "example" : null }, "enrollmentCriteria" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiListBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiEventBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiManualEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiDatasetBasedEnrollmentCriteria" } ] }, "enrollmentSchedule" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiDailyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiWeeklyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiYearlyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiPropertyBasedEnrollmentSchedule" } ] }, "flowType" : { "type" : "string", "example" : null, "enum" : [ "ACTION_SET", "UNKNOWN", "WORKFLOW" ] }, "id" : { "type" : "string", "example" : null }, "isEnabled" : { "type" : "boolean", "example" : null }, "name" : { "type" : "string", "example" : null }, "nextAvailableActionId" : { "type" : "string", "example" : null }, "objectTypeId" : { "type" : "string", "example" : null }, "revisionId" : { "type" : "string", "example" : null }, "startActionId" : { "type" : "string", "example" : null }, "suppressionFilterBranch" : { "example" : null, "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" } ] }, "timeWindows" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiTimeWindow" } }, "type" : { "type" : "string", "example" : null, "default" : "PLATFORM_FLOW", "enum" : [ "PLATFORM_FLOW" ] }, "updatedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "uuid" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiPlatformFlowCreateRequest" : { "required" : [ "actions", "blockedDates", "customProperties", "dataSources", "flowType", "isEnabled", "objectTypeId", "timeWindows", "type" ], "type" : "object", "properties" : { "actions" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiStaticBranchAction" }, { "$ref" : "#/components/schemas/ApiListBranchAction" }, { "$ref" : "#/components/schemas/ApiABTestBranchAction" }, { "$ref" : "#/components/schemas/ApiCustomCodeAction" }, { "$ref" : "#/components/schemas/ApiWebhookAction" }, { "$ref" : "#/components/schemas/ApiSingleConnectionAction" } ] } }, "blockedDates" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiBlockedDate" } }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "dataSources" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiAssociationDataSource" }, { "$ref" : "#/components/schemas/ApiAssociationTimestampDataSource" }, { "$ref" : "#/components/schemas/ApiStaticPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledRecordPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiDatasetFieldPropertyFilterDataSource" }, { "$ref" : "#/components/schemas/ApiEnrolledArgumentPropertyFilterDataSource" } ] } }, "description" : { "type" : "string", "example" : null }, "enrollmentCriteria" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiListBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiEventBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiManualEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiDatasetBasedEnrollmentCriteria" } ] }, "enrollmentSchedule" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiDailyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiWeeklyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiYearlyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiPropertyBasedEnrollmentSchedule" } ] }, "flowType" : { "type" : "string", "example" : null, "enum" : [ "ACTION_SET", "UNKNOWN", "WORKFLOW" ] }, "isEnabled" : { "type" : "boolean", "example" : null }, "name" : { "type" : "string", "example" : null }, "objectTypeId" : { "type" : "string", "example" : null }, "startActionId" : { "type" : "string", "example" : null }, "suppressionFilterBranch" : { "example" : null, "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" } ] }, "timeWindows" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiTimeWindow" } }, "type" : { "type" : "string", "example" : null, "default" : "PLATFORM_FLOW", "enum" : [ "PLATFORM_FLOW" ] }, "uuid" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiPlatformFlowPutRequest" : { "required" : [ "actions", "blockedDates", "customProperties", "isEnabled", "revisionId", "timeWindows", "type" ], "type" : "object", "properties" : { "actions" : { "type" : "array", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiStaticBranchAction" }, { "$ref" : "#/components/schemas/ApiListBranchAction" }, { "$ref" : "#/components/schemas/ApiABTestBranchAction" }, { "$ref" : "#/components/schemas/ApiCustomCodeAction" }, { "$ref" : "#/components/schemas/ApiWebhookAction" }, { "$ref" : "#/components/schemas/ApiSingleConnectionAction" } ] } }, "blockedDates" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiBlockedDate" } }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "description" : { "type" : "string", "example" : null }, "enrollmentCriteria" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiListBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiEventBasedEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiManualEnrollmentCriteria" }, { "$ref" : "#/components/schemas/ApiDatasetBasedEnrollmentCriteria" } ] }, "enrollmentSchedule" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiDailyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiWeeklyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiYearlyEnrollmentSchedule" }, { "$ref" : "#/components/schemas/ApiPropertyBasedEnrollmentSchedule" } ] }, "isEnabled" : { "type" : "boolean", "example" : null }, "name" : { "type" : "string", "example" : null }, "revisionId" : { "type" : "string", "example" : null }, "startActionId" : { "type" : "string", "example" : null }, "suppressionFilterBranch" : { "example" : null, "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" } ] }, "timeWindows" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiTimeWindow" } }, "type" : { "type" : "string", "example" : null, "default" : "PLATFORM_FLOW", "enum" : [ "PLATFORM_FLOW" ] }, "uuid" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiPropertyBasedEnrollmentSchedule" : { "title" : "PROPERTY_BASED", "required" : [ "dateProperty", "daysDelta", "timeOfDay", "type", "yearly" ], "type" : "object", "properties" : { "dateProperty" : { "type" : "string", "description" : "The property used to determine the date for enrollment scheduling.", "example" : null }, "daysDelta" : { "type" : "integer", "description" : "The number of days to adjust the enrollment date relative to the dateProperty.", "format" : "int32", "example" : null }, "timeOfDay" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "type" : { "type" : "string", "description" : "Specifies the type of enrollment schedule, which is 'PROPERTY_BASED'.", "example" : null, "default" : "PROPERTY_BASED", "enum" : [ "PROPERTY_BASED" ] }, "yearly" : { "type" : "boolean", "description" : "Indicates whether the enrollment schedule is set to repeat annually.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiRelativeDateTimeValue" : { "title" : "RELATIVE_DATETIME", "required" : [ "timeDelay", "type" ], "type" : "object", "properties" : { "timeDelay" : { "$ref" : "#/components/schemas/ApiTimeDelay" }, "type" : { "type" : "string", "description" : "Indicates the type of the value, which defaults to RELATIVE_DATETIME.", "example" : null, "default" : "RELATIVE_DATETIME", "enum" : [ "RELATIVE_DATETIME" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiSignatureWebhookAuthSettings" : { "title" : "SIGNATURE", "required" : [ "appId", "type" ], "type" : "object", "properties" : { "appId" : { "type" : "integer", "description" : "The HubSpot appId that is being used to auth this webhook call", "format" : "int32", "example" : null }, "type" : { "type" : "string", "description" : "The type of auth: SIGNATURE", "example" : null, "default" : "SIGNATURE", "enum" : [ "SIGNATURE" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiSimpleInputFieldDefinition" : { "title" : "SIMPLE", "required" : [ "fieldDefinitionType", "isRequired", "name", "type" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A full description of this field.", "example" : null }, "fieldDefinitionType" : { "type" : "string", "description" : "The CRM type of field.", "example" : null, "default" : "SIMPLE", "enum" : [ "SIMPLE" ] }, "isRequired" : { "type" : "boolean", "description" : "Whether or not this field is required", "example" : null }, "label" : { "type" : "string", "description" : "The human-readable label of this field.", "example" : null }, "name" : { "type" : "string", "description" : "The name of this field.", "example" : null }, "type" : { "type" : "string", "description" : "The type of field: SIMPLE", "example" : null, "enum" : [ "bool", "currency_number", "date", "datetime", "enumeration", "json", "number", "object_coordinates", "phone_number", "string" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiSingleConnectionAction" : { "title" : "SINGLE_CONNECTION", "required" : [ "actionId", "actionTypeId", "actionTypeVersion", "fields", "type" ], "type" : "object", "properties" : { "actionId" : { "type" : "string", "description" : "The unique identifier for the single connection action.", "example" : null }, "actionTypeId" : { "type" : "string", "description" : "The identifier for the type of action being performed.", "example" : null }, "actionTypeVersion" : { "type" : "integer", "description" : "Specifies the version of the action type.", "format" : "int32", "example" : null }, "connection" : { "$ref" : "#/components/schemas/ApiConnection" }, "fields" : { "type" : "object", "additionalProperties" : { "type" : "object", "properties" : { }, "example" : null }, "description" : "Contains the fields associated with the single connection action.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the action, which defaults to SINGLE_CONNECTION.", "example" : null, "default" : "SINGLE_CONNECTION", "enum" : [ "SINGLE_CONNECTION" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiSingleObjectCoordinatesValue" : { "title" : "SINGLE_OBJECT_COORDINATES", "required" : [ "coordinatesToken", "type" ], "type" : "object", "properties" : { "coordinatesToken" : { "type" : "string", "example" : null }, "type" : { "type" : "string", "example" : null, "default" : "SINGLE_OBJECT_COORDINATES", "enum" : [ "SINGLE_OBJECT_COORDINATES" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiSort" : { "required" : [ "order", "property" ], "type" : "object", "properties" : { "missing" : { "type" : "string", "description" : "Specifies how to handle sorting when the property is missing.", "example" : null }, "order" : { "type" : "string", "description" : "The order of sorting, with accepted values being ASC for ascending and DESC for descending.", "example" : null, "enum" : [ "ASC", "DESC" ] }, "property" : { "type" : "string", "description" : "The name of the property to sort by.", "example" : null } }, "example" : null }, "ApiStaticAppendValue" : { "title" : "STATIC_APPEND_VALUE", "required" : [ "staticAppendValue", "type" ], "type" : "object", "properties" : { "staticAppendValue" : { "type" : "string", "description" : "The value that will be appended to a specified property.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the append action, which defaults to STATIC_APPEND_VALUE.", "example" : null, "default" : "STATIC_APPEND_VALUE", "enum" : [ "STATIC_APPEND_VALUE" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiStaticBranch" : { "required" : [ "branchValue" ], "type" : "object", "properties" : { "branchValue" : { "type" : "string", "description" : "Specifies the value associated with the static branch.", "example" : null }, "connection" : { "$ref" : "#/components/schemas/ApiConnection" } }, "example" : null }, "ApiStaticBranchAction" : { "title" : "STATIC_BRANCH", "required" : [ "actionId", "inputValue", "staticBranches", "type" ], "type" : "object", "properties" : { "actionId" : { "type" : "string", "description" : "The unique identifier for this static branch action.", "example" : null }, "defaultBranch" : { "$ref" : "#/components/schemas/ApiConnection" }, "defaultBranchName" : { "type" : "string", "description" : "The name of the default branch in the static branch action.", "example" : null }, "inputValue" : { "description" : "Represents the input value for the static branch action, which can be of various types such as action data, object property, or static value.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiActionDataValue" }, { "$ref" : "#/components/schemas/ApiObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiStaticValue" }, { "$ref" : "#/components/schemas/ApiRelativeDateTimeValue" }, { "$ref" : "#/components/schemas/ApiTimestampValue" }, { "$ref" : "#/components/schemas/ApiIncrementValue" }, { "$ref" : "#/components/schemas/ApiFetchedObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiAppendObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiStaticAppendValue" }, { "$ref" : "#/components/schemas/ApiEnrollmentEventPropertyValue" }, { "$ref" : "#/components/schemas/ApiEnrollmentDatasetColumnValue" }, { "$ref" : "#/components/schemas/ApiActionOutputObjectPropertyValue" }, { "$ref" : "#/components/schemas/ApiSingleObjectCoordinatesValue" }, { "$ref" : "#/components/schemas/ApiListInputValue" }, { "$ref" : "#/components/schemas/ApiMapInputValue" } ] }, "staticBranches" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiStaticBranch" } }, "type" : { "type" : "string", "description" : "Indicates the type of the action, which defaults to STATIC_BRANCH.", "example" : null, "default" : "STATIC_BRANCH", "enum" : [ "STATIC_BRANCH" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiStaticDateAnchor" : { "title" : "STATIC_DATE_ANCHOR", "required" : [ "dayOfMonth", "month", "type" ], "type" : "object", "properties" : { "dayOfMonth" : { "type" : "integer", "description" : "The day of the month for the static date anchor.", "format" : "int32", "example" : null }, "month" : { "type" : "string", "description" : "The month component of the static date anchor, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER.", "example" : null, "enum" : [ "APRIL", "AUGUST", "DECEMBER", "FEBRUARY", "JANUARY", "JULY", "JUNE", "MARCH", "MAY", "NOVEMBER", "OCTOBER", "SEPTEMBER" ] }, "type" : { "type" : "string", "description" : "Indicates the type of the date anchor, which defaults to STATIC_DATE_ANCHOR.", "example" : null, "default" : "STATIC_DATE_ANCHOR", "enum" : [ "STATIC_DATE_ANCHOR" ] }, "year" : { "type" : "integer", "description" : "The year component of the static date anchor.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiStaticPropertyFilterDataSource" : { "title" : "STATIC_PROPERTY_FILTER", "required" : [ "name", "propertyName", "staticValue", "type" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Defines the name of the data source.", "example" : null }, "propertyName" : { "type" : "string", "description" : "Specifies the name of the property used in the static property filter.", "example" : null }, "sortBy" : { "$ref" : "#/components/schemas/ApiSort" }, "staticValue" : { "type" : "string", "description" : "Represents the static value used in the property filter.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of data source, which defaults to STATIC_PROPERTY_FILTER.", "example" : null, "default" : "STATIC_PROPERTY_FILTER", "enum" : [ "STATIC_PROPERTY_FILTER" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiStaticTimeZoneStrategy" : { "title" : "STATIC_TIME_ZONE", "required" : [ "timeZoneId", "type" ], "type" : "object", "properties" : { "timeZoneId" : { "type" : "string", "description" : "The identifier for the time zone.", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of time zone strategy, which defaults to STATIC_TIME_ZONE.", "example" : null, "default" : "STATIC_TIME_ZONE", "enum" : [ "STATIC_TIME_ZONE" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiStaticValue" : { "title" : "STATIC_VALUE", "required" : [ "staticValue", "type" ], "type" : "object", "properties" : { "staticValue" : { "type" : "string", "description" : "The specific static value that is used within the context of the API.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of the value, which defaults to STATIC_VALUE.", "example" : null, "default" : "STATIC_VALUE", "enum" : [ "STATIC_VALUE" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiTimeDelay" : { "required" : [ "daysOfWeek", "delta", "timeUnit" ], "type" : "object", "properties" : { "daysOfWeek" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "delta" : { "type" : "integer", "description" : "The amount of time to delay, specified as an integer.", "format" : "int32", "example" : null }, "timeOfDay" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "timeUnit" : { "type" : "string", "description" : "Defines the unit of time for the delay, with accepted values including: CENTURIES, DAYS, DECADES, ERAS, FOREVER, HALF_DAYS, HOURS, MICROS, MILLENNIA, MILLIS, MINUTES, MONTHS, NANOS, SECONDS, WEEKS, YEARS.", "example" : null, "enum" : [ "CENTURIES", "DAYS", "DECADES", "ERAS", "FOREVER", "HALF_DAYS", "HOURS", "MICROS", "MILLENNIA", "MILLIS", "MINUTES", "MONTHS", "NANOS", "SECONDS", "WEEKS", "YEARS" ] }, "timeZoneStrategy" : { "description" : "Specifies the strategy for determining the time zone for the delay.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiStaticTimeZoneStrategy" } ] } }, "example" : null }, "ApiTimeOfDay" : { "required" : [ "hour", "minute" ], "type" : "object", "properties" : { "hour" : { "type" : "integer", "description" : "The hour component of the time, represented as an integer.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time, represented as an integer.", "format" : "int32", "example" : null } }, "example" : null }, "ApiTimeWindow" : { "required" : [ "day" ], "type" : "object", "properties" : { "day" : { "type" : "string", "description" : "Specifies the day of the week for the time window, with accepted values being: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY.", "example" : null, "enum" : [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ] }, "endTime" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "startTime" : { "$ref" : "#/components/schemas/ApiTimeOfDay" } }, "example" : null }, "ApiTimestampValue" : { "title" : "TIMESTAMP", "required" : [ "timestampType", "type" ], "type" : "object", "properties" : { "timestampType" : { "type" : "string", "description" : "Specifies the type of timestamp, with the accepted value being EXECUTION_TIME.", "example" : null, "enum" : [ "EXECUTION_TIME" ] }, "type" : { "type" : "string", "description" : "Indicates the type of the timestamp value, which defaults to TIMESTAMP.", "example" : null, "default" : "TIMESTAMP", "enum" : [ "TIMESTAMP" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiUnEnrollmentSetting" : { "required" : [ "flowIds", "type" ], "type" : "object", "properties" : { "flowIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "type" : { "type" : "string", "description" : "Specifies the type of unenrollment setting, with possible values being ALL or SELECTIVE.", "example" : null, "enum" : [ "ALL", "SELECTIVE" ] } }, "example" : null }, "ApiWebhookAction" : { "title" : "WEBHOOK", "required" : [ "actionId", "method", "queryParams", "type", "webhookUrl" ], "type" : "object", "properties" : { "actionId" : { "type" : "string", "description" : "The unique identifier for the webhook action.", "example" : null }, "authSettings" : { "description" : "Defines the authentication settings for the webhook, which can include an authentication key or a signature.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/ApiAuthKeyWebhookAuthSettings" }, { "$ref" : "#/components/schemas/ApiSignatureWebhookAuthSettings" } ] }, "connection" : { "$ref" : "#/components/schemas/ApiConnection" }, "method" : { "type" : "string", "description" : "Specifies the HTTP method to be used for the webhook request, with accepted values including CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE.", "example" : null, "enum" : [ "CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE" ] }, "queryParams" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiInputVariable" } }, "type" : { "type" : "string", "description" : "Indicates the type of action, which defaults to WEBHOOK.", "example" : null, "default" : "WEBHOOK", "enum" : [ "WEBHOOK" ] }, "webhookUrl" : { "type" : "string", "description" : "The URL to which the webhook request will be sent.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiWeeklyEnrollmentSchedule" : { "title" : "WEEKLY", "required" : [ "daysOfWeek", "timeOfDay", "type" ], "type" : "object", "properties" : { "daysOfWeek" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "timeOfDay" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "type" : { "type" : "string", "description" : "Indicates the type of enrollment schedule, which is 'WEEKLY'.", "example" : null, "default" : "WEEKLY", "enum" : [ "WEEKLY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "ApiYearlyEnrollmentSchedule" : { "title" : "YEARLY", "required" : [ "dayOfMonth", "month", "timeOfDay", "type" ], "type" : "object", "properties" : { "dayOfMonth" : { "type" : "integer", "description" : "The day of the month for the yearly enrollment schedule.", "format" : "int32", "example" : null }, "month" : { "type" : "string", "description" : "The month for the yearly enrollment schedule, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER.", "example" : null, "enum" : [ "APRIL", "AUGUST", "DECEMBER", "FEBRUARY", "JANUARY", "JULY", "JUNE", "MARCH", "MAY", "NOVEMBER", "OCTOBER", "SEPTEMBER" ] }, "timeOfDay" : { "$ref" : "#/components/schemas/ApiTimeOfDay" }, "type" : { "type" : "string", "description" : "Indicates the type of enrollment schedule, which defaults to 'YEARLY'.", "example" : null, "default" : "YEARLY", "enum" : [ "YEARLY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "BatchResponseApiFlow" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The date and time when the batch process was completed, formatted as a date-time string.", "format" : "date-time", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A collection of URLs related to the batch process, empty for this operation.", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The date and time when the batch request was initiated, formatted as a date-time string.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiFlow" } }, "startedAt" : { "type" : "string", "description" : "The date and time when the batch process began, formatted as a date-time string.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The current status of the batch process, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseApiFlowWithErrors" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The date and time when the batch process was completed, formatted as a date-time string.", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A collection of URLs related to the batch process.", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The total number of errors encountered during the batch process.", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The date and time when the batch request was initiated, formatted as a date-time string.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiFlow" } }, "startedAt" : { "type" : "string", "description" : "The date and time when the batch process began, formatted as a date-time string.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The current status of the batch process, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseFlowIdWorkflowIdMappingResponse" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The date and time when the batch process was completed, formatted as a date-time string.", "format" : "date-time", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A collection of URLs related to the batch process.", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The date and time when the batch request was initiated, formatted as a date-time string.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/FlowIdWorkflowIdMappingResponse" } }, "startedAt" : { "type" : "string", "description" : "The date and time when the batch process began, formatted as a date-time string.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The current status of the batch process, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseFlowIdWorkflowIdMappingResponseWithErrors" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "numErrors" : { "type" : "integer", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/FlowIdWorkflowIdMappingResponse" } }, "startedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "CollectionResponseApiActionTypeDefinitionNoPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiActionTypeDefinition" } } }, "example" : null }, "CollectionResponseApiFlowEmailCampaign" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiFlowEmailCampaign" } } }, "example" : null }, "CollectionResponseApiFlowListingForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ApiFlowListing" } } }, "example" : null }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The error category", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "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", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", "example" : null }, "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", "example" : null } }, "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" } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The status code associated with the error detail", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "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.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "example" : null }, "FlowIdWorkflowIdMappingResponse" : { "required" : [ "flowId", "workflowId" ], "type" : "object", "properties" : { "flowId" : { "type" : "integer", "description" : "The unique identifier for the flow associated with the workflow.", "format" : "int64", "example" : null }, "workflowId" : { "type" : "integer", "description" : "The unique identifier for the workflow associated with the flow.", "format" : "int32", "example" : null } }, "example" : null }, "ForwardPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" } }, "example" : null }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A paging cursor token for retrieving subsequent pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the next page results.", "example" : null } }, "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response", "example" : null }, "Option" : { "required" : [ "description", "displayOrder", "doubleData", "hidden", "label", "readOnly", "value" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A description of the option.", "example" : null }, "displayOrder" : { "type" : "integer", "description" : "The position of the item relative to others in the list.", "format" : "int32", "example" : null }, "doubleData" : { "type" : "number", "description" : "The data if it's a floating-point number", "example" : null }, "hidden" : { "type" : "boolean", "description" : "Whether the option is displayed in HubSpot's UI.", "example" : null }, "label" : { "type" : "string", "description" : "A user-friendly label that identifies the option.", "example" : null }, "readOnly" : { "type" : "boolean", "description" : "Whether the option is read-only.", "example" : null }, "value" : { "type" : "string", "description" : "The actual value of the option.", "example" : null } }, "description" : "A HubSpot property option", "example" : null }, "Paging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" }, "prev" : { "$ref" : "#/components/schemas/PreviousPage" } }, "example" : null }, "PreviousPage" : { "required" : [ "before" ], "type" : "object", "properties" : { "before" : { "type" : "string", "description" : "A paging cursor token for retrieving previous pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the previous pages' results.", "example" : null } }, "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response", "example" : null }, "PublicAbsoluteComparativeTimestampRefineBy" : { "title" : "ABSOLUTE_COMPARATIVE", "required" : [ "comparison", "timestamp", "type" ], "type" : "object", "properties" : { "comparison" : { "type" : "string", "description" : "Defines the comparison operation used in the absolute comparative timestamp refinement.", "example" : null }, "timestamp" : { "type" : "integer", "description" : "Specifies the timestamp used for the absolute comparative refinement, represented as an integer.", "format" : "int64", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of refinement, which defaults to ABSOLUTE_COMPARATIVE.", "example" : null, "default" : "ABSOLUTE_COMPARATIVE", "enum" : [ "ABSOLUTE_COMPARATIVE" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicAbsoluteRangedTimestampRefineBy" : { "title" : "ABSOLUTE_RANGED", "required" : [ "lowerTimestamp", "rangeType", "type", "upperTimestamp" ], "type" : "object", "properties" : { "lowerTimestamp" : { "type" : "integer", "description" : "Specifies the lower limit of the timestamp range.", "format" : "int64", "example" : null }, "rangeType" : { "type" : "string", "description" : "Specifies the type of range used for the timestamp refinement.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of timestamp refinement, which defaults to ABSOLUTE_RANGED.", "example" : null, "default" : "ABSOLUTE_RANGED", "enum" : [ "ABSOLUTE_RANGED" ] }, "upperTimestamp" : { "type" : "integer", "description" : "Specifies the upper limit of the timestamp range.", "format" : "int64", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicAdsSearchFilter" : { "title" : "ADS_SEARCH", "required" : [ "adNetwork", "entityType", "filterType", "operator", "searchTermType", "searchTerms" ], "type" : "object", "properties" : { "adNetwork" : { "type" : "string", "description" : "Specifies the ad network associated with the ads search filter.", "example" : null }, "entityType" : { "type" : "string", "description" : "Specifies the type of entity involved in the ads search filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to ADS_SEARCH.", "example" : null, "default" : "ADS_SEARCH", "enum" : [ "ADS_SEARCH" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the ads search filter.", "example" : null }, "searchTermType" : { "type" : "string", "description" : "Indicates the type of search terms used in the ads search filter.", "example" : null }, "searchTerms" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicAdsTimeFilter" : { "title" : "ADS_TIME", "required" : [ "filterType", "pruningRefineBy" ], "type" : "object", "properties" : { "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to ADS_TIME.", "example" : null, "default" : "ADS_TIME", "enum" : [ "ADS_TIME" ] }, "pruningRefineBy" : { "description" : "Specifies the criteria for pruning ads time data, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicAllHistoryRefineBy" : { "title" : "ALL_HISTORY", "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Specifies the type of refinement, which defaults to ALL_HISTORY.", "example" : null, "default" : "ALL_HISTORY", "enum" : [ "ALL_HISTORY" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicAllPropertyTypesOperation" : { "title" : "ALL_PROPERTY", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'ALL_PROPERTY'.", "example" : null, "default" : "ALL_PROPERTY", "enum" : [ "ALL_PROPERTY" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the all property types operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicAndFilterBranch" : { "title" : "AND", "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], "type" : "object", "properties" : { "filterBranchOperator" : { "type" : "string", "description" : "Defines the logical operator used to combine multiple filter branches.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch, defaulting to AND.", "example" : null, "default" : "AND", "enum" : [ "AND" ] }, "filterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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", "example" : null, "items" : { "example" : null, "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" } ] } } }, "example" : null, "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" : "Defines the category of the association.", "example" : null }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the type of association.", "format" : "int32", "example" : null }, "filterBranchOperator" : { "type" : "string", "description" : "Defines the logical operator used to combine multiple filter branches.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch, defaulting to ASSOCIATION.", "example" : null, "default" : "ASSOCIATION", "enum" : [ "ASSOCIATION" ] }, "filterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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", "example" : null, "items" : { "example" : null, "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" : "Represents the ID of the object type associated with the filter branch.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operator applied to the association filter.", "example" : null } }, "example" : null, "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.", "example" : null }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the type of association.", "format" : "int32", "example" : null }, "coalescingRefineBy" : { "description" : "Defines the criteria for refining associations using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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, which defaults to ASSOCIATION.", "example" : null, "default" : "ASSOCIATION", "enum" : [ "ASSOCIATION" ] }, "listId" : { "type" : "string", "description" : "The identifier of the list used in the association filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the association filter.", "example" : null }, "toObjectType" : { "type" : "string", "description" : "Specifies the type of object to which the association is made.", "example" : null }, "toObjectTypeId" : { "type" : "string", "description" : "Represents the ID of the object type associated with the filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicBoolPropertyOperation" : { "title" : "BOOL", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "value" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'BOOL'.", "example" : null, "default" : "BOOL", "enum" : [ "BOOL" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the boolean property operation.", "example" : null }, "value" : { "type" : "boolean", "description" : "The boolean value involved in the operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicCalendarDatePropertyOperation" : { "title" : "CALENDAR_DATE", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "timeUnit" ], "type" : "object", "properties" : { "fiscalYearStart" : { "type" : "string", "description" : "Defines the starting month of the fiscal year, with accepted values including: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER.", "example" : null, "enum" : [ "APRIL", "AUGUST", "DECEMBER", "FEBRUARY", "JANUARY", "JULY", "JUNE", "MARCH", "MAY", "NOVEMBER", "OCTOBER", "SEPTEMBER" ] }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'CALENDAR_DATE'.", "example" : null, "default" : "CALENDAR_DATE", "enum" : [ "CALENDAR_DATE" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the calendar date property operation.", "example" : null }, "timeUnit" : { "type" : "string", "description" : "Specifies the unit of time used in the operation.", "example" : null }, "timeUnitCount" : { "type" : "integer", "description" : "Indicates the number of time units involved in the operation.", "format" : "int32", "example" : null }, "useFiscalYear" : { "type" : "boolean", "description" : "Determines if the fiscal year should be used in the operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicCommunicationSubscriptionFilter" : { "title" : "COMMUNICATION_SUBSCRIPTION", "required" : [ "acceptedOptStates", "channel", "filterType", "subscriptionIds", "subscriptionType" ], "type" : "object", "properties" : { "acceptedOptStates" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "businessUnitId" : { "type" : "string", "description" : "Identifies the business unit associated with the subscription filter.", "example" : null }, "channel" : { "type" : "string", "description" : "Specifies the communication channel associated with the subscription filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to COMMUNICATION_SUBSCRIPTION.", "example" : null, "default" : "COMMUNICATION_SUBSCRIPTION", "enum" : [ "COMMUNICATION_SUBSCRIPTION" ] }, "subscriptionIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "subscriptionType" : { "type" : "string", "description" : "Defines the type of subscription related to the filter.", "example" : null } }, "example" : null, "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 used for comparison in the operation.", "example" : null }, "defaultComparisonValue" : { "type" : "string", "description" : "The default value used for comparison in the operation.", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'COMPARATIVE_DATE'.", "example" : null, "default" : "COMPARATIVE_DATE", "enum" : [ "COMPARATIVE_DATE" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the comparative date property operation.", "example" : null } }, "example" : null, "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 used for comparison in the operation.", "example" : null }, "defaultComparisonValue" : { "type" : "string", "description" : "Specifies the default value used for comparison if the property value is not set.", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'COMPARATIVE_PROPERTY_UPDATED'.", "example" : null, "default" : "COMPARATIVE_PROPERTY_UPDATED", "enum" : [ "COMPARATIVE_PROPERTY_UPDATED" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the comparative property updated operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicComparativeStringPropertyOperation" : { "title" : "COMPARATIVE_STRING", "required" : [ "comparisonPropertyName", "includeObjectsWithNoValueSet", "operationType", "operator" ], "type" : "object", "properties" : { "comparisonPropertyName" : { "type" : "string", "example" : null }, "defaultComparisonValue" : { "type" : "string", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "example" : null }, "operationType" : { "type" : "string", "example" : null, "default" : "COMPARATIVE_STRING", "enum" : [ "COMPARATIVE_STRING" ] }, "operator" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicConstantFilter" : { "title" : "CONSTANT", "required" : [ "filterType", "shouldAccept" ], "type" : "object", "properties" : { "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to CONSTANT.", "example" : null, "default" : "CONSTANT", "enum" : [ "CONSTANT" ] }, "shouldAccept" : { "type" : "boolean", "description" : "Determines whether the filter should accept the specified condition.", "example" : null }, "source" : { "type" : "string", "description" : "Specifies the source of the filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicCtaAnalyticsFilter" : { "title" : "CTA", "required" : [ "ctaName", "filterType", "operator" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Defines the criteria for refining CTA analytics, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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) used in the analytics filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to CTA.", "example" : null, "default" : "CTA", "enum" : [ "CTA" ] }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the CTA analytics filter.", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for pruning CTA analytics, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicDatePoint" : { "title" : "DATE", "required" : [ "day", "month", "timeType", "year", "zoneId" ], "type" : "object", "properties" : { "day" : { "type" : "integer", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "format" : "int32", "example" : null }, "second" : { "type" : "integer", "format" : "int32", "example" : null }, "timeType" : { "type" : "string", "example" : null, "default" : "DATE", "enum" : [ "DATE" ] }, "timezoneSource" : { "type" : "string", "example" : null }, "year" : { "type" : "integer", "format" : "int32", "example" : null }, "zoneId" : { "type" : "string", "example" : null } }, "example" : null, "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 component of the date operation.", "format" : "int32", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "month" : { "type" : "string", "description" : "The month component of the date operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'DATE'.", "example" : null, "default" : "DATE", "enum" : [ "DATE" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the date property operation.", "example" : null }, "year" : { "type" : "integer", "description" : "The year component of the date operation.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicDateTimePropertyOperation" : { "title" : "DATETIME", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "requiresTimeZoneConversion", "timestamp" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Determines if objects without a set value should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'DATETIME'.", "example" : null, "default" : "DATETIME", "enum" : [ "DATETIME" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the date-time property operation.", "example" : null }, "requiresTimeZoneConversion" : { "type" : "boolean", "description" : "Indicates whether time zone conversion is needed for the operation.", "example" : null }, "timestamp" : { "type" : "integer", "description" : "Specifies the timestamp involved in the date-time property operation.", "format" : "int64", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicEmailEventFilter" : { "title" : "EMAIL_EVENT", "required" : [ "appId", "emailId", "filterType", "level", "operator" ], "type" : "object", "properties" : { "appId" : { "type" : "string", "description" : "The identifier for the application associated with the email event.", "example" : null }, "clickUrl" : { "type" : "string", "description" : "The URL that was clicked in the email event.", "example" : null }, "emailId" : { "type" : "string", "description" : "The identifier for the email associated with the event.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to EMAIL_EVENT.", "example" : null, "default" : "EMAIL_EVENT", "enum" : [ "EMAIL_EVENT" ] }, "level" : { "type" : "string", "description" : "Specifies the level of the email event filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the email event filter, with accepted values being 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.", "example" : null, "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 email events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicEmailSubscriptionFilter" : { "title" : "EMAIL_SUBSCRIPTION", "required" : [ "acceptedStatuses", "filterType", "subscriptionIds" ], "type" : "object", "properties" : { "acceptedStatuses" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to EMAIL_SUBSCRIPTION.", "example" : null, "default" : "EMAIL_SUBSCRIPTION", "enum" : [ "EMAIL_SUBSCRIPTION" ] }, "subscriptionIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "subscriptionType" : { "type" : "string", "description" : "Specifies the type of subscription associated with the email subscription filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicEnumerationPropertyOperation" : { "title" : "ENUMERATION", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "values" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'ENUMERATION'.", "example" : null, "default" : "ENUMERATION", "enum" : [ "ENUMERATION" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the enumeration property operation.", "example" : null }, "values" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicEventAnalyticsFilter" : { "title" : "EVENT", "required" : [ "eventId", "filterType", "operator" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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 identifier for the event used in the event analytics filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to EVENT.", "example" : null, "default" : "EVENT", "enum" : [ "EVENT" ] }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the event analytics filter.", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for pruning events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicEventFilterMetadata" : { "required" : [ "operation", "property" ], "type" : "object", "properties" : { "operation" : { "example" : null, "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", "example" : null } }, "example" : null }, "PublicFiscalQuarterReference" : { "title" : "FISCAL_QUARTER", "required" : [ "day", "month", "referenceType" ], "type" : "object", "properties" : { "day" : { "type" : "integer", "description" : "The day component of the fiscal quarter reference, represented as an integer.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the time in the fiscal quarter reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time in the fiscal quarter reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time in the fiscal quarter reference.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the fiscal quarter reference, represented as an integer.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'FISCAL_QUARTER'.", "example" : null, "default" : "FISCAL_QUARTER", "enum" : [ "FISCAL_QUARTER" ] }, "second" : { "type" : "integer", "description" : "The second component of the time in the fiscal quarter reference.", "format" : "int32", "example" : null } }, "example" : null, "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, represented as an integer.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the time in the fiscal year reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time in the fiscal year reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time in the fiscal year reference.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the fiscal year reference, represented as an integer.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'FISCAL_YEAR'.", "example" : null, "default" : "FISCAL_YEAR", "enum" : [ "FISCAL_YEAR" ] }, "second" : { "type" : "integer", "description" : "The second component of the time in the fiscal year reference.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicFormSubmissionFilter" : { "title" : "FORM_SUBMISSION", "required" : [ "filterType", "operator" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Defines the criteria for refining form submissions, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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, which defaults to FORM_SUBMISSION.", "example" : null, "default" : "FORM_SUBMISSION", "enum" : [ "FORM_SUBMISSION" ] }, "formId" : { "type" : "string", "description" : "The unique identifier of the form used in the form submission filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the form submission filter, with accepted values being FILLED_OUT or NOT_FILLED_OUT.", "example" : null, "enum" : [ "FILLED_OUT", "NOT_FILLED_OUT" ] }, "pruningRefineBy" : { "description" : "Specifies the criteria for pruning form submissions, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "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 form submissions, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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, which defaults to FORM_SUBMISSION_ON_PAGE.", "example" : null, "default" : "FORM_SUBMISSION_ON_PAGE", "enum" : [ "FORM_SUBMISSION_ON_PAGE" ] }, "formId" : { "type" : "string", "description" : "The unique identifier of the form used in the form submission on page filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the form submission on page filter, with accepted values being FILLED_OUT or NOT_FILLED_OUT.", "example" : null, "enum" : [ "FILLED_OUT", "NOT_FILLED_OUT" ] }, "pageId" : { "type" : "string", "description" : "The identifier for the page used in the form submission on page filter.", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for pruning form submissions, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "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, which defaults to IN_LIST.", "example" : null, "default" : "IN_LIST", "enum" : [ "IN_LIST" ] }, "listId" : { "type" : "string", "description" : "The identifier of the list used in the in-list filter.", "example" : null }, "metadata" : { "$ref" : "#/components/schemas/PublicInListFilterMetadata" }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the in-list filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicInListFilterMetadata" : { "required" : [ "id", "inListType" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the filter metadata.", "example" : null }, "inListType" : { "type" : "string", "description" : "Specifies the type of list associated with the filter.", "example" : null } }, "example" : null }, "PublicIndexOffset" : { "type" : "object", "properties" : { "days" : { "type" : "integer", "description" : "The number of days to offset in the index.", "format" : "int32", "example" : null }, "hours" : { "type" : "integer", "description" : "The number of hours to offset in the index.", "format" : "int32", "example" : null }, "milliseconds" : { "type" : "integer", "description" : "The number of milliseconds to offset in the index.", "format" : "int32", "example" : null }, "minutes" : { "type" : "integer", "description" : "The number of minutes to offset in the index.", "format" : "int32", "example" : null }, "months" : { "type" : "integer", "description" : "The number of months to offset in the index.", "format" : "int32", "example" : null }, "quarters" : { "type" : "integer", "description" : "The number of quarters to offset in the index.", "format" : "int32", "example" : null }, "seconds" : { "type" : "integer", "description" : "The number of seconds to offset in the index.", "format" : "int32", "example" : null }, "weeks" : { "type" : "integer", "description" : "The number of weeks to offset in the index.", "format" : "int32", "example" : null }, "years" : { "type" : "integer", "description" : "The number of years to offset in the index.", "format" : "int32", "example" : null } }, "example" : null }, "PublicIndexedTimePoint" : { "title" : "INDEXED", "required" : [ "indexReference", "timeType", "zoneId" ], "type" : "object", "properties" : { "indexReference" : { "description" : "Specifies the reference point for the index, which can be one of several predefined time references such as NOW, TODAY, or specific fiscal periods.", "example" : null, "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" : "Indicates the type of time point, which defaults to INDEXED.", "example" : null, "default" : "INDEXED", "enum" : [ "INDEXED" ] }, "timezoneSource" : { "type" : "string", "description" : "Specifies the source of the time zone information for the indexed time point.", "example" : null }, "zoneId" : { "type" : "string", "description" : "Defines the time zone identifier used for the indexed time point.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicIntegrationEventFilter" : { "title" : "INTEGRATION_EVENT", "required" : [ "eventTypeId", "filterLines", "filterType" ], "type" : "object", "properties" : { "eventTypeId" : { "type" : "integer", "description" : "The identifier for the type of event associated with the integration event filter.", "format" : "int32", "example" : null }, "filterLines" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicEventFilterMetadata" } }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to INTEGRATION_EVENT.", "example" : null, "default" : "INTEGRATION_EVENT", "enum" : [ "INTEGRATION_EVENT" ] } }, "example" : null, "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, represented as an integer.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the time in the month reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time in the month reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time in the month reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'MONTH'.", "example" : null, "default" : "MONTH", "enum" : [ "MONTH" ] }, "second" : { "type" : "integer", "description" : "The second component of the time in the month reference.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicMultiStringPropertyOperation" : { "title" : "MULTISTRING", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "values" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'MULTISTRING'.", "example" : null, "default" : "MULTISTRING", "enum" : [ "MULTISTRING" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the multi-string property operation.", "example" : null }, "values" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicNotAllFilterBranch" : { "title" : "NOT_ALL", "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], "type" : "object", "properties" : { "filterBranchOperator" : { "type" : "string", "description" : "Defines the logical operator used to combine multiple filter branches.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch, defaulting to NOT_ALL.", "example" : null, "default" : "NOT_ALL", "enum" : [ "NOT_ALL" ] }, "filterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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", "example" : null, "items" : { "example" : null, "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" } ] } } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicNotAnyFilterBranch" : { "title" : "NOT_ANY", "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], "type" : "object", "properties" : { "filterBranchOperator" : { "type" : "string", "description" : "Defines the logical operator used to combine multiple filter branches.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch, defaulting to NOT_ANY.", "example" : null, "default" : "NOT_ANY", "enum" : [ "NOT_ANY" ] }, "filterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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", "example" : null, "items" : { "example" : null, "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" } ] } } }, "example" : null, "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", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the current time reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the current time reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'NOW'.", "example" : null, "default" : "NOW", "enum" : [ "NOW" ] }, "second" : { "type" : "integer", "description" : "The second component of the current time reference.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicNumOccurrencesRefineBy" : { "title" : "NUM_OCCURRENCES", "required" : [ "type" ], "type" : "object", "properties" : { "maxOccurrences" : { "type" : "integer", "description" : "Specifies the maximum number of occurrences allowed.", "format" : "int32", "example" : null }, "minOccurrences" : { "type" : "integer", "description" : "Specifies the minimum number of occurrences required.", "format" : "int32", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of refinement, which defaults to NUM_OCCURRENCES.", "example" : null, "default" : "NUM_OCCURRENCES", "enum" : [ "NUM_OCCURRENCES" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicNumberPropertyOperation" : { "title" : "NUMBER", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "value" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'NUMBER'.", "example" : null, "default" : "NUMBER", "enum" : [ "NUMBER" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the number property operation.", "example" : null }, "value" : { "type" : "number", "description" : "The numeric value involved in the operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicOrFilterBranch" : { "title" : "OR", "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], "type" : "object", "properties" : { "filterBranchOperator" : { "type" : "string", "description" : "Defines the logical operator used to combine multiple filter branches.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch, defaulting to OR.", "example" : null, "default" : "OR", "enum" : [ "OR" ] }, "filterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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", "example" : null, "items" : { "example" : null, "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" } ] } } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicPageViewAnalyticsFilter" : { "title" : "PAGE_VIEW", "required" : [ "filterType", "operator", "pageUrl" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Defines the criteria for refining page view analytics, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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" : "Determines whether tracking is enabled for the page view analytics filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to PAGE_VIEW.", "example" : null, "default" : "PAGE_VIEW", "enum" : [ "PAGE_VIEW" ] }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the page view analytics filter.", "example" : null }, "pageUrl" : { "type" : "string", "description" : "The URL of the page used in the page view analytics filter.", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for pruning page view analytics, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicPrivacyAnalyticsFilter" : { "title" : "PRIVACY", "required" : [ "filterType", "operator", "privacyName" ], "type" : "object", "properties" : { "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to PRIVACY.", "example" : null, "default" : "PRIVACY", "enum" : [ "PRIVACY" ] }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the privacy analytics filter.", "example" : null }, "privacyName" : { "type" : "string", "description" : "The name associated with the privacy analytics filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicPropertyFilter" : { "title" : "PROPERTY", "required" : [ "filterType", "operation", "property" ], "type" : "object", "properties" : { "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to PROPERTY.", "example" : null, "default" : "PROPERTY", "enum" : [ "PROPERTY" ] }, "operation" : { "description" : "Defines the operation to be performed on the property, which can include various types such as boolean, number, string, date-time, and others.", "example" : null, "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 to be filtered.", "example" : null } }, "example" : null, "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 being referenced.", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference used for the property.", "example" : null }, "timeType" : { "type" : "string", "description" : "Indicates the type of time reference, defaulting to 'PROPERTY_REFERENCED'.", "example" : null, "default" : "PROPERTY_REFERENCED", "enum" : [ "PROPERTY_REFERENCED" ] }, "timezoneSource" : { "type" : "string", "description" : "Specifies the source of the time zone information for the property-referenced time.", "example" : null }, "zoneId" : { "type" : "string", "description" : "Defines the time zone identifier for the property-referenced time.", "example" : null } }, "example" : null, "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", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the time in the quarter reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time in the quarter reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time in the quarter reference.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the quarter reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'QUARTER'.", "example" : null, "default" : "QUARTER", "enum" : [ "QUARTER" ] }, "second" : { "type" : "integer", "description" : "The second component of the time in the quarter reference.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicRangedDatePropertyOperation" : { "title" : "RANGED_DATE", "required" : [ "includeObjectsWithNoValueSet", "lowerBound", "operationType", "operator", "requiresTimeZoneConversion", "upperBound" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Determines if objects without a set value should be included.", "example" : null }, "lowerBound" : { "type" : "integer", "description" : "Specifies the lower limit for the date range.", "format" : "int64", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which is 'RANGED_DATE'.", "example" : null, "default" : "RANGED_DATE", "enum" : [ "RANGED_DATE" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the date range operation.", "example" : null }, "requiresTimeZoneConversion" : { "type" : "boolean", "description" : "Indicates whether time zone conversion is needed.", "example" : null }, "upperBound" : { "type" : "integer", "description" : "Specifies the upper limit for the date range.", "format" : "int64", "example" : null } }, "example" : null, "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 without a value set should be included.", "example" : null }, "lowerBound" : { "type" : "integer", "description" : "Specifies the lower limit for the number range.", "format" : "int64", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which is 'NUMBER_RANGED'.", "example" : null, "default" : "NUMBER_RANGED", "enum" : [ "NUMBER_RANGED" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the ranged number property operation.", "example" : null }, "upperBound" : { "type" : "integer", "description" : "Specifies the upper limit for the number range.", "format" : "int64", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicRangedTimeOperation" : { "title" : "TIME_RANGED", "required" : [ "includeObjectsWithNoValueSet", "lowerBoundTimePoint", "operationType", "operator", "type", "upperBoundTimePoint" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Determines if objects without a set value should be included in the operation.", "example" : null }, "lowerBoundEndpointBehavior" : { "type" : "string", "description" : "Indicates the behavior at the lower bound endpoint of the time range.", "example" : null }, "lowerBoundTimePoint" : { "description" : "Defines the lower limit for the time range.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/PublicDatePoint" }, { "$ref" : "#/components/schemas/PublicIndexedTimePoint" }, { "$ref" : "#/components/schemas/PublicPropertyReferencedTime" } ] }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which is 'TIME_RANGED'.", "example" : null }, "operator" : { "type" : "string", "description" : "Defines the operator used in the time range operation.", "example" : null }, "propertyParser" : { "type" : "string", "description" : "Specifies the parser used for the property in the operation.", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'TIME_RANGED'.", "example" : null, "default" : "TIME_RANGED", "enum" : [ "TIME_RANGED" ] }, "upperBoundEndpointBehavior" : { "type" : "string", "description" : "Indicates the behavior at the upper bound endpoint of the time range.", "example" : null }, "upperBoundTimePoint" : { "description" : "Defines the upper limit for the time range.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/PublicDatePoint" }, { "$ref" : "#/components/schemas/PublicIndexedTimePoint" }, { "$ref" : "#/components/schemas/PublicPropertyReferencedTime" } ] } }, "example" : null, "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 used in the relative comparative timestamp refinement.", "example" : null }, "timeOffset" : { "$ref" : "#/components/schemas/PublicTimeOffset" }, "type" : { "type" : "string", "description" : "Specifies the type of refinement, which defaults to RELATIVE_COMPARATIVE.", "example" : null, "default" : "RELATIVE_COMPARATIVE", "enum" : [ "RELATIVE_COMPARATIVE" ] } }, "example" : null, "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 used for the timestamp refinement.", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of timestamp refinement, which defaults to RELATIVE_RANGED.", "example" : null, "default" : "RELATIVE_RANGED", "enum" : [ "RELATIVE_RANGED" ] }, "upperBoundOffset" : { "$ref" : "#/components/schemas/PublicTimeOffset" } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicRestrictedFilterBranch" : { "title" : "RESTRICTED", "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], "type" : "object", "properties" : { "filterBranchOperator" : { "type" : "string", "description" : "Defines the logical operator used to combine multiple filter branches.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch, defaulting to RESTRICTED.", "example" : null, "default" : "RESTRICTED", "enum" : [ "RESTRICTED" ] }, "filterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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", "example" : null, "items" : { "example" : null, "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" } ] } } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicRollingDateRangePropertyOperation" : { "title" : "ROLLING_DATE_RANGE", "required" : [ "includeObjectsWithNoValueSet", "numberOfDays", "operationType", "operator", "requiresTimeZoneConversion" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Determines if objects without a set value should be included.", "example" : null }, "numberOfDays" : { "type" : "integer", "description" : "Indicates the number of days for the rolling date range.", "format" : "int32", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'ROLLING_DATE_RANGE'.", "example" : null, "default" : "ROLLING_DATE_RANGE", "enum" : [ "ROLLING_DATE_RANGE" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the rolling date range operation.", "example" : null }, "requiresTimeZoneConversion" : { "type" : "boolean", "description" : "Indicates whether time zone conversion is needed.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicRollingPropertyUpdatedOperation" : { "title" : "ROLLING_PROPERTY_UPDATED", "required" : [ "includeObjectsWithNoValueSet", "numberOfDays", "operationType", "operator" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "example" : null }, "numberOfDays" : { "type" : "integer", "format" : "int32", "example" : null }, "operationType" : { "type" : "string", "example" : null, "default" : "ROLLING_PROPERTY_UPDATED", "enum" : [ "ROLLING_PROPERTY_UPDATED" ] }, "operator" : { "type" : "string", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicSetOccurrencesRefineBy" : { "title" : "SET_OCCURRENCES", "required" : [ "setType", "type" ], "type" : "object", "properties" : { "setType" : { "type" : "string", "description" : "Defines the set type used for occurrences refinement.", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of refinement, which defaults to SET_OCCURRENCES.", "example" : null, "default" : "SET_OCCURRENCES", "enum" : [ "SET_OCCURRENCES" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicStringPropertyOperation" : { "title" : "STRING", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "value" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a value set should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'STRING'.", "example" : null, "default" : "STRING", "enum" : [ "STRING" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the string property operation.", "example" : null }, "value" : { "type" : "string", "description" : "The string value involved in the operation.", "example" : null } }, "example" : null, "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, which defaults to SURVEY_MONKEY.", "example" : null, "default" : "SURVEY_MONKEY", "enum" : [ "SURVEY_MONKEY" ] }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the filter.", "example" : null }, "surveyId" : { "type" : "string", "description" : "The identifier for the survey.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicSurveyMonkeyValueFilter" : { "title" : "SURVEY_MONKEY_VALUE", "required" : [ "filterType", "operator", "surveyId", "surveyQuestion", "valueComparison" ], "type" : "object", "properties" : { "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to SURVEY_MONKEY_VALUE.", "example" : null, "default" : "SURVEY_MONKEY_VALUE", "enum" : [ "SURVEY_MONKEY_VALUE" ] }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the filter.", "example" : null }, "surveyAnswerColId" : { "type" : "string", "description" : "The identifier for the column of the survey answer.", "example" : null }, "surveyAnswerRowId" : { "type" : "string", "description" : "The identifier for the row of the survey answer.", "example" : null }, "surveyId" : { "type" : "string", "description" : "The identifier for the survey.", "example" : null }, "surveyQuestion" : { "type" : "string", "description" : "The text of the survey question.", "example" : null }, "valueComparison" : { "description" : "Defines the criteria for comparing the survey answer value.", "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicTimeOffset" : { "required" : [ "amount", "offsetDirection", "timeUnit" ], "type" : "object", "properties" : { "amount" : { "type" : "integer", "format" : "int64", "example" : null }, "offsetDirection" : { "type" : "string", "example" : null }, "timeUnit" : { "type" : "string", "example" : null } }, "example" : null }, "PublicTimePointOperation" : { "title" : "TIME_POINT", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "timePoint", "type" ], "type" : "object", "properties" : { "endpointBehavior" : { "type" : "string", "description" : "Describes the behavior of the endpoint in relation to the operation.", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects without a set value should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation, which defaults to 'TIME_POINT'.", "example" : null, "default" : "TIME_POINT", "enum" : [ "TIME_POINT" ] }, "operator" : { "type" : "string", "description" : "Defines the operator used in the time point operation.", "example" : null }, "propertyParser" : { "type" : "string", "description" : "Defines the parser used to interpret the property value in the operation.", "example" : null }, "timePoint" : { "description" : "Specifies the point in time used for the operation, which can be a date, indexed time, or property-referenced time.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/PublicDatePoint" }, { "$ref" : "#/components/schemas/PublicIndexedTimePoint" }, { "$ref" : "#/components/schemas/PublicPropertyReferencedTime" } ] }, "type" : { "type" : "string", "description" : "Indicates the specific type of the operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicTodayReference" : { "title" : "TODAY", "required" : [ "referenceType" ], "type" : "object", "properties" : { "hour" : { "type" : "integer", "description" : "The hour component of the time in the today reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time in the today reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time in the today reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'TODAY'.", "example" : null, "default" : "TODAY", "enum" : [ "TODAY" ] }, "second" : { "type" : "integer", "description" : "The second component of the time in the today reference.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicUnifiedEventsFilter" : { "title" : "UNIFIED_EVENTS", "required" : [ "filterLines", "filterType" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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 unified events filter.", "example" : null }, "filterLines" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicEventFilterMetadata" } }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to UNIFIED_EVENTS.", "example" : null, "default" : "UNIFIED_EVENTS", "enum" : [ "UNIFIED_EVENTS" ] }, "pruningRefineBy" : { "description" : "Specifies the criteria for pruning events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeRangedTimestampRefineBy.", "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicUnifiedEventsFilterBranch" : { "title" : "UNIFIED_EVENTS", "required" : [ "eventTypeId", "filterBranchOperator", "filterBranchType", "filterBranches", "filters", "operator" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Defines the criteria for refining events, using one of several possible schemas such as PublicNumOccurrencesRefineBy or PublicRelativeComparativeTimestampRefineBy.", "example" : null, "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 unified events filter branch.", "example" : null }, "filterBranchOperator" : { "type" : "string", "description" : "Defines the logical operator used to combine multiple filter branches.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch, defaulting to UNIFIED_EVENTS.", "example" : null, "default" : "UNIFIED_EVENTS", "enum" : [ "UNIFIED_EVENTS" ] }, "filterBranches" : { "type" : "array", "example" : null, "items" : { "example" : null, "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", "example" : null, "items" : { "example" : null, "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" : "Specifies the operator used in the unified events filter branch, with accepted values being HAS_COMPLETED or HAS_NOT_COMPLETED.", "example" : null, "enum" : [ "HAS_COMPLETED", "HAS_NOT_COMPLETED" ] }, "pruningRefineBy" : { "example" : null, "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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicWebinarFilter" : { "title" : "WEBINAR", "required" : [ "filterType", "operator" ], "type" : "object", "properties" : { "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which defaults to WEBINAR.", "example" : null, "default" : "WEBINAR", "enum" : [ "WEBINAR" ] }, "operator" : { "type" : "string", "description" : "Specifies the operator used in the webinar filter.", "example" : null }, "webinarId" : { "type" : "string", "description" : "The identifier for the webinar used in the filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicWeekReference" : { "title" : "WEEK", "required" : [ "dayOfWeek", "referenceType" ], "type" : "object", "properties" : { "dayOfWeek" : { "type" : "string", "description" : "The day of the week in the week reference, with accepted values including: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.", "example" : null, "enum" : [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ] }, "hour" : { "type" : "integer", "description" : "The hour component of the time in the week reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time in the week reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time in the week reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'WEEK'.", "example" : null, "default" : "WEEK", "enum" : [ "WEEK" ] }, "second" : { "type" : "integer", "description" : "The second component of the time in the week reference.", "format" : "int32", "example" : null } }, "example" : null, "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, represented as an integer.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the time in the year reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time in the year reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time in the year reference.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the year reference, represented as an integer.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, defaulting to 'YEAR'.", "example" : null, "default" : "YEAR", "enum" : [ "YEAR" ] }, "second" : { "type" : "integer", "description" : "The second component of the time in the year reference.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "StandardError" : { "required" : [ "category", "context", "errors", "links", "message", "status" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The main category of the error.", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Additional context-specific information related to the error.", "example" : null }, "errors" : { "type" : "array", "description" : "The detailed error objects.", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "id" : { "type" : "string", "description" : "A unique ID for the error instance.", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "URLs linking to documentation or resources associated with the error.", "example" : null }, "message" : { "type" : "string", "description" : "A human-readable string describing the error and possible remediation steps.", "example" : null }, "status" : { "type" : "string", "description" : "The HTTP status code associated with the error.", "example" : null }, "subCategory" : { "type" : "object", "properties" : { }, "description" : "A more specific error category within each main category.", "example" : null } }, "description" : "Ye olde error", "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "automation" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-product-tier-requirements" : { "marketing" : "PROFESSIONAL", "sales" : "PROFESSIONAL", "service" : "PROFESSIONAL", "cms" : "PROFESSIONAL", "commerce" : "PROFESSIONAL", "crmHub" : "PROFESSIONAL", "dataHub" : "PROFESSIONAL" } }