{ "openapi" : "3.0.1", "info" : { "title" : "CRM Lists", "description" : "CRUD operations to manage lists and list memberships", "version" : "v3", "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" }, "x-hubspot-related-documentation" : [ { "name" : "Lists Guide", "url" : "https://developers.hubspot.com/docs/guides/api/crm/lists/overview" } ] }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Basic" }, { "name" : "Batch" }, { "name" : "Search" } ], "paths" : { "/crm/v3/lists" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists_/crm/v3/lists", "parameters" : [ { "name" : "includeFilters", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } }, { "name" : "listIds", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListsByIdResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] }, "post" : { "tags" : [ "Basic" ], "operationId" : "post-/crm/v3/lists_/crm/v3/lists", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListCreateResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-write" ] } ] } }, "/crm/v3/lists/folders" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/folders_/crm/v3/lists/folders", "parameters" : [ { "name" : "folderId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null, "default" : "0" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListFolderFetchResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] }, "post" : { "tags" : [ "Basic" ], "operationId" : "post-/crm/v3/lists/folders_/crm/v3/lists/folders", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListFolderCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListFolderCreateResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/folders/move-list" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/folders/move-list_/crm/v3/lists/folders/move-list", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListMoveRequest" }, "example" : null } }, "required" : true }, "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/folders/{folderId}" : { "delete" : { "tags" : [ "Basic" ], "operationId" : "delete-/crm/v3/lists/folders/{folderId}_/crm/v3/lists/folders/{folderId}", "parameters" : [ { "name" : "folderId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/folders/{folderId}/move/{newParentFolderId}" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/folders/{folderId}/move/{newParentFolderId}_/crm/v3/lists/folders/{folderId}/move/{newParentFolderId}", "parameters" : [ { "name" : "folderId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "newParentFolderId", "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/ListFolderFetchResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/folders/{folderId}/rename" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/folders/{folderId}/rename_/crm/v3/lists/folders/{folderId}/rename", "parameters" : [ { "name" : "folderId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "newFolderName", "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/ListFolderFetchResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/idmapping" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/idmapping_/crm/v3/lists/idmapping", "parameters" : [ { "name" : "legacyListId", "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/PublicMigrationMapping" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] }, "post" : { "tags" : [ "Basic" ], "operationId" : "post-/crm/v3/lists/idmapping_/crm/v3/lists/idmapping", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicBatchMigrationMapping" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] } }, "/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve List by Name", "description" : "Retrieve a specific list by its name and object type ID. This endpoint allows you to fetch details about a list, including its properties and optionally its filters. It is useful for accessing list information based on specific criteria.", "operationId" : "get-/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName}_/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName}", "parameters" : [ { "name" : "listName", "in" : "path", "description" : "The name of the list to retrieve.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectTypeId", "in" : "path", "description" : "The object type ID of the list to retrieve.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "includeFilters", "in" : "query", "description" : "A boolean indicating whether to include filter details in the response. Defaults to false.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListFetchResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] } }, "/crm/v3/lists/records/memberships/batch/read" : { "post" : { "tags" : [ "Batch" ], "operationId" : "post-/crm/v3/lists/records/memberships/batch/read_/crm/v3/lists/records/memberships/batch/read", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputRecordIdInput" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseRecordIdWithMemberships" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseRecordIdWithMembershipsWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] } }, "/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships_/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships", "parameters" : [ { "name" : "objectTypeId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "recordId", "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/ApiCollectionResponseRecordListMembership" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] } }, "/crm/v3/lists/search" : { "post" : { "tags" : [ "Search" ], "operationId" : "post-/crm/v3/lists/search_/crm/v3/lists/search", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListSearchRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListSearchResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] } }, "/crm/v3/lists/{listId}" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/{listId}_/crm/v3/lists/{listId}", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "includeFilters", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListFetchResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] }, "delete" : { "tags" : [ "Basic" ], "operationId" : "delete-/crm/v3/lists/{listId}_/crm/v3/lists/{listId}", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/memberships" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/{listId}/memberships_/crm/v3/lists/{listId}/memberships", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "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" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "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, "default" : 100 } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiCollectionResponseJoinTimeAndRecordId" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] }, "delete" : { "tags" : [ "Basic" ], "operationId" : "delete-/crm/v3/lists/{listId}/memberships_/crm/v3/lists/{listId}/memberships", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/memberships/add" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/memberships/add_/crm/v3/lists/{listId}/memberships/add", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MembershipsUpdateResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/memberships/add-and-remove" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/memberships/add-and-remove_/crm/v3/lists/{listId}/memberships/add-and-remove", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MembershipChangeRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MembershipsUpdateResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/memberships/add-from/{sourceListId}" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/memberships/add-from/{sourceListId}_/crm/v3/lists/{listId}/memberships/add-from/{sourceListId}", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "sourceListId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/memberships/join-order" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/{listId}/memberships/join-order_/crm/v3/lists/{listId}/memberships/join-order", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "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" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "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, "default" : 100 } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiCollectionResponseJoinTimeAndRecordId" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] } }, "/crm/v3/lists/{listId}/memberships/remove" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/memberships/remove_/crm/v3/lists/{listId}/memberships/remove", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MembershipsUpdateResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/restore" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/restore_/crm/v3/lists/{listId}/restore", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/schedule-conversion" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/{listId}/schedule-conversion_/crm/v3/lists/{listId}/schedule-conversion", "parameters" : [ { "name" : "listId", "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/PublicListConversionResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] }, "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/schedule-conversion_/crm/v3/lists/{listId}/schedule-conversion", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicListConversionTime" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicListConversionResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] }, "delete" : { "tags" : [ "Basic" ], "operationId" : "delete-/crm/v3/lists/{listId}/schedule-conversion_/crm/v3/lists/{listId}/schedule-conversion", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/size-and-edits-history/between" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/v3/lists/{listId}/size-and-edits-history/between_/crm/v3/lists/{listId}/size-and-edits-history/between", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "endDate", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "startDate", "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/ListSizeAndEditHistoryResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read" ] } ] } }, "/crm/v3/lists/{listId}/update-list-filters" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/update-list-filters_/crm/v3/lists/{listId}/update-list-filters", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "enrollObjectsInWorkflows", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListFilterUpdateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListUpdateResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } }, "/crm/v3/lists/{listId}/update-list-name" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/v3/lists/{listId}/update-list-name_/crm/v3/lists/{listId}/update-list-name", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "includeFilters", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } }, { "name" : "listName", "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/ListUpdateResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "ils-lists-read", "ils-lists-write" ] } ] } } }, "components" : { "schemas" : { "ApiCollectionResponseJoinTimeAndRecordId" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/JoinTimeAndRecordId" } }, "total" : { "type" : "integer", "description" : "The total number of records that match the query.", "format" : "int64", "example" : null } }, "example" : null }, "ApiCollectionResponseRecordListMembership" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/RecordListMembership" } }, "total" : { "type" : "integer", "format" : "int64", "example" : null } }, "example" : null }, "BatchInputRecordIdInput" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/RecordIdInput" } } }, "example" : null }, "BatchResponseRecordIdWithMemberships" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "requestedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/RecordIdWithMemberships" } }, "startedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseRecordIdWithMembershipsWithErrors" : { "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/RecordIdWithMemberships" } }, "startedAt" : { "type" : "string", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "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 }, "JoinTimeAndRecordId" : { "required" : [ "membershipTimestamp", "recordId" ], "type" : "object", "properties" : { "membershipTimestamp" : { "type" : "string", "description" : "The date and time when the record was added to the list.", "format" : "date-time", "example" : null }, "recordId" : { "type" : "string", "description" : "The unique identifier of the record.", "example" : null } }, "example" : null }, "ListCreateRequest" : { "required" : [ "name", "objectTypeId", "processingType" ], "type" : "object", "properties" : { "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "The list of custom properties to tie to the list. Custom property name is the key, the value is the value.", "example" : null }, "filterBranch" : { "description" : "Filter branch object containing filtering criteria for the list", "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/PublicPropertyAssociationFilterBranch" }, { "$ref" : "#/components/schemas/PublicAssociationFilterBranch" } ] }, "listFolderId" : { "type" : "integer", "description" : "The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.", "format" : "int32", "example" : null }, "listPermissions" : { "$ref" : "#/components/schemas/PublicListPermissions" }, "membershipSettings" : { "$ref" : "#/components/schemas/PublicMembershipSettings" }, "name" : { "type" : "string", "description" : "The name of the list, which must be globally unique across all public lists in the portal.", "example" : null }, "objectTypeId" : { "type" : "string", "description" : "The object type ID of the type of objects that the list will store.", "example" : null }, "processingType" : { "type" : "string", "description" : "The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`.", "example" : null } }, "description" : "The request object used when creating a new object list.", "example" : { "filterBranch" : { "filterBranchType" : "OR", "filterBranches" : [ { "filterBranchType" : "AND", "filterBranches" : [ { "associationCategory" : "HUBSPOT_DEFINED", "associationTypeId" : 4, "filterBranchType" : "ASSOCIATION", "filters" : [ { "filterType" : "PROPERTY", "operation" : { "operationType" : "BOOL", "operator" : "IS_EQUAL_TO", "value" : true }, "property" : "hs_is_closed_won" } ], "objectTypeId" : "0-3", "operator" : "IN_LIST" } ], "filters" : [ { "filterType" : "PROPERTY", "operation" : { "operationType" : "MULTISTRING", "operator" : "IS_EQUAL_TO", "values" : [ "test", "name" ] }, "property" : "firstname" } ] } ] }, "name" : "Dynamic Association List Example", "objectTypeId" : "0-1", "processingType" : "DYNAMIC" } }, "ListCreateResponse" : { "required" : [ "list" ], "type" : "object", "properties" : { "list" : { "$ref" : "#/components/schemas/PublicObjectList" } }, "description" : "The response for a list create request.", "example" : { "list" : { "createdAt" : "2023-11-15T18:16:52.165Z", "createdById" : "123", "filterBranch" : { "filterBranchOperator" : "OR", "filterBranchType" : "OR", "filterBranches" : [ { "filterBranchOperator" : "AND", "filterBranchType" : "AND", "filterBranches" : [ { "associationCategory" : "HUBSPOT_DEFINED", "associationTypeId" : 4, "filterBranchOperator" : "AND", "filterBranchType" : "ASSOCIATION", "filters" : [ { "filterType" : "PROPERTY", "operation" : { "includeObjectsWithNoValueSet" : false, "operationType" : "BOOL", "operator" : "IS_EQUAL_TO", "value" : true }, "property" : "hs_is_closed_won" } ], "objectTypeId" : "0-3", "operator" : "IN_LIST" } ], "filters" : [ { "filterType" : "PROPERTY", "operation" : { "includeObjectsWithNoValueSet" : false, "operationType" : "MULTISTRING", "operator" : "IS_EQUAL_TO", "values" : [ "test", "name" ] }, "property" : "firstname" } ] } ] }, "filtersUpdatedAt" : "2023-11-15T18:16:52.165Z", "listId" : "1", "listVersion" : 1, "name" : "Dynamic Association List Example", "objectTypeId" : "0-1", "processingStatus" : "PROCESSING", "processingType" : "DYNAMIC", "updatedAt" : "2023-11-15T18:16:52.395Z", "updatedById" : "123" } } }, "ListFetchResponse" : { "required" : [ "list" ], "type" : "object", "properties" : { "list" : { "$ref" : "#/components/schemas/PublicObjectList" } }, "description" : "The response for a list fetch request.", "example" : null }, "ListFilterUpdateRequest" : { "required" : [ "filterBranch" ], "type" : "object", "properties" : { "filterBranch" : { "description" : "Updated filtering criteria for the list", "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/PublicPropertyAssociationFilterBranch" }, { "$ref" : "#/components/schemas/PublicAssociationFilterBranch" } ] } }, "description" : "The definition of the list filter branch update request.", "example" : { "filterBranch" : { "filterBranchType" : "OR", "filterBranches" : [ { "filterBranchType" : "AND", "filters" : [ { "filterType" : "PROPERTY", "operation" : { "operationType" : "NUMBER", "operator" : "IS_GREATER_THAN_OR_EQUAL_TO", "value" : 12 }, "property" : "hs_predictivecontactscore_v2" }, { "filterType" : "PROPERTY", "operation" : { "operationType" : "ALL_PROPERTY", "operator" : "IS_UNKNOWN" }, "property" : "engagements_last_meeting_booked_source" }, { "acceptedStatuses" : [ "OPT_IN" ], "filterType" : "EMAIL_SUBSCRIPTION", "subscriptionIds" : [ "81537745", "321981152" ] } ] } ] } } }, "ListFolderCreateRequest" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the folder to be created.", "example" : null }, "parentFolderId" : { "type" : "string", "description" : "The folder this should be created in, if not specified will be created in the root folder 0.", "example" : null } }, "example" : null }, "ListFolderCreateResponse" : { "required" : [ "folder" ], "type" : "object", "properties" : { "folder" : { "$ref" : "#/components/schemas/PublicListFolder" } }, "example" : null }, "ListFolderFetchResponse" : { "required" : [ "folder" ], "type" : "object", "properties" : { "folder" : { "$ref" : "#/components/schemas/PublicListFolder" } }, "example" : null }, "ListMoveRequest" : { "required" : [ "listId", "newFolderId" ], "type" : "object", "properties" : { "listId" : { "type" : "string", "description" : "The Id of the list to move.", "example" : null }, "newFolderId" : { "type" : "string", "description" : "The Id of folder to move the list to, the root folder is Id 0.", "example" : null } }, "example" : null }, "ListSearchRequest" : { "required" : [ "additionalProperties", "offset" ], "type" : "object", "properties" : { "additionalProperties" : { "type" : "array", "description" : "The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response.\n\nBy default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.", "example" : null, "items" : { "type" : "string", "example" : null } }, "count" : { "type" : "integer", "description" : "The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.", "format" : "int32", "example" : null }, "listIds" : { "type" : "array", "description" : "ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included", "example" : null, "items" : { "type" : "string", "example" : null } }, "objectTypeId" : { "type" : "string", "example" : null }, "offset" : { "type" : "integer", "description" : "Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.", "format" : "int32", "example" : null }, "processingTypes" : { "type" : "array", "description" : "List processing types to be included in search results. If not specified, all lists with all processing types will be included.", "example" : null, "items" : { "type" : "string", "example" : null } }, "query" : { "type" : "string", "description" : "The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.", "example" : null }, "sort" : { "type" : "string", "description" : "Sort field and order", "example" : null } }, "description" : "The request object used for searching through lists.", "example" : { "additionalProperties" : [ "hs_list_size_week_delta" ], "count" : 100, "offset" : 0, "query" : "Test" } }, "ListSearchResponse" : { "required" : [ "hasMore", "lists", "offset", "total" ], "type" : "object", "properties" : { "hasMore" : { "type" : "boolean", "description" : "Whether or not there are more results to page through.", "example" : null }, "lists" : { "type" : "array", "description" : "The lists that matched the search criteria.", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicObjectListSearchResult" } }, "offset" : { "type" : "integer", "description" : "Value to be passed in a future request to paginate through list search results.", "format" : "int32", "example" : null }, "total" : { "type" : "integer", "description" : "The total number of lists that match the search criteria.", "format" : "int32", "example" : null } }, "description" : "The response object with the list search hits and additional information regarding pagination.", "example" : { "hasMore" : false, "lists" : [ { "additionalProperties" : { "hs_last_record_added_at" : "1695938616824", "hs_list_reference_count" : "0", "hs_list_size" : "59", "hs_list_size_week_delta" : "-10" }, "createdAt" : "2023-09-28T22:03:17.998Z", "createdById" : "1", "filtersUpdatedAt" : "2023-09-28T22:03:17.998Z", "listId" : "123", "listVersion" : 1, "name" : "Test list", "objectTypeId" : "0-1", "processingStatus" : "COMPLETE", "processingType" : "SNAPSHOT", "updatedAt" : "2023-09-28T22:03:37.005Z", "updatedById" : "1" } ], "offset" : 1, "total" : 1 } }, "ListSizeAndEditHistoryResponse" : { "required" : [ "editHistory", "sizeHistory" ], "type" : "object", "properties" : { "editHistory" : { "type" : "array", "example" : null, "items" : { "type" : "string", "format" : "date-time", "example" : null } }, "sizeHistory" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ListSizeDataPoint" } } }, "example" : null }, "ListSizeDataPoint" : { "required" : [ "size", "timestamp" ], "type" : "object", "properties" : { "size" : { "type" : "integer", "format" : "int64", "example" : null }, "timestamp" : { "type" : "string", "format" : "date-time", "example" : null } }, "example" : null }, "ListUpdateResponse" : { "type" : "object", "properties" : { "updatedList" : { "$ref" : "#/components/schemas/PublicObjectList" } }, "description" : "The updated definition of the list in response to a list update request.", "example" : null }, "ListsByIdResponse" : { "required" : [ "lists" ], "type" : "object", "properties" : { "lists" : { "type" : "array", "description" : "The object list definitions.", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicObjectList" } } }, "description" : "The response object containing the lists found for a multi-list fetch.", "example" : null }, "MembershipChangeRequest" : { "required" : [ "recordIdsToAdd", "recordIdsToRemove" ], "type" : "object", "properties" : { "recordIdsToAdd" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "recordIdsToRemove" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, "description" : "The IDs of the records to add and/or remove from a list.", "example" : { "recordIdsToAdd" : [ "123", "456", "789" ], "recordIdsToRemove" : [ "654" ] } }, "MembershipsUpdateResponse" : { "required" : [ "recordIdsMissing", "recordIdsRemoved", "recordsIdsAdded" ], "type" : "object", "properties" : { "recordIdsMissing" : { "type" : "array", "description" : "The IDs of the records that were `missing` (e.g. did not exist in the portal) and so were not `added` or `removed`.", "example" : null, "items" : { "type" : "string", "example" : null } }, "recordIdsRemoved" : { "type" : "array", "description" : "The IDs of the records that were `removed` from the list.", "example" : null, "items" : { "type" : "string", "example" : null } }, "recordsIdsAdded" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, "description" : "The IDs of the records that were `added`, `removed`, and/or found to be `missing` as a result of the \nmembership update request.", "example" : null }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "The offset for the next page of records.", "example" : null }, "link" : { "type" : "string", "description" : "A direct link to the request for the next page of records.", "example" : null } }, "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response", "example" : null }, "Paging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" }, "prev" : { "$ref" : "#/components/schemas/PreviousPage" } }, "description" : "The cursor to be used for paging through records.", "example" : null }, "PreviousPage" : { "required" : [ "before" ], "type" : "object", "properties" : { "before" : { "type" : "string", "description" : "The offset of the previous page of records.", "example" : null }, "link" : { "type" : "string", "description" : "A direct link to the request for the previous page of records.", "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" : "Timestamp comparison options (BEFORE, AFTER)", "example" : null }, "timestamp" : { "type" : "integer", "description" : "Timestamp to be used in refine by criteria", "format" : "int64", "example" : null }, "type" : { "type" : "string", "description" : "type of refine by criteria (ABSOLUTE_COMPARATIVE)", "example" : null, "enum" : [ "ABSOLUTE_COMPARATIVE" ], "default" : "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" : "Lower range timestamp of refinement criteria", "format" : "int64", "example" : null }, "rangeType" : { "type" : "string", "description" : "Type of range of refinement critaria (BETWEEN, NOT_BETWEEN)", "example" : null }, "type" : { "type" : "string", "description" : "type of refine by criteria (ABSOLUTE_RANGED)", "example" : null, "enum" : [ "ABSOLUTE_RANGED" ], "default" : "ABSOLUTE_RANGED" }, "upperTimestamp" : { "type" : "integer", "description" : "Upper range timestamp of refinement criteria", "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" : "Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL)", "example" : null }, "entityType" : { "type" : "string", "description" : "Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN)", "example" : null }, "filterType" : { "type" : "string", "description" : "Type of the filter (ADS_SEARCH)", "example" : null, "enum" : [ "ADS_SEARCH" ], "default" : "ADS_SEARCH" }, "operator" : { "type" : "string", "description" : "Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN)", "example" : null }, "searchTermType" : { "type" : "string", "description" : "Search term to match an ad", "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" : "Filter type (ADS_TIME)", "example" : null, "enum" : [ "ADS_TIME" ], "default" : "ADS_TIME" }, "pruningRefineBy" : { "description" : "Refinement criteria", "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" : "Type of refine by (ALL_HISTORY)", "example" : null, "enum" : [ "ALL_HISTORY" ], "default" : "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" : "Indication of whether objects with no value should be included", "example" : null }, "operationType" : { "type" : "string", "description" : "Type of operation (ALL_PROPERTY)", "example" : null, "enum" : [ "ALL_PROPERTY" ], "default" : "ALL_PROPERTY" }, "operator" : { "type" : "string", "description" : "Operator to be applied (IS_KNOWN, IS_UNKNOWN)", "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" : "Filter branch operator (AND)", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Type of filter branch (AND)", "example" : null, "enum" : [ "AND" ], "default" : "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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$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" : "Specifies the category of the association for the filter branch (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).", "example" : null }, "associationTypeId" : { "type" : "integer", "description" : "Type id of the association", "format" : "int32", "example" : null }, "filterBranchOperator" : { "type" : "string", "description" : "Filter branch operator (AND)", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Type of the filter branch (ASSOCIATION)", "example" : null, "enum" : [ "ASSOCIATION" ], "default" : "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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$ref" : "#/components/schemas/PublicConstantFilter" } ] } }, "objectTypeId" : { "type" : "string", "description" : "The ID representing the type of object associated with the filter branch.", "example" : null }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).", "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, such as (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).", "example" : null }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the type of association being filtered.", "format" : "int32", "example" : null }, "coalescingRefineBy" : { "description" : "Specifies the criteria for refining the association filter.", "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 being applied, which is 'ASSOCIATION' by default.", "example" : null, "enum" : [ "ASSOCIATION" ], "default" : "ASSOCIATION" }, "listId" : { "type" : "string", "description" : "The ID of the list used in the association filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operation to be performed by the filter, such as 'IN_LIST' or 'NOT_IN_LIST'.", "example" : null }, "toObjectType" : { "type" : "string", "description" : "The type of object that the association filter is targeting.", "example" : null }, "toObjectTypeId" : { "type" : "string", "description" : "The ID representing the type of object that the association filter is targeting.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicBatchMigrationMapping" : { "required" : [ "legacyListIdsToIdsMapping", "missingLegacyListIds" ], "type" : "object", "properties" : { "legacyListIdsToIdsMapping" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicMigrationMapping" } }, "missingLegacyListIds" : { "type" : "array", "description" : "A list of legacy list ids that were passed in but not found. It will be empty if no id's are missing", "example" : null, "items" : { "type" : "string", "example" : null } } }, "example" : null }, "PublicBoolPropertyOperation" : { "title" : "BOOL", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "value" ], "type" : "object", "properties" : { "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (BOOL).", "example" : null, "enum" : [ "BOOL" ], "default" : "BOOL" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the boolean property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).", "example" : null }, "value" : { "type" : "boolean", "description" : "The boolean value to be used 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" : "The month in which the fiscal year starts.", "example" : null, "enum" : [ "APRIL", "AUGUST", "DECEMBER", "FEBRUARY", "JANUARY", "JULY", "JUNE", "MARCH", "MAY", "NOVEMBER", "OCTOBER", "SEPTEMBER" ] }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects with no value set for the property should be included.", "example" : null }, "operationType" : { "type" : "string", "description" : "The type of operation, which is (CALENDAR_DATE).", "example" : null, "enum" : [ "CALENDAR_DATE" ], "default" : "CALENDAR_DATE" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied to the calendar date property (IN_THIS_TIME_UNIT, IN_THIS_TIME_UNIT_SO_FAR, IN_NEXT_TIME_UNIT, IN_LAST_TIME_UNIT).", "example" : null }, "timeUnit" : { "type" : "string", "description" : "The unit of time to be used in the operation (DAY, WEEK, MONTH, QUARTER, YEAR).", "example" : null }, "timeUnitCount" : { "type" : "integer", "description" : "The count of time units to be applied in the operation (1).", "format" : "int32", "example" : null }, "useFiscalYear" : { "type" : "boolean", "description" : "Specifies whether the fiscal year should be used in the operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicCampaignInfluencedFilter" : { "title" : "CAMPAIGN_INFLUENCED", "required" : [ "campaignId", "filterType" ], "type" : "object", "properties" : { "campaignId" : { "type" : "string", "description" : "The ID of the campaign that influences the filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter (CAMPAIGN_INFLUENCED).", "example" : null, "enum" : [ "CAMPAIGN_INFLUENCED" ], "default" : "CAMPAIGN_INFLUENCED" } }, "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" : "The ID of the business unit associated with the subscription filter.", "example" : null }, "channel" : { "type" : "string", "description" : "Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS).", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION)", "example" : null, "enum" : [ "COMMUNICATION_SUBSCRIPTION" ], "default" : "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 (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION)", "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 to compare against in the operation.", "example" : null }, "defaultComparisonValue" : { "type" : "string", "description" : "The default value used for comparison if the actual comparison property value is not set.", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "The type of operation (COMPARATIVE_DATE).", "example" : null, "enum" : [ "COMPARATIVE_DATE" ], "default" : "COMPARATIVE_DATE" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the comparative date property operation (IS_BEFORE, IS_AFTER).", "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 to compare against in the operation.", "example" : null }, "defaultComparisonValue" : { "type" : "string", "description" : "The default value used for comparison if the actual comparison property value is not set.", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (COMPARATIVE_PROPERTY_UPDATED).", "example" : null, "enum" : [ "COMPARATIVE_PROPERTY_UPDATED" ], "default" : "COMPARATIVE_PROPERTY_UPDATED" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicConstantFilter" : { "title" : "CONSTANT", "required" : [ "filterType", "shouldAccept" ], "type" : "object", "properties" : { "filterType" : { "type" : "string", "description" : "Specifies the type of filter, which is (CONSTANT).", "example" : null, "enum" : [ "CONSTANT" ], "default" : "CONSTANT" }, "shouldAccept" : { "type" : "boolean", "description" : "Indicates whether the filter should accept the condition.", "example" : null }, "source" : { "type" : "string", "description" : "Defines the source of the constant filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicCtaAnalyticsFilter" : { "title" : "CTA", "required" : [ "ctaName", "filterType", "operator" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Specifies the criteria for refining the filter by coalescing.", "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) to be used in the filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter being applied, which is (CTA).", "example" : null, "enum" : [ "CTA" ], "default" : "CTA" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT).", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for refining the filter by pruning.", "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", "description" : "The day component of the date.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the time.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the time.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the time.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the date.", "format" : "int32", "example" : null }, "second" : { "type" : "integer", "description" : "The second component of the time.", "format" : "int32", "example" : null }, "timeType" : { "type" : "string", "description" : "Specifies the type of time (DATE).", "example" : null, "enum" : [ "DATE" ], "default" : "DATE" }, "timezoneSource" : { "type" : "string", "description" : "The source of the time zone information.", "example" : null }, "year" : { "type" : "integer", "description" : "The year component of the date.", "format" : "int32", "example" : null }, "zoneId" : { "type" : "string", "description" : "The identifier for the time zone.", "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 of the month for the date operation.", "format" : "int32", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects with no value set for the property should be included.", "example" : null }, "month" : { "type" : "string", "description" : "The month for the date operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (DATE).", "example" : null, "enum" : [ "DATE" ], "default" : "DATE" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the date property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).", "example" : null }, "year" : { "type" : "integer", "description" : "The year for 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" : "Specifies whether objects without a set value should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "The type of operation (DATETIME).", "example" : null, "enum" : [ "DATETIME" ], "default" : "DATETIME" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied, such as comparison operators (IS_BEFORE, IS_AFTER).", "example" : null }, "requiresTimeZoneConversion" : { "type" : "boolean", "description" : "Indicates whether the timestamp requires conversion to a different time zone.", "example" : null }, "timestamp" : { "type" : "integer", "description" : "The specific point in time used in the 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 ID of the application associated with the email event filter.", "example" : null }, "clickUrl" : { "type" : "string", "description" : "The URL that was clicked in the email event.", "example" : null }, "emailId" : { "type" : "string", "description" : "The ID of the email associated with the event filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter (EMAIL_EVENT).", "example" : null, "enum" : [ "EMAIL_EVENT" ], "default" : "EMAIL_EVENT" }, "level" : { "type" : "string", "description" : "Specifies the level of the email event, such as EMAIL_API_CAMPAIGN_GROUP.", "example" : null }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter (BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED).", "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 the filter by pruning.", "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 (EMAIL_SUBSCRIPTION).", "example" : null, "enum" : [ "EMAIL_SUBSCRIPTION" ], "default" : "EMAIL_SUBSCRIPTION" }, "subscriptionIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "subscriptionType" : { "type" : "string", "description" : "The type of subscription related to the filter (PORTAL, BRAND, SUBSCRIPTION, HARDBOUNCE, SPAMREPORT).", "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 with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (ENUMERATION).", "example" : null, "enum" : [ "ENUMERATION" ], "default" : "ENUMERATION" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the enumeration property operation (IS_ANY_OF, IS_NONE_OF, IS_EXACTLY, IS_NOT_EXACTLY, CONTAINS_ALL, DOES_NOT_CONTAIN_ALL, HAS_EVER_BEEN_ANY_OF, HAS_NEVER_BEEN_ANY_OF, HAS_EVER_BEEN_EXACTLY, HAS_NEVER_BEEN_EXACTLY, HAS_EVER_CONTAINED_ALL, HAS_NEVER_CONTAINED_ALL).", "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" : "Specifies the criteria for refining the event filter by coalescing.", "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 ID of the event to be used in the filter.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter being applied (EVENT).", "example" : null, "enum" : [ "EVENT" ], "default" : "EVENT" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the event filter (HAS_EVENT, NOT_HAS_EVENT).", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for refining the event filter by pruning.", "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" : { "description" : "Defines the operation to be performed on the property", "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" } ] }, "property" : { "type" : "string", "description" : "Specifies the property on which the operation is to be applied.", "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.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the fiscal quarter reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the fiscal quarter reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the fiscal quarter reference.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the fiscal quarter reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference (FISCAL_QUARTER).", "example" : null, "enum" : [ "FISCAL_QUARTER" ], "default" : "FISCAL_QUARTER" }, "second" : { "type" : "integer", "description" : "The second component of 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.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the fiscal year reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the fiscal year reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the fiscal year reference.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the fiscal year reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference (FISCAL_YEAR).", "example" : null, "enum" : [ "FISCAL_YEAR" ], "default" : "FISCAL_YEAR" }, "second" : { "type" : "integer", "description" : "The second component of 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" : "Specifies the criteria for refining the filter by coalescing.", "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 (FORM_SUBMISSION).", "example" : null, "enum" : [ "FORM_SUBMISSION" ], "default" : "FORM_SUBMISSION" }, "formId" : { "type" : "string", "description" : "The ID of the form used in the filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operation to be performed (FILLED_OUT, NOT_FILLED_OUT).", "example" : null, "enum" : [ "FILLED_OUT", "NOT_FILLED_OUT" ] }, "pruningRefineBy" : { "description" : "Specifies the criteria for refining the filter by pruning.", "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 the filter by coalescing.", "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 (FORM_SUBMISSION_ON_PAGE).", "example" : null, "enum" : [ "FORM_SUBMISSION_ON_PAGE" ], "default" : "FORM_SUBMISSION_ON_PAGE" }, "formId" : { "type" : "string", "description" : "The ID of the form associated with the submission filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT).", "example" : null, "enum" : [ "FILLED_OUT", "NOT_FILLED_OUT" ] }, "pageId" : { "type" : "string", "description" : "The ID of the page where the form submission occurred.", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for refining the filter by pruning.", "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 being applied (IN_LIST).", "example" : null, "enum" : [ "IN_LIST" ], "default" : "IN_LIST" }, "listId" : { "type" : "string", "description" : "The ID of the list used in the association filter.", "example" : null }, "metadata" : { "$ref" : "#/components/schemas/PublicInListFilterMetadata" }, "operator" : { "type" : "string", "description" : "Specifies the operation to be performed by the filter (IN_LIST, NOT_IN_LIST).", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicInListFilterMetadata" : { "required" : [ "id", "inListType" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The identifier for the filter metadata.", "example" : null }, "inListType" : { "type" : "string", "description" : "Specifies the type of list for the filter (WORKFLOWS_ENROLLMENT, WORKFLOWS_ACTIVE, WORKFLOWS_GOAL, WORKFLOWS_COMPLETED, IMPORT, DATASET, DATASETS).", "example" : null } }, "example" : null }, "PublicIndexOffset" : { "type" : "object", "properties" : { "days" : { "type" : "integer", "description" : "The number of days to offset.", "format" : "int32", "example" : null }, "hours" : { "type" : "integer", "description" : "The number of hours to offset.", "format" : "int32", "example" : null }, "milliseconds" : { "type" : "integer", "description" : "The number of milliseconds to offset.", "format" : "int32", "example" : null }, "minutes" : { "type" : "integer", "description" : "The number of minutes to offset.", "format" : "int32", "example" : null }, "months" : { "type" : "integer", "description" : "The number of months to offset.", "format" : "int32", "example" : null }, "quarters" : { "type" : "integer", "description" : "The number of quarters to offset.", "format" : "int32", "example" : null }, "seconds" : { "type" : "integer", "description" : "The number of seconds to offset.", "format" : "int32", "example" : null }, "weeks" : { "type" : "integer", "description" : "The number of weeks to offset.", "format" : "int32", "example" : null }, "years" : { "type" : "integer", "description" : "The number of years to offset.", "format" : "int32", "example" : null } }, "example" : null }, "PublicIndexedTimePoint" : { "title" : "INDEXED", "required" : [ "indexReference", "timeType", "zoneId" ], "type" : "object", "properties" : { "indexReference" : { "description" : "Specifies the reference point in time for the indexed time point.", "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" : "Defines the type of time (INDEXED).", "example" : null, "enum" : [ "INDEXED" ], "default" : "INDEXED" }, "timezoneSource" : { "type" : "string", "description" : "Specifies the source of the time zone information for the indexed time point (CUSTOM, USER, PORTAL).", "example" : null }, "zoneId" : { "type" : "string", "description" : "Indicates the identifier for the time zone associated with 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 ID representing the type of event for 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 (INTEGRATION_EVENT).", "example" : null, "enum" : [ "INTEGRATION_EVENT" ], "default" : "INTEGRATION_EVENT" } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicListConversionDate" : { "title" : "CONVERSION_DATE", "required" : [ "conversionType", "day", "month", "year" ], "type" : "object", "properties" : { "conversionType" : { "type" : "string", "description" : "Specifies the type of conversion (CONVERSION_DATE).", "example" : null, "enum" : [ "CONVERSION_DATE" ], "default" : "CONVERSION_DATE" }, "day" : { "type" : "integer", "description" : "The day component of the conversion date.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the conversion date.", "format" : "int32", "example" : null }, "year" : { "type" : "integer", "description" : "The year component of the conversion date.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicListConversionInactivity" : { "title" : "INACTIVITY", "required" : [ "conversionType", "offset", "timeUnit" ], "type" : "object", "properties" : { "conversionType" : { "type" : "string", "description" : "Specifies the type of conversion (INACTIVITY).", "example" : null, "enum" : [ "INACTIVITY" ], "default" : "INACTIVITY" }, "offset" : { "type" : "integer", "description" : "Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.", "format" : "int32", "example" : null }, "timeUnit" : { "type" : "string", "description" : "The unit of time for the inactivity period, such as (DAY, MONTH, WEEK).", "example" : null, "enum" : [ "DAY", "MONTH", "WEEK" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicListConversionResponse" : { "required" : [ "listId" ], "type" : "object", "properties" : { "convertedAt" : { "type" : "string", "description" : "The date and time when the list was converted.", "format" : "date-time", "example" : null }, "listId" : { "type" : "string", "description" : "The unique identifier of the list for which the conversion details are provided.", "example" : null }, "requestedConversionTime" : { "description" : "The scheduled time for the list conversion, which can be based on a specific date or inactivity period.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/PublicListConversionDate" }, { "$ref" : "#/components/schemas/PublicListConversionInactivity" } ] } }, "example" : null }, "PublicListConversionTime" : { "properties" : { }, "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/PublicListConversionDate" }, { "$ref" : "#/components/schemas/PublicListConversionInactivity" } ] }, "PublicListFolder" : { "required" : [ "childLists", "childNodes", "id", "parentFolderId" ], "type" : "object", "properties" : { "childLists" : { "type" : "array", "description" : "An array of list Id's contained in this folder.", "example" : null, "items" : { "type" : "integer", "format" : "int32", "example" : null } }, "childNodes" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicListFolder" } }, "createdAt" : { "type" : "string", "description" : "The time the folder was created at.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The Id of the folder.", "example" : null }, "name" : { "type" : "string", "description" : "The name of the folder.", "example" : null }, "parentFolderId" : { "type" : "string", "description" : "The Id of the folder this folder is in, the root folder is represented as 0.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The time the folder was last updated at.", "format" : "date-time", "example" : null }, "updatedContentsAt" : { "type" : "string", "description" : "The time that the contents of the folder was last updated at.", "format" : "date-time", "example" : null }, "userId" : { "type" : "integer", "description" : "The user Id of the owner of the folder.", "format" : "int32", "example" : null } }, "example" : null }, "PublicListPermissions" : { "required" : [ "teamsWithEditAccess", "usersWithEditAccess" ], "type" : "object", "properties" : { "teamsWithEditAccess" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int32", "example" : null } }, "usersWithEditAccess" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int32", "example" : null } } }, "example" : null }, "PublicMembershipSettings" : { "type" : "object", "properties" : { "includeUnassigned" : { "type" : "boolean", "description" : "Indicates whether unassigned memberships should be included.", "example" : null }, "membershipTeamId" : { "type" : "integer", "description" : "The ID of the team associated with the membership.", "format" : "int32", "example" : null } }, "example" : null }, "PublicMigrationMapping" : { "required" : [ "legacyListId", "listId" ], "type" : "object", "properties" : { "legacyListId" : { "type" : "string", "description" : "The legacy list id for the list", "example" : null }, "listId" : { "type" : "string", "description" : "The V3 list id for the list", "example" : null } }, "example" : null }, "PublicMonthReference" : { "title" : "MONTH", "required" : [ "day", "referenceType" ], "type" : "object", "properties" : { "day" : { "type" : "integer", "description" : "The day component of the month reference.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the month reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the month reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the month reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference, (MONTH).", "example" : null, "enum" : [ "MONTH" ], "default" : "MONTH" }, "second" : { "type" : "integer", "description" : "The second component of 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 with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (MULTISTRING).", "example" : null, "enum" : [ "MULTISTRING" ], "default" : "MULTISTRING" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the multi-string property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, CONTAINS_EXACTLY, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_EXACTLY, STARTS_WITH, ENDS_WITH).", "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" : "The operator used to combine filters within the branch (NOT_ALL).", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "The type of the filter branch (NOT_ALL).", "example" : null, "enum" : [ "NOT_ALL" ], "default" : "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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$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" : "Specifies the logical operator used to combine filters within the branch (NOT_ANY).", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Indicates the type of filter branch (NOT_ANY).", "example" : null, "enum" : [ "NOT_ANY" ], "default" : "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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$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 (NOW).", "example" : null, "enum" : [ "NOW" ], "default" : "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 }, "PublicNumAssociationsFilter" : { "title" : "NUM_ASSOCIATIONS", "required" : [ "associationCategory", "associationTypeId", "coalescingRefineBy", "filterType" ], "type" : "object", "properties" : { "associationCategory" : { "type" : "string", "description" : "Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).", "example" : null }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the type of association being filtered.", "format" : "int32", "example" : null }, "coalescingRefineBy" : { "description" : "Specifies the criteria for refining the association filter.", "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 being applied (NUM_ASSOCIATIONS).", "example" : null, "enum" : [ "NUM_ASSOCIATIONS" ], "default" : "NUM_ASSOCIATIONS" } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicNumOccurrencesRefineBy" : { "title" : "NUM_OCCURRENCES", "required" : [ "type" ], "type" : "object", "properties" : { "maxOccurrences" : { "type" : "integer", "description" : "The maximum number of occurrences allowed.", "format" : "int32", "example" : null }, "minOccurrences" : { "type" : "integer", "description" : "The minimum number of occurrences required.", "format" : "int32", "example" : null }, "type" : { "type" : "string", "description" : "The type of refinement (NUM_OCCURRENCES).", "example" : null, "enum" : [ "NUM_OCCURRENCES" ], "default" : "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 with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (NUMBER).", "example" : null, "enum" : [ "NUMBER" ], "default" : "NUMBER" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the number property operation (IS_EQUAL_TO, IS_NOT_EQUAL_TO, IS_GREATER_THAN, IS_GREATER_THAN_OR_EQUAL_TO, IS_LESS_THAN, IS_LESS_THAN_OR_EQUAL_TO, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO).", "example" : null }, "value" : { "type" : "number", "description" : "The numeric value to be used in the operation.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicObjectList" : { "required" : [ "listId", "listVersion", "name", "objectTypeId", "processingStatus", "processingType" ], "type" : "object", "properties" : { "createdAt" : { "type" : "string", "description" : "The time when the list was created.", "format" : "date-time", "example" : null }, "createdById" : { "type" : "string", "description" : "The ID of the user that created the list.", "example" : null }, "deletedAt" : { "type" : "string", "description" : "The time when the list was deleted.", "format" : "date-time", "example" : null }, "filterBranch" : { "description" : "Defines the filter criteria for the list, allowing for complex logical operations and nested filter branches to determine list membership.", "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/PublicPropertyAssociationFilterBranch" }, { "$ref" : "#/components/schemas/PublicAssociationFilterBranch" } ] }, "filtersUpdatedAt" : { "type" : "string", "description" : "The time when the filters for this list were last updated.", "format" : "date-time", "example" : null }, "listId" : { "type" : "string", "description" : "The **ILS ID** of the list.", "example" : null }, "listPermissions" : { "$ref" : "#/components/schemas/PublicListPermissions" }, "listVersion" : { "type" : "integer", "description" : "The version of the list.", "format" : "int32", "example" : null }, "membershipSettings" : { "$ref" : "#/components/schemas/PublicMembershipSettings" }, "name" : { "type" : "string", "description" : "The name of the list.", "example" : null }, "objectTypeId" : { "type" : "string", "description" : "The object type of the list.", "example" : null }, "processingStatus" : { "type" : "string", "description" : "The processing status of the list.", "example" : null }, "processingType" : { "type" : "string", "description" : "The processing type of the list.", "example" : null }, "size" : { "type" : "integer", "description" : "Size of the list", "format" : "int64", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The time the list was last updated.", "format" : "date-time", "example" : null }, "updatedById" : { "type" : "string", "description" : "The ID of the user that last updated the list.", "example" : null } }, "description" : "An object list definition.", "example" : null }, "PublicObjectListSearchResult" : { "required" : [ "additionalProperties", "listId", "listVersion", "name", "objectTypeId", "processingStatus", "processingType" ], "type" : "object", "properties" : { "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "The name and value of any additional properties that exist for this list and that were included in the search request.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The time when the list was created.", "format" : "date-time", "example" : null }, "createdById" : { "type" : "string", "description" : "The ID of the user that created the list.", "example" : null }, "deletedAt" : { "type" : "string", "description" : "The time when the list was deleted.", "format" : "date-time", "example" : null }, "filtersUpdatedAt" : { "type" : "string", "description" : "The time when the filters for this list were last updated.", "format" : "date-time", "example" : null }, "listId" : { "type" : "string", "description" : "The **ILS ID** of the list.", "example" : null }, "listVersion" : { "type" : "integer", "description" : "The version of the list.", "format" : "int32", "example" : null }, "name" : { "type" : "string", "description" : "The name of the list.", "example" : null }, "objectTypeId" : { "type" : "string", "description" : "The object type of the list.", "example" : null }, "processingStatus" : { "type" : "string", "description" : "The processing status of the list.", "example" : null }, "processingType" : { "type" : "string", "description" : "The processing type of the list.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The time the list was last updated.", "format" : "date-time", "example" : null }, "updatedById" : { "type" : "string", "description" : "The ID of the user that last updated the list.", "example" : null } }, "example" : { "additionalProperties" : { "hs_last_record_added_at" : 1695938616824, "hs_list_reference_count" : 0, "hs_list_size" : 59, "hs_list_size_week_delta" : -1 }, "createdAt" : "2023-09-28T22:03:17.998Z", "createdById" : "1", "filtersUpdatedAt" : "2023-09-28T22:03:17.998Z", "listId" : "123", "listVersion" : 1, "name" : "Test list", "objectTypeId" : "0-1", "processingStatus" : "COMPLETED", "processingType" : "SNAPSHOT", "updatedById" : "1" } }, "PublicOrFilterBranch" : { "title" : "OR", "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters" ], "type" : "object", "properties" : { "filterBranchOperator" : { "type" : "string", "description" : "The logical operator used to combine the filters within the branch (OR).", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "The type of the filter branch (OR).", "example" : null, "enum" : [ "OR" ], "default" : "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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$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" : "Specifies the criteria for refining the filter by coalescing.", "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" : "Indicates whether tracking is enabled for the page view.", "example" : null }, "filterType" : { "type" : "string", "description" : "Indicates the type of filter being applied (PAGE_VIEW).", "example" : null, "enum" : [ "PAGE_VIEW" ], "default" : "PAGE_VIEW" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS).", "example" : null }, "pageUrl" : { "type" : "string", "description" : "The URL of the page to be used in the filter.", "example" : null }, "pruningRefineBy" : { "description" : "Specifies the criteria for refining the filter by pruning.", "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" : "Specifies the type of filter (PRIVACY).", "example" : null, "enum" : [ "PRIVACY" ], "default" : "PRIVACY" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter (PRIVACY_CONSENT_GRANTED, PRIVACY_CONSENT_NOT_GRANTED).", "example" : null }, "privacyName" : { "type" : "string", "description" : "The name of the privacy setting used in the filter.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicPropertyAssociationFilterBranch" : { "title" : "PROPERTY_ASSOCIATION", "required" : [ "filterBranchOperator", "filterBranchType", "filterBranches", "filters", "objectTypeId", "operator", "propertyWithObjectId" ], "type" : "object", "properties" : { "filterBranchOperator" : { "type" : "string", "description" : "The logical operator used to combine filters within the branch.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "The type of the filter branch (PROPERTY_ASSOCIATION).", "example" : null, "enum" : [ "PROPERTY_ASSOCIATION" ], "default" : "PROPERTY_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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$ref" : "#/components/schemas/PublicConstantFilter" } ] } }, "objectTypeId" : { "type" : "string", "description" : "The ID representing the type of object associated with the filter branch.", "example" : null }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter branch (IN_LIST, NOT_IN_LIST).", "example" : null }, "propertyWithObjectId" : { "type" : "string", "description" : "The property that is associated with the object ID in the filter branch.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicPropertyAssociationInListFilter" : { "title" : "PROPERTY_ASSOCIATION", "required" : [ "coalescingRefineBy", "filterType", "listId", "operator", "propertyWithObjectId" ], "type" : "object", "properties" : { "coalescingRefineBy" : { "description" : "Specifies the criteria for refining the filter by coalescing.", "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 being applied (PROPERTY_ASSOCIATION).", "example" : null, "enum" : [ "PROPERTY_ASSOCIATION" ], "default" : "PROPERTY_ASSOCIATION" }, "listId" : { "type" : "string", "description" : "The ID of the list used in the property association filter.", "example" : null }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST).", "example" : null }, "propertyWithObjectId" : { "type" : "string", "description" : "The property associated with the object ID in the filter.", "example" : null }, "toObjectTypeId" : { "type" : "string", "description" : "The ID representing the type of object that the property association filter is targeting.", "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 that the filter (PROPERTY).", "example" : null, "enum" : [ "PROPERTY" ], "default" : "PROPERTY" }, "operation" : { "description" : "Defines the operation to be performed on the property, such as comparison or value matching.", "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" } ] }, "property" : { "type" : "string", "description" : "Specifies the name of the property that the filter is applied to.", "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 that the time reference is applied to.", "example" : null }, "referenceType" : { "type" : "string", "description" : "Specifies the type of reference for the property (VALUE, UPDATED_AT, ANNIVERSARY, VALUE_WITH_ZONE_SAME_LOCAL_CONVERSION, ANNIVERSARY_WITH_ZONE_SAME_LOCAL_CONVERSION).", "example" : null }, "timeType" : { "type" : "string", "description" : "Defines the type of time (PROPERTY_REFERENCED).", "example" : null, "enum" : [ "PROPERTY_REFERENCED" ], "default" : "PROPERTY_REFERENCED" }, "timezoneSource" : { "type" : "string", "description" : "Specifies the source of the time zone information for the property (CUSTOM, USER, PORTAL).", "example" : null }, "zoneId" : { "type" : "string", "description" : "Indicates the identifier for the time zone associated with the property.", "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 quarter reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the quarter reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of 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 (QUARTER).", "example" : null, "enum" : [ "QUARTER" ], "default" : "QUARTER" }, "second" : { "type" : "integer", "description" : "The second component of 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" : "Specifies whether objects without a set value should be included in the operation.", "example" : null }, "lowerBound" : { "type" : "integer", "description" : "The lower limit of the date range for the operation.", "format" : "int64", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (RANGED_DATE).", "example" : null, "enum" : [ "RANGED_DATE" ], "default" : "RANGED_DATE" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the ranged date property operation (IS_BETWEEN, IS_NOT_BETWEEN).", "example" : null }, "requiresTimeZoneConversion" : { "type" : "boolean", "description" : "Indicates whether the operation requires conversion to a different time zone.", "example" : null }, "upperBound" : { "type" : "integer", "description" : "The upper limit of the date range for the operation.", "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 with no value set for the property should be included in the operation.", "example" : null }, "lowerBound" : { "type" : "integer", "description" : "The lower limit of the number range for the operation.", "format" : "int64", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (NUMBER_RANGED).", "example" : null, "enum" : [ "NUMBER_RANGED" ], "default" : "NUMBER_RANGED" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the ranged number property operation (IS_BETWEEN, IS_NOT_BETWEEN).", "example" : null }, "upperBound" : { "type" : "integer", "description" : "The upper limit of the number range for the operation.", "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" : "Indicates whether objects with no value set for the property should be included in the operation.", "example" : null }, "lowerBoundEndpointBehavior" : { "type" : "string", "description" : "Describes the behavior at the lower bound endpoint of the time range.", "example" : null }, "lowerBoundTimePoint" : { "description" : "Defines the lower bound time point for the operation.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/PublicDatePoint" }, { "$ref" : "#/components/schemas/PublicIndexedTimePoint" }, { "$ref" : "#/components/schemas/PublicPropertyReferencedTime" } ] }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (TIME_RANGED).", "example" : null }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the time range (IS_BETWEEN, IS_NOT_BETWEEN).", "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 (TIME_RANGED).", "example" : null, "enum" : [ "TIME_RANGED" ], "default" : "TIME_RANGED" }, "upperBoundEndpointBehavior" : { "type" : "string", "description" : "Describes the behavior at the upper bound endpoint of the time range.", "example" : null }, "upperBoundTimePoint" : { "description" : "Defines the upper bound time point for the operation.", "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 to be used in the refinement (BEFORE, AFTER).", "example" : null }, "timeOffset" : { "$ref" : "#/components/schemas/PublicTimeOffset" }, "type" : { "type" : "string", "description" : "Specifies the type of refinement, (RELATIVE_COMPARATIVE).", "example" : null, "enum" : [ "RELATIVE_COMPARATIVE" ], "default" : "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 for the refinement criteria (BETWEEN, NOT_BETWEEN).", "example" : null }, "type" : { "type" : "string", "description" : "Indicates the type of refinement (RELATIVE_RANGED).", "example" : null, "enum" : [ "RELATIVE_RANGED" ], "default" : "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" : "The logical operator used to combine filters within the restricted filter branch.", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "Specifies the type of the filter branch (RESTRICTED).", "example" : null, "enum" : [ "RESTRICTED" ], "default" : "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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$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" : "Indicates whether objects with no value set for the property should be included in the operation.", "example" : null }, "numberOfDays" : { "type" : "integer", "description" : "The number of days to be considered in the rolling date range operation.", "format" : "int32", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (ROLLING_DATE_RANGE).", "example" : null, "enum" : [ "ROLLING_DATE_RANGE" ], "default" : "ROLLING_DATE_RANGE" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the rolling date range property operation (IS_LESS_THAN_X_DAYS_AGO, IS_MORE_THAN_X_DAYS_AGO, IS_LESS_THAN_X_DAYS_FROM_NOW, IS_MORE_THAN_X_DAYS_FROM_NOW).", "example" : null }, "requiresTimeZoneConversion" : { "type" : "boolean", "description" : "Specifies whether the operation requires conversion to a different time zone.", "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", "description" : "Indicates whether objects with no value set for the property should be included in the operation.", "example" : null }, "numberOfDays" : { "type" : "integer", "description" : "The number of days to be considered in the rolling property updated operation.", "format" : "int32", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (ROLLING_PROPERTY_UPDATED).", "example" : null, "enum" : [ "ROLLING_PROPERTY_UPDATED" ], "default" : "ROLLING_PROPERTY_UPDATED" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the rolling property updated operation (UPDATED_IN_LAST_X_DAYS, NOT_UPDATED_IN_LAST_X_DAYS).", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicSetOccurrencesRefineBy" : { "title" : "SET_OCCURRENCES", "required" : [ "setType", "type" ], "type" : "object", "properties" : { "setType" : { "type" : "string", "description" : "Indicates the specific set type used in the refinement (ALL, ALL_INCLUDE_EMPTY, ANY, NONE, NONE_EXCLUDE_EMPTY, ANY_INCLUDE_EMPTY).", "example" : null }, "type" : { "type" : "string", "description" : "Specifies the type of refinement (SET_OCCURRENCES).", "example" : null, "enum" : [ "SET_OCCURRENCES" ], "default" : "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 with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (STRING).", "example" : null, "enum" : [ "STRING" ], "default" : "STRING" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied in the string property operation ()IS_EQUAL_TO, IS_NOT_EQUAL_TO, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, ENDS_WITH, HAS_EVER_BEEN_EQUAL_TO, HAS_NEVER_BEEN_EQUAL_TO, HAS_EVER_CONTAINED, HAS_NEVER_CONTAINED).", "example" : null }, "value" : { "type" : "string", "description" : "The string value to be used 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 being applied (SURVEY_MONKEY).", "example" : null, "enum" : [ "SURVEY_MONKEY" ], "default" : "SURVEY_MONKEY" }, "operator" : { "type" : "string", "description" : "Specifies the operation to be performed by the filter (HAS_RESPONDED_TO_SURVEY, HAS_NOT_RESPONDED_TO_SURVEY).", "example" : null }, "surveyId" : { "type" : "string", "description" : "The ID of the survey associated with the filter.", "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" : "Defines the type of filter (SURVEY_MONKEY_VALUE).", "example" : null, "enum" : [ "SURVEY_MONKEY_VALUE" ], "default" : "SURVEY_MONKEY_VALUE" }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter (HAS_ANSWERED_SURVEY_QUESTION_WITH_VALUE).", "example" : null }, "surveyAnswerColId" : { "type" : "string", "description" : "The column ID of the survey answer used in the filter.", "example" : null }, "surveyAnswerRowId" : { "type" : "string", "description" : "The row ID of the survey answer used in the filter.", "example" : null }, "surveyId" : { "type" : "string", "description" : "The ID of the survey used in the filter.", "example" : null }, "surveyQuestion" : { "type" : "string", "description" : "The question from the survey used in the filter.", "example" : null }, "valueComparison" : { "description" : "Specifies the operation used to compare 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" } ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PublicTimeOffset" : { "required" : [ "amount", "offsetDirection", "timeUnit" ], "type" : "object", "properties" : { "amount" : { "type" : "integer", "description" : "The numerical value representing the quantity of the time offset.", "format" : "int64", "example" : null }, "offsetDirection" : { "type" : "string", "description" : "Indicates the direction of the time offset, such as forward or backward.", "example" : null }, "timeUnit" : { "type" : "string", "description" : "Specifies the unit of time for the offset, such as days, hours, or minutes.", "example" : null } }, "example" : null }, "PublicTimePointOperation" : { "title" : "TIME_POINT", "required" : [ "includeObjectsWithNoValueSet", "operationType", "operator", "timePoint", "type" ], "type" : "object", "properties" : { "endpointBehavior" : { "type" : "string", "description" : "Describes the behavior at the endpoint of the time point operation.", "example" : null }, "includeObjectsWithNoValueSet" : { "type" : "boolean", "description" : "Indicates whether objects with no value set for the property should be included in the operation.", "example" : null }, "operationType" : { "type" : "string", "description" : "Specifies the type of operation (TIME_POINT).", "example" : null, "enum" : [ "TIME_POINT" ], "default" : "TIME_POINT" }, "operator" : { "type" : "string", "description" : "Specifies the operation to be applied within the time point operation (IS_BEFORE, IS_AFTER).", "example" : null }, "propertyParser" : { "type" : "string", "description" : "Specifies the parser used for interpreting the property in the operation.", "example" : null }, "timePoint" : { "description" : "Defines the specific point in time 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" : "Defines the type of operation being performed.", "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 current day reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the current day reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the current day reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference (TODAY).", "example" : null, "enum" : [ "TODAY" ], "default" : "TODAY" }, "second" : { "type" : "integer", "description" : "The second component of the current day 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" : "Specifies the criteria for refining the filter by coalescing.", "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 in 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 being applied (UNIFIED_EVENTS).", "example" : null, "enum" : [ "UNIFIED_EVENTS" ], "default" : "UNIFIED_EVENTS" }, "pruningRefineBy" : { "description" : "Specifies the criteria for refining the filter by pruning.", "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" : "Specifies the criteria for refining the filter by coalescing.", "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 filter branch.", "example" : null }, "filterBranchOperator" : { "type" : "string", "description" : "The logical operator used to combine filters within the branch (AND).", "example" : null }, "filterBranchType" : { "type" : "string", "description" : "The type of the filter branch (UNIFIED_EVENTS).", "example" : null, "enum" : [ "UNIFIED_EVENTS" ], "default" : "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/PublicPropertyAssociationFilterBranch" }, { "$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/PublicCampaignInfluencedFilter" }, { "$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/PublicNumAssociationsFilter" }, { "$ref" : "#/components/schemas/PublicUnifiedEventsFilter" }, { "$ref" : "#/components/schemas/PublicPropertyAssociationInListFilter" }, { "$ref" : "#/components/schemas/PublicConstantFilter" } ] } }, "operator" : { "type" : "string", "description" : "Defines the operation to be applied within the filter branch (HAS_COMPLETED, 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, (WEBINAR).", "example" : null, "enum" : [ "WEBINAR" ], "default" : "WEBINAR" }, "operator" : { "type" : "string", "description" : "Specifies the operation to be performed by the filter (HAS_WEBINAR_REGISTRATION, NOT_HAS_WEBINAR_REGISTRATION, HAS_WEBINAR_ATTENDANCE, NOT_HAS_WEBINAR_ATTENDANCE).", "example" : null }, "webinarId" : { "type" : "string", "description" : "The ID of the webinar associated with 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 (SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY).", "example" : null, "enum" : [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ] }, "hour" : { "type" : "integer", "description" : "The hour component of the week reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the week reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the week reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference (WEEK).", "example" : null, "enum" : [ "WEEK" ], "default" : "WEEK" }, "second" : { "type" : "integer", "description" : "The second component of 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.", "format" : "int32", "example" : null }, "hour" : { "type" : "integer", "description" : "The hour component of the year reference.", "format" : "int32", "example" : null }, "millisecond" : { "type" : "integer", "description" : "The millisecond component of the year reference.", "format" : "int32", "example" : null }, "minute" : { "type" : "integer", "description" : "The minute component of the year reference.", "format" : "int32", "example" : null }, "month" : { "type" : "integer", "description" : "The month component of the year reference.", "format" : "int32", "example" : null }, "referenceType" : { "type" : "string", "description" : "Indicates the type of reference (YEAR).", "example" : null, "enum" : [ "YEAR" ], "default" : "YEAR" }, "second" : { "type" : "integer", "description" : "The second component of the year reference.", "format" : "int32", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "RecordIdInput" : { "required" : [ "objectTypeId", "recordId" ], "type" : "object", "properties" : { "objectTypeId" : { "type" : "string", "example" : null }, "recordId" : { "type" : "string", "example" : null } }, "example" : null }, "RecordIdWithMemberships" : { "required" : [ "objectTypeId", "recordId", "recordListMemberships" ], "type" : "object", "properties" : { "objectTypeId" : { "type" : "string", "example" : null }, "recordId" : { "type" : "string", "example" : null }, "recordListMemberships" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/RecordListMembership" } } }, "example" : null }, "RecordListMembership" : { "required" : [ "listId", "listVersion" ], "type" : "object", "properties" : { "firstAddedTimestamp" : { "type" : "string", "description" : "The timestamp when the record was first added to the list.", "format" : "date-time", "example" : null }, "isPublicList" : { "type" : "boolean", "description" : "Indicates whether the list is public.", "example" : null }, "lastAddedTimestamp" : { "type" : "string", "description" : "The timestamp when the record was last added to the list.", "format" : "date-time", "example" : null }, "listId" : { "type" : "string", "description" : "The unique identifier of the list.", "example" : null }, "listVersion" : { "type" : "integer", "description" : "The version number of the list.", "format" : "int32", "example" : null } }, "description" : "Lists record is member of", "example" : { "firstAddedTimestamp" : "2023-06-28T22:00:15.001Z", "lastAddedTimestamp" : "2023-09-28T22:03:17.998Z", "listId" : 13, "listVersion" : 2 } }, "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" }, "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" : { "ils-lists-read" : "", "ils-lists-write" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ], "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }