{ "openapi" : "3.0.1", "info" : { "title" : "Marketing Marketing Events", "description" : "Basepom for all HubSpot Projects", "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" : "Marketing Events Guide", "url" : "https://developers.hubspot.com/docs/guides/api/marketing/marketing-events" } ] }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Basic" }, { "name" : "Batch" }, { "name" : "Event Attendees" }, { "name" : "Event Status" }, { "name" : "Identifiers" }, { "name" : "List Associations" }, { "name" : "Participant State" }, { "name" : "Settings" }, { "name" : "Subscriber State Changes" } ], "paths" : { "/marketing/marketing-events/v3" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/marketing/marketing-events/v3_/marketing/marketing-events/v3", "parameters" : [ { "name" : "after", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 10 } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseMarketingEventPublicReadResponseV2ForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists" : { "get" : { "tags" : [ "List Associations" ], "summary" : "Get lists associated with a marketing event", "description" : "Gets lists associated with a marketing event by external account id and external event id", "operationId" : "get-/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists_getAllByExternalAccountAndEventIds", "parameters" : [ { "name" : "externalAccountId", "in" : "path", "description" : "The accountId that is associated with this marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalPublicList" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}" : { "put" : { "tags" : [ "List Associations" ], "summary" : "Associate a list with a marketing event", "description" : "Associates a list with a marketing event by external account id, external event id, and ILS list id", "operationId" : "put-/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}_associateByExternalAccountAndEventIds", "parameters" : [ { "name" : "externalAccountId", "in" : "path", "description" : "The accountId that is associated with this marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "listId", "in" : "path", "description" : "The ILS ID of the list.", "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" : [ "crm.objects.marketing_events.write" ] } ] }, "delete" : { "tags" : [ "List Associations" ], "summary" : "Disassociate a list from a marketing event", "description" : "Disassociates a list from a marketing event by external account id, external event id, and ILS list id", "operationId" : "delete-/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}_disassociateByExternalAccountAndEventIds", "parameters" : [ { "name" : "externalAccountId", "in" : "path", "description" : "The accountId that is associated with this marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "listId", "in" : "path", "description" : "The ILS ID of the list.", "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" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/associations/{marketingEventId}/lists" : { "get" : { "tags" : [ "List Associations" ], "summary" : "Get lists associated with a marketing event", "description" : "Gets lists associated with a marketing event by marketing event id", "operationId" : "get-/marketing/v3/marketing-events/associations/{marketingEventId}/lists_getAllByMarketingEventId", "parameters" : [ { "name" : "marketingEventId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalPublicList" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}" : { "put" : { "tags" : [ "List Associations" ], "summary" : "Associate a list with a marketing event", "description" : "Associates a list with a marketing event by marketing event id and ILS list id", "operationId" : "put-/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}_associateByMarketingEventId", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "The ILS ID of the list.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "marketingEventId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "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" : [ "crm.objects.marketing_events.write" ] } ] }, "delete" : { "tags" : [ "List Associations" ], "summary" : "Disassociate a list from a marketing event", "description" : "Disassociates a list from a marketing event by marketing event id and ILS list id", "operationId" : "delete-/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}_disassociateByMarketingEventId", "parameters" : [ { "name" : "listId", "in" : "path", "description" : "The ILS ID of the list.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "marketingEventId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "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" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create" : { "post" : { "tags" : [ "Event Attendees" ], "summary" : "Record Participants by ContactId with Marketing Event External Ids", "description" : "Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt", "operationId" : "post-/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create_recordByContactIds", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "subscriberState", "in" : "path", "description" : "The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventSubscriber" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSubscriberVidResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create" : { "post" : { "tags" : [ "Event Attendees" ], "summary" : "Record Participants by Email with Marketing Event External Ids", "description" : "Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt", "operationId" : "post-/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create_recordByContactEmails", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "subscriberState", "in" : "path", "description" : "The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventEmailSubscriber" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSubscriberEmailResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/batch/archive" : { "post" : { "tags" : [ "Batch" ], "summary" : "Delete Multiple Marketing Events by ObjectId", "description" : "Deletes multiple Marketing Events from the portal based on their objectId, if they exist.\n\nResponses:\n204: Returned if all specified Marketing Events were successfully deleted.\n207: Returned if some objectIds did not correspond to any existing Marketing Events.", "operationId" : "post-/marketing/v3/marketing-events/batch/archive_archiveByObjectId", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventPublicObjectIdDeleteRequest" }, "example" : null } }, "required" : true }, "responses" : { "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/batch/update" : { "post" : { "tags" : [ "Batch" ], "summary" : "Update Multiple Marketing Events by ObjectId", "description" : "Updates multiple Marketing Events on the portal based on their objectId, if they exist.", "operationId" : "post-/marketing/v3/marketing-events/batch/update_updateByObjectId", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventPublicUpdateRequestFullV2" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseMarketingEventPublicDefaultResponseV2" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseMarketingEventPublicDefaultResponseV2WithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events" : { "post" : { "tags" : [ "Basic" ], "summary" : "Create a marketing event", "description" : "Creates a new marketing event in HubSpot", "operationId" : "post-/marketing/v3/marketing-events/events_create", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventCreateRequestParams" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventDefaultResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events/delete" : { "post" : { "tags" : [ "Batch" ], "summary" : "Delete Multiple Marketing Events by External Ids", "description" : "Deletes multiple Marketing Events based on externalAccountId, externalEventId, and appId.\n\nOnly Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint. ", "operationId" : "post-/marketing/v3/marketing-events/events/delete_archive", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventExternalUniqueIdentifier" }, "example" : null } }, "required" : true }, "responses" : { "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events/search" : { "get" : { "tags" : [ "Identifiers" ], "summary" : "Find App-Specific Marketing Events by External Event Id", "description" : "Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request.\n\nMarketing Events created by other apps will not be included in the results.", "operationId" : "get-/marketing/v3/marketing-events/events/search_doSearch", "parameters" : [ { "name" : "q", "in" : "query", "description" : "The id of the marketing event in the external event application (externalEventId)", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseSearchPublicResponseWrapperNoPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/events/upsert" : { "post" : { "tags" : [ "Batch" ], "summary" : "Create or Update Multiple Marketing Events", "description" : "Upserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created.\n\nOnly Marketing Events originally created by the same app can be updated.", "operationId" : "post-/marketing/v3/marketing-events/events/upsert_upsert", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventCreateRequestParams" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseMarketingEventPublicDefaultResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events/{externalEventId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Get Marketing Event by External IDs", "description" : "Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app making the request can be retrieved.", "operationId" : "get-/marketing/v3/marketing-events/events/{externalEventId}_getDetails", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventPublicReadResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] }, "put" : { "tags" : [ "Basic" ], "summary" : "Create or update a marketing event", "description" : "Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.", "operationId" : "put-/marketing/v3/marketing-events/events/{externalEventId}_upsert", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventCreateRequestParams" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventPublicDefaultResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] }, "delete" : { "tags" : [ "Basic" ], "summary" : "Delete Marketing Event by External Ids", "description" : "Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app can be deleted.", "operationId" : "delete-/marketing/v3/marketing-events/events/{externalEventId}_archive", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] }, "patch" : { "tags" : [ "Basic" ], "summary" : "Update Marketing Event by External IDs", "description" : "Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists.\n\nOnly Marketing Events created by the same app can be updated.", "operationId" : "patch-/marketing/v3/marketing-events/events/{externalEventId}_update", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventUpdateRequestParams" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventPublicDefaultResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events/{externalEventId}/cancel" : { "post" : { "tags" : [ "Event Status" ], "summary" : "Mark a marketing event as cancelled", "description" : "Mark a marketing event as cancelled.", "operationId" : "post-/marketing/v3/marketing-events/events/{externalEventId}/cancel_cancel", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventDefaultResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events/{externalEventId}/complete" : { "post" : { "tags" : [ "Event Status" ], "summary" : "Mark a marketing event as completed", "description" : "Mark a marketing event as completed", "operationId" : "post-/marketing/v3/marketing-events/events/{externalEventId}/complete_complete", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application.", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventCompleteRequestParams" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventDefaultResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert" : { "post" : { "tags" : [ "Subscriber State Changes" ], "summary" : "Record a subscriber state by contact email", "description" : "Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. ", "operationId" : "post-/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert_upsertByContactEmail", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "subscriberState", "in" : "path", "description" : "The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventEmailSubscriber" }, "example" : null } }, "required" : true }, "responses" : { "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert" : { "post" : { "tags" : [ "Subscriber State Changes" ], "summary" : "Record a subscriber state by contact ID", "description" : "Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.", "operationId" : "post-/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert_upsertByContactId", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "subscriberState", "in" : "path", "description" : "The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalAccountId", "in" : "query", "description" : "The accountId that is associated with this marketing event in the external event application", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventSubscriber" }, "example" : null } }, "required" : true }, "responses" : { "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown" : { "get" : { "tags" : [ "Participant State" ], "summary" : "Read participations breakdown by Contact identifier", "description" : "Read Contact's participations by identifier - email or internal id.", "operationId" : "get-/marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown_getParticipationsBreakdownByContactId", "parameters" : [ { "name" : "contactIdentifier", "in" : "path", "description" : "The identifier of the Contact. It may be email or internal id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "after", "in" : "query", "description" : "The cursor indicating the position of the last retrieved item.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The limit for response size. The default value is 10, the max number is 100", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 10 } }, { "name" : "state", "in" : "query", "description" : "The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalParticipationBreakdown" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}" : { "get" : { "tags" : [ "Participant State" ], "summary" : "Read participations counters by Marketing Event external identifier", "description" : "Read Marketing event's participations counters by externalAccountId and externalEventId pair.", "operationId" : "get-/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}_getParticipationsCountersByEventExternalId", "parameters" : [ { "name" : "externalAccountId", "in" : "path", "description" : "The accountId that is associated with this marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttendanceCounters" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown" : { "get" : { "tags" : [ "Participant State" ], "summary" : "Read participations breakdown by Marketing Event external identifier", "description" : "Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.", "operationId" : "get-/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown_getParticipationsBreakdownByExternalEventId", "parameters" : [ { "name" : "externalAccountId", "in" : "path", "description" : "The accountId that is associated with this marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "after", "in" : "query", "description" : "The cursor indicating the position of the last retrieved item.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "contactIdentifier", "in" : "query", "description" : "The identifier of the Contact. It may be email or internal id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The limit for response size. The default value is 10, the max number is 100", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 10 } }, { "name" : "state", "in" : "query", "description" : "The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalParticipationBreakdown" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/participations/{marketingEventId}" : { "get" : { "tags" : [ "Participant State" ], "summary" : "Read participations counters by Marketing Event internal identifier", "description" : "Read Marketing event's participations counters by internal identifier marketingEventId.", "operationId" : "get-/marketing/v3/marketing-events/participations/{marketingEventId}_getParticipationsCountersByMarketingEventId", "parameters" : [ { "name" : "marketingEventId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttendanceCounters" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/participations/{marketingEventId}/breakdown" : { "get" : { "tags" : [ "Participant State" ], "summary" : "Read participations breakdown by Marketing Event internal identifier", "description" : "Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.", "operationId" : "get-/marketing/v3/marketing-events/participations/{marketingEventId}/breakdown_getParticipationsBreakdownByMarketingEventId", "parameters" : [ { "name" : "marketingEventId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int64", "example" : null } }, { "name" : "after", "in" : "query", "description" : "The cursor indicating the position of the last retrieved item.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "contactIdentifier", "in" : "query", "description" : "The identifier of the Contact. It may be email or internal id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The limit for response size. The default value is 10, the max number is 100", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 10 } }, { "name" : "state", "in" : "query", "description" : "The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalParticipationBreakdown" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/{appId}/settings" : { "get" : { "tags" : [ "Settings" ], "summary" : "Retrieve the application settings", "description" : "Retrieve the current settings for the application.", "operationId" : "get-/marketing/v3/marketing-events/{appId}/settings_getAll", "parameters" : [ { "name" : "appId", "in" : "path", "description" : "The id of the application to retrieve the settings for.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventDetailSettings" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "developers-read" ] } ] }, "post" : { "tags" : [ "Settings" ], "summary" : "Update the application settings", "description" : "Create or update the current settings for the application.", "operationId" : "post-/marketing/v3/marketing-events/{appId}/settings_update", "parameters" : [ { "name" : "appId", "in" : "path", "description" : "The id of the application to update the settings for.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventDetailSettingsUrl" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventDetailSettings" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "developers-write" ] } ] } }, "/marketing/v3/marketing-events/{externalEventId}/identifiers" : { "get" : { "tags" : [ "Identifiers" ], "summary" : "Find Marketing Events by External Event Id", "description" : "This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request.\n\nIt retrieves the objectId and additional event details for each matching Marketing Event.\n\nSince multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results.\n\nNote: Marketing Events become searchable by externalEventId a few minutes after creation.", "operationId" : "get-/marketing/v3/marketing-events/{externalEventId}/identifiers_searchPortalEvents", "parameters" : [ { "name" : "externalEventId", "in" : "path", "description" : "The id of the marketing event in the external event application.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalMarketingEventIdentifiersResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] } }, "/marketing/v3/marketing-events/{objectId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Get Marketing Event by objectId", "description" : "Returns the details of a Marketing Event with the specified objectId, if it exists.", "operationId" : "get-/marketing/v3/marketing-events/{objectId}_getByObjectId", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventPublicReadResponseV2" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.read" ] } ] }, "delete" : { "tags" : [ "Basic" ], "summary" : "Delete Marketing Event by objectId", "description" : "Deletes the existing Marketing Event with the specified objectId, if it exists.", "operationId" : "delete-/marketing/v3/marketing-events/{objectId}_archiveByObjectId", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "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" : [ "crm.objects.marketing_events.write" ] } ] }, "patch" : { "tags" : [ "Basic" ], "summary" : "Update Marketing Event by objectId", "description" : "Updates the details of an existing Marketing Event identified by its objectId, if it exists.", "operationId" : "patch-/marketing/v3/marketing-events/{objectId}_updateByObjectId", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventPublicUpdateRequestV2" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MarketingEventPublicDefaultResponseV2" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create" : { "post" : { "tags" : [ "Event Attendees" ], "summary" : "Record Participants by ContactId with Marketing Event Object Id", "description" : "Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt", "operationId" : "post-/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create_recordByContactId", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "subscriberState", "in" : "path", "description" : "The attendance state value. It may be 'register', 'attend' or 'cancel'", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventSubscriber" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSubscriberVidResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } }, "/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create" : { "post" : { "tags" : [ "Event Attendees" ], "summary" : "Record Participants by Email with Marketing Event Object Id", "description" : "Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt", "operationId" : "post-/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create_recordByEmail", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "The internal id of the marketing event in HubSpot.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "subscriberState", "in" : "path", "description" : "The attendance state value. It may be 'register', 'attend' or 'cancel'", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputMarketingEventEmailSubscriber" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSubscriberEmailResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "crm.objects.marketing_events.write" ] } ] } } }, "components" : { "schemas" : { "AppInfo" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the application", "example" : null }, "name" : { "type" : "string", "description" : "The name of the application", "example" : null } }, "example" : null }, "AttendanceCounters" : { "required" : [ "attended", "cancelled", "noShows", "registered" ], "type" : "object", "properties" : { "attended" : { "type" : "integer", "description" : "Number of attended contact records of a marketing event", "format" : "int32", "example" : null }, "cancelled" : { "type" : "integer", "description" : "Number of cancelled contact records of a marketing event", "format" : "int32", "example" : null }, "noShows" : { "type" : "integer", "description" : "Number of no-show contact records of a marketing event", "format" : "int32", "example" : null }, "registered" : { "type" : "integer", "description" : "Number of registered contact records of a marketing event", "format" : "int32", "example" : null } }, "example" : null }, "BatchInputMarketingEventCreateRequestParams" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventCreateRequestParams" } } }, "example" : null }, "BatchInputMarketingEventEmailSubscriber" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "description" : "List of marketing event details to create or update", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventEmailSubscriber" } } }, "example" : null }, "BatchInputMarketingEventExternalUniqueIdentifier" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventExternalUniqueIdentifier" } } }, "example" : null }, "BatchInputMarketingEventPublicObjectIdDeleteRequest" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventPublicObjectIdDeleteRequest" } } }, "example" : null }, "BatchInputMarketingEventPublicUpdateRequestFullV2" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventPublicUpdateRequestFullV2" } } }, "example" : null }, "BatchInputMarketingEventSubscriber" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "description" : "List of HubSpot contacts to subscribe to the marketing event", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventSubscriber" } } }, "example" : null }, "BatchResponseMarketingEventPublicDefaultResponse" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "Timestamp of when the request was completed.", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Result of the request.", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The number of errors that occurred during the request.", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "Timestamp of when the request was sent.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventPublicDefaultResponse" } }, "startedAt" : { "type" : "string", "description" : "Timestamp of when the request started processing.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "Status of the response.", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseMarketingEventPublicDefaultResponseV2" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "Timestamp of when the request was processed.", "format" : "date-time", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Result object of the request.", "example" : null }, "requestedAt" : { "type" : "string", "description" : "Timestamp of when the request was sent.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventPublicDefaultResponseV2" } }, "startedAt" : { "type" : "string", "description" : "Timestamp of when the request started processing.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the response.", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseMarketingEventPublicDefaultResponseV2WithErrors" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "Timestamp that represents when the request finished processing", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Result of the request", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The number of errors that occurred during the processing", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "Timestamp that represents when the request was made", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventPublicDefaultResponseV2" } }, "startedAt" : { "type" : "string", "description" : "Timestamp that represents when the request started processing", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the request processing", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseSubscriberEmailResponse" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "Timestamp that represents when the request finished processing", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Result of the request", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The number of errors that occurred during the processing", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "Timestamp that represents when the request was made", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/SubscriberEmailResponse" } }, "startedAt" : { "type" : "string", "description" : "Timestamp that represents when the request started processing", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the request processing", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "BatchResponseSubscriberVidResponse" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "Timestamp that represents when the request finished processing", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Result of the request", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The number of errors that occurred during the processing", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "Timestamp that represents when the request was made", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/SubscriberVidResponse" } }, "startedAt" : { "type" : "string", "description" : "Timestamp that represents when the request started processing", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the request processing", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "example" : null }, "CollectionResponseMarketingEventPublicReadResponseV2ForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventPublicReadResponseV2" } } }, "example" : null }, "CollectionResponseSearchPublicResponseWrapperNoPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/SearchPublicResponseWrapper" } } }, "example" : null }, "CollectionResponseWithTotalMarketingEventIdentifiersResponse" : { "required" : [ "results", "total" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MarketingEventIdentifiersResponse" } }, "total" : { "type" : "integer", "format" : "int32", "example" : null } }, "example" : null }, "CollectionResponseWithTotalParticipationBreakdown" : { "required" : [ "results", "total" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ParticipationBreakdown" } }, "total" : { "type" : "integer", "format" : "int32", "example" : null } }, "example" : null }, "CollectionResponseWithTotalPublicList" : { "required" : [ "results", "total" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicList" } }, "total" : { "type" : "integer", "format" : "int32", "example" : null } }, "example" : null }, "ContactAssociation" : { "required" : [ "contactId", "email" ], "type" : "object", "properties" : { "contactId" : { "type" : "string", "description" : "The internal ID of the contact in HubSpot", "example" : null }, "email" : { "type" : "string", "description" : "The email of the contact in HubSpot", "example" : null }, "firstname" : { "type" : "string", "description" : "The first name of the contact in HubSpot", "example" : null }, "lastname" : { "type" : "string", "description" : "The last name of the contact in HubSpot", "example" : null } }, "example" : null }, "CrmPropertyWrapper" : { "required" : [ "name", "value" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the property in the CRM", "example" : null }, "value" : { "type" : "string", "description" : "The value of the property in the CRM", "example" : null } }, "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 }, "EventDetailSettings" : { "required" : [ "appId", "eventDetailsUrl" ], "type" : "object", "properties" : { "appId" : { "type" : "integer", "description" : "The id of the application the settings are for", "format" : "int32", "example" : null }, "eventDetailsUrl" : { "type" : "string", "description" : "The url that will be used to fetch marketing event details by id", "example" : null } }, "example" : null }, "EventDetailSettingsUrl" : { "required" : [ "eventDetailsUrl" ], "type" : "object", "properties" : { "eventDetailsUrl" : { "type" : "string", "description" : "The url that will be used to fetch marketing event details by id. Must contain a `%s` character sequence that will be substituted with the event id. For example: `https://my.event.app/events/%s`", "example" : null } }, "example" : null }, "ForwardPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" } }, "example" : null }, "MarketingEventAssociation" : { "required" : [ "marketingEventId", "name" ], "type" : "object", "properties" : { "externalAccountId" : { "type" : "string", "description" : "The account ID that is associated with this marketing event in the external event application", "example" : null }, "externalEventId" : { "type" : "string", "description" : "The event ID that is associated with this marketing event in the external event application", "example" : null }, "marketingEventId" : { "type" : "string", "description" : "The internal ID of the marketing event in HubSpot", "example" : null }, "name" : { "type" : "string", "description" : "The name of the marketing event in HubSpot", "example" : null } }, "example" : null }, "MarketingEventCompleteRequestParams" : { "required" : [ "endDateTime", "startDateTime" ], "type" : "object", "properties" : { "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event in ISO 8601 format", "format" : "date-time", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event in ISO 8601 format", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventCreateRequestParams" : { "required" : [ "customProperties", "eventName", "eventOrganizer", "externalAccountId", "externalEventId" ], "type" : "object", "properties" : { "customProperties" : { "type" : "array", "description" : "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "example" : null, "items" : { "$ref" : "#/components/schemas/PropertyValue" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event.", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled. Defaults to `false`", "example" : null }, "eventCompleted" : { "type" : "boolean", "description" : "Indicates if the marketing event has been completed. Defaults to `false`", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event.", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event.", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event.", "example" : null }, "eventType" : { "type" : "string", "description" : "Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed.", "example" : null }, "externalAccountId" : { "type" : "string", "description" : "The accountId that is associated with this marketing event in the external event application.", "example" : null }, "externalEventId" : { "type" : "string", "description" : "The id of the marketing event in the external event application.", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event.", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventDefaultResponse" : { "required" : [ "customProperties", "eventName", "eventOrganizer" ], "type" : "object", "properties" : { "customProperties" : { "type" : "array", "description" : "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "example" : null, "items" : { "$ref" : "#/components/schemas/PropertyValue" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event.", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled.", "example" : null }, "eventCompleted" : { "type" : "boolean", "description" : "Indicates if the marketing event has been completed.", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event.", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event.", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event.", "example" : null }, "eventType" : { "type" : "string", "description" : "The type of the marketing event.", "example" : null }, "eventUrl" : { "type" : "string", "description" : "The URL in the external event application where the marketing event can be managed.", "example" : null }, "objectId" : { "type" : "string", "description" : "The ID of the marketing event CRM object", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event.", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventEmailSubscriber" : { "required" : [ "contactProperties", "email", "interactionDateTime", "properties" ], "type" : "object", "properties" : { "contactProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "The key-value set that contains properties of the contact.", "example" : null }, "email" : { "type" : "string", "description" : "The email address of the contact in HubSpot to associate with the event.", "example" : null }, "interactionDateTime" : { "type" : "integer", "description" : "Timestamp in milliseconds at which the contact subscribed to the event.", "format" : "int64", "example" : null }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "The key-value set that contains properties of the marketing event.", "example" : null } }, "example" : null }, "MarketingEventExternalUniqueIdentifier" : { "required" : [ "appId", "externalAccountId", "externalEventId" ], "type" : "object", "properties" : { "appId" : { "type" : "integer", "description" : "The id of the application that created the marketing event in HubSpot.", "format" : "int32", "example" : null }, "externalAccountId" : { "type" : "string", "description" : "The accountId that is associated with this marketing event in the external event application.", "example" : null }, "externalEventId" : { "type" : "string", "description" : "The id of the marketing event in the external event application.", "example" : null } }, "example" : null }, "MarketingEventIdentifiersResponse" : { "required" : [ "externalEventId", "marketingEventName", "objectId" ], "type" : "object", "properties" : { "appInfo" : { "$ref" : "#/components/schemas/AppInfo" }, "externalAccountId" : { "type" : "string", "description" : "The accountId that is associated with this marketing event in the external event application", "example" : null }, "externalEventId" : { "type" : "string", "description" : "The ID that is associated with this marketing event in the external event application", "example" : null }, "marketingEventName" : { "type" : "string", "description" : "The name of the marketing event", "example" : null }, "objectId" : { "type" : "string", "description" : "The internal ID of the marketing event in HubSpot CRM", "example" : null } }, "example" : null }, "MarketingEventPublicDefaultResponse" : { "required" : [ "createdAt", "customProperties", "eventName", "eventOrganizer", "id", "updatedAt" ], "type" : "object", "properties" : { "createdAt" : { "type" : "string", "description" : "The creation date and time of the marketing event.", "format" : "date-time", "example" : null }, "customProperties" : { "type" : "array", "description" : "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "example" : null, "items" : { "$ref" : "#/components/schemas/PropertyValue" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event.", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled.", "example" : null }, "eventCompleted" : { "type" : "boolean", "description" : "Indicates if the marketing event has been completed.", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event.", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event.", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event.", "example" : null }, "eventType" : { "type" : "string", "description" : "The type of the marketing event.", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed.", "example" : null }, "id" : { "type" : "string", "description" : "The ID of the marketing event CRM object.", "example" : null }, "objectId" : { "type" : "string", "description" : "The ID of the marketing event CRM object.", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event.", "format" : "date-time", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The update date and time of the marketing event.", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventPublicDefaultResponseV2" : { "required" : [ "createdAt", "customProperties", "eventName", "objectId", "updatedAt" ], "type" : "object", "properties" : { "appInfo" : { "$ref" : "#/components/schemas/AppInfo" }, "createdAt" : { "type" : "string", "description" : "The creation date and time of the marketing event", "format" : "date-time", "example" : null }, "customProperties" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/CrmPropertyWrapper" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled", "example" : null }, "eventCompleted" : { "type" : "boolean", "description" : "Indicates if the marketing event has been completed", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event", "example" : null }, "eventType" : { "type" : "string", "description" : "The type of the marketing event", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed", "example" : null }, "objectId" : { "type" : "string", "description" : "The internal ID of the marketing event in HubSpot", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event", "format" : "date-time", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The update date and time of the marketing event", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventPublicObjectIdDeleteRequest" : { "required" : [ "objectId" ], "type" : "object", "properties" : { "objectId" : { "type" : "string", "description" : "The internal ID of the marketing event in HubSpot", "example" : null } }, "example" : null }, "MarketingEventPublicReadResponse" : { "required" : [ "attendees", "cancellations", "createdAt", "customProperties", "eventName", "eventOrganizer", "externalEventId", "id", "noShows", "registrants", "updatedAt" ], "type" : "object", "properties" : { "attendees" : { "type" : "integer", "description" : "The number of HubSpot contacts that attended this marketing event.", "format" : "int32", "example" : null }, "cancellations" : { "type" : "integer", "description" : "The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration.", "format" : "int32", "example" : null }, "createdAt" : { "type" : "string", "description" : "The creation date and time of the marketing event.", "format" : "date-time", "example" : null }, "customProperties" : { "type" : "array", "description" : "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "example" : null, "items" : { "$ref" : "#/components/schemas/PropertyValue" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event.", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled.", "example" : null }, "eventCompleted" : { "type" : "boolean", "description" : "Indicates if the marketing event has been completed.", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event.", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event.", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event.", "example" : null }, "eventType" : { "type" : "string", "description" : "The type of the marketing event.", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed.", "example" : null }, "externalEventId" : { "type" : "string", "description" : "The id of the marketing event in the external event application.", "example" : null }, "id" : { "type" : "string", "description" : "The ID of the marketing event CRM object.", "example" : null }, "noShows" : { "type" : "integer", "description" : "The number of HubSpot contacts that registered for this marketing event, but did not attend. This field only had a value when the event is over.", "format" : "int32", "example" : null }, "objectId" : { "type" : "string", "description" : "The ID of the marketing event CRM object.", "example" : null }, "registrants" : { "type" : "integer", "description" : "The number of HubSpot contacts that registered for this marketing event.", "format" : "int32", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event.", "format" : "date-time", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The update date and time of the marketing event.", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventPublicReadResponseV2" : { "required" : [ "createdAt", "customProperties", "eventName", "objectId", "updatedAt" ], "type" : "object", "properties" : { "appInfo" : { "$ref" : "#/components/schemas/AppInfo" }, "attendees" : { "type" : "integer", "description" : "Number of attended contact records of a marketing event", "format" : "int32", "example" : null }, "cancellations" : { "type" : "integer", "description" : "Number of cancelled contact records of a marketing event", "format" : "int32", "example" : null }, "createdAt" : { "type" : "string", "description" : "The creation date and time of the marketing event", "format" : "date-time", "example" : null }, "customProperties" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/CrmPropertyWrapper" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled", "example" : null }, "eventCompleted" : { "type" : "boolean", "description" : "Indicates if the marketing event has been completed", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event", "example" : null }, "eventStatus" : { "type" : "string", "description" : "The status of the marketing event", "example" : null }, "eventStatusV2" : { "type" : "string", "example" : null }, "eventType" : { "type" : "string", "description" : "The type of the marketing event", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed", "example" : null }, "externalEventId" : { "type" : "string", "description" : "The ID that is associated with this marketing event in the external event application", "example" : null }, "noShows" : { "type" : "integer", "description" : "Number of no-show contact records of a marketing event", "format" : "int32", "example" : null }, "objectId" : { "type" : "string", "description" : "The internal ID of the marketing event in HubSpot", "example" : null }, "registrants" : { "type" : "integer", "description" : "Number of registered contact records of a marketing event", "format" : "int32", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event", "format" : "date-time", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The update date and time of the marketing event", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventPublicUpdateRequestFullV2" : { "required" : [ "customProperties", "objectId" ], "type" : "object", "properties" : { "customProperties" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PropertyValue" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event", "example" : null }, "eventType" : { "type" : "string", "description" : "The type of the marketing event", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed", "example" : null }, "objectId" : { "type" : "string", "description" : "The internal ID of the marketing event in HubSpot", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventPublicUpdateRequestV2" : { "required" : [ "customProperties" ], "type" : "object", "properties" : { "customProperties" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PropertyValue" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event", "example" : null }, "eventType" : { "type" : "string", "description" : "The type of the marketing event", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event", "format" : "date-time", "example" : null } }, "example" : null }, "MarketingEventSubscriber" : { "required" : [ "interactionDateTime", "properties", "vid" ], "type" : "object", "properties" : { "interactionDateTime" : { "type" : "integer", "description" : "Timestamp in milliseconds at which the contact subscribed to the event.", "format" : "int64", "example" : null }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "The key-value set of the properties of the contact", "example" : null }, "vid" : { "type" : "integer", "description" : "The ID of the contact in HubSpot", "format" : "int64", "example" : null } }, "example" : null }, "MarketingEventUpdateRequestParams" : { "required" : [ "customProperties" ], "type" : "object", "properties" : { "customProperties" : { "type" : "array", "description" : "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "example" : null, "items" : { "$ref" : "#/components/schemas/PropertyValue" } }, "endDateTime" : { "type" : "string", "description" : "The end date and time of the marketing event.", "format" : "date-time", "example" : null }, "eventCancelled" : { "type" : "boolean", "description" : "Indicates if the marketing event has been cancelled. Defaults to `false`", "example" : null }, "eventCompleted" : { "type" : "boolean", "description" : "Indicates if the marketing event has been completed. Defaults to `false`", "example" : null }, "eventDescription" : { "type" : "string", "description" : "The description of the marketing event.", "example" : null }, "eventName" : { "type" : "string", "description" : "The name of the marketing event.", "example" : null }, "eventOrganizer" : { "type" : "string", "description" : "The name of the organizer of the marketing event.", "example" : null }, "eventType" : { "type" : "string", "description" : "Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`", "example" : null }, "eventUrl" : { "type" : "string", "description" : "A URL in the external event application where the marketing event can be managed.", "example" : null }, "startDateTime" : { "type" : "string", "description" : "The start date and time of the marketing event.", "format" : "date-time", "example" : null } }, "example" : null }, "MaskedSubstring" : { "required" : [ "end", "start" ], "type" : "object", "properties" : { "end" : { "type" : "integer", "format" : "int32", "example" : null }, "start" : { "type" : "integer", "format" : "int32", "example" : null } }, "example" : null }, "MaskedSubstrings" : { "required" : [ "substrings" ], "type" : "object", "properties" : { "substrings" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/MaskedSubstring" } } }, "example" : null }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "The ID element at the start of the page", "example" : null }, "link" : { "type" : "string", "description" : "Link to the next page", "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" } }, "example" : null }, "ParticipationAssociations" : { "required" : [ "contact", "marketingEvent" ], "type" : "object", "properties" : { "contact" : { "$ref" : "#/components/schemas/ContactAssociation" }, "marketingEvent" : { "$ref" : "#/components/schemas/MarketingEventAssociation" } }, "example" : null }, "ParticipationBreakdown" : { "required" : [ "associations", "createdAt", "id", "properties" ], "type" : "object", "properties" : { "associations" : { "$ref" : "#/components/schemas/ParticipationAssociations" }, "createdAt" : { "type" : "string", "description" : "The creation time and date of the target marketing event", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The internal ID of the target marketing event", "example" : null }, "properties" : { "$ref" : "#/components/schemas/ParticipationProperties" } }, "example" : null }, "ParticipationProperties" : { "required" : [ "attendanceState", "occurredAt" ], "type" : "object", "properties" : { "attendanceDurationSeconds" : { "type" : "integer", "description" : "The number of seconds the participation lasted", "format" : "int32", "example" : null }, "attendancePercentage" : { "type" : "string", "description" : "Percentage of the participation duration relative to the event duration", "example" : null }, "attendanceState" : { "type" : "string", "description" : "The state of the participation", "example" : null, "enum" : [ "ATTENDED", "CANCELLED", "EMPTY", "NO_SHOW", "REGISTERED" ] }, "occurredAt" : { "type" : "integer", "description" : "Timestamp of when the participation occurred", "format" : "int64", "example" : null } }, "example" : null }, "PreviousPage" : { "required" : [ "before" ], "type" : "object", "properties" : { "before" : { "type" : "string", "description" : "A paging cursor token for retrieving previous pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the previous pages' results.", "example" : null } }, "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response", "example" : null }, "PropertyValue" : { "required" : [ "dataSensitivity", "isEncrypted", "isLargeValue", "maskedSubstrings", "name", "persistenceTimestamp", "requestId", "selectedByUser", "selectedByUserTimestamp", "source", "sourceId", "sourceLabel", "sourceMetadata", "sourceUpstreamDeployable", "sourceVid", "timestamp", "unit", "updatedByUserId", "useTimestampAsPersistenceTimestamp", "value" ], "type" : "object", "properties" : { "dataSensitivity" : { "type" : "string", "description" : "Level of data sensitivity", "example" : null, "enum" : [ "high", "none", "standard" ] }, "isEncrypted" : { "type" : "boolean", "description" : "Indicates whether the property is encrypted", "example" : null }, "isLargeValue" : { "type" : "boolean", "description" : "Indicates whether the property value is stored as a large value in the storage", "example" : null }, "maskedSubstrings" : { "$ref" : "#/components/schemas/MaskedSubstrings" }, "name" : { "type" : "string", "description" : "Name of custom property", "example" : null }, "persistenceTimestamp" : { "type" : "integer", "description" : "The timestamp that indicates when the value being written is persisted in storage", "format" : "int64", "example" : null }, "requestId" : { "type" : "string", "description" : "The ID of the request", "example" : null }, "selectedByUser" : { "type" : "boolean", "description" : "Indicates whether the property is selected", "example" : null }, "selectedByUserTimestamp" : { "type" : "integer", "description" : "Timestamp of when the property was selected by the user", "format" : "int64", "example" : null }, "source" : { "type" : "string", "description" : "Source of the property", "example" : null, "enum" : [ "ACADEMY", "ACCEPTANCE_TEST", "ACTIVITY_AUTO_ASSOCIATE", "ACTIVITY_LOG_REVERT", "ADS", "AI_GROUP", "ANALYTICS", "API", "APPROVALS", "ASSISTS", "ASSOCIATIONS", "AUTO_ASSOCIATE_BY_DOMAIN", "AUTOMATION_JOURNEY", "AUTOMATION_PLATFORM", "AVATARS_SERVICE", "BATCH_UPDATE", "BCC_TO_CRM", "BEHAVIORAL_EVENTS", "BET_ASSIGNMENT", "BET_CRM_CONNECTOR", "BIDEN", "BILLING", "BOT", "BREEZE_AGENT", "CALCULATED", "CENTRAL_EXCHANGE_RATES", "CHATSPOT", "CLONE_OBJECTS", "COMMUNICATOR", "COMPANIES", "COMPANY_FAMILIES", "COMPANY_INSIGHTS", "CONNECTED_ACCOUNT", "CONTACTS", "CONTACTS_WEB", "CONTENT_MEMBERSHIP", "CONVERSATIONAL_ENRICHMENT", "CONVERSATIONS", "CRM_PROCESSES_PLATFORM", "CRM_UI", "CRM_UI_BULK_ACTION", "CUSTOMER_AGENT", "CUSTOMER_PORTAL", "DATA_ENRICHMENT", "DATA_QUALITY", "DATASET", "DEALS", "DEFAULT", "DELETE_OBJECTS", "DI_WRITE_TO_CRM", "EMAIL", "EMAIL_INBOX_IMPORT", "EMAIL_INTEGRATION", "ENGAGEMENTS", "EXTENSION", "FILE_MANAGER", "FLYWHEEL_PRODUCT_DATA_SYNC", "FORECASTING", "FORM", "FORWARD_TO_CRM", "GMAIL_INTEGRATION", "GOALS", "HEISENBERG", "HELP_DESK", "HELP_DESK_AI", "IMPORT", "INTEGRATION", "INTEGRATIONS_PLATFORM", "INTEGRATIONS_SYNC", "INTENT", "INTERNAL_PROCESSING", "LEADIN", "LEGAL_BASIS_REMEDIATION", "MARKET_SOURCING", "MARKETPLACE", "MARKETS", "MEETINGS", "MERGE_COMPANIES", "MERGE_CONTACTS", "MERGE_OBJECTS", "MERGE_REVERT_OBJECTS", "MICROAPPS", "MIGRATION", "MOBILE_ANDROID", "MOBILE_IOS", "PAYMENTS", "PIPELINE_SETTINGS", "PLAYBOOKS", "PORTAL_OBJECT_SYNC", "PORTAL_USER_ASSOCIATOR", "PRESENTATIONS", "PRIMARY_AUTOMATION", "PROPERTY_DEFAULT_VALUE", "PROPERTY_RESTORE", "PROPERTY_SETTINGS", "PROSPECTING_AGENT", "QUOTAS", "QUOTES", "RECYCLING_BIN", "RESTORE_OBJECTS", "REVENUE_PLATFORM", "SALES", "SALES_MESSAGES", "SALESFORCE", "SEQUENCES", "SETTINGS", "SIDEKICK", "SIGNALS", "SLACK_INTEGRATION", "SMART_DATA_CAPTURE", "SOCIAL", "SUCCESS", "TALLY", "TASK", "UNKNOWN", "WAL_INCREMENTAL", "WORK_UI", "WORKFLOW_CONTACT_DELETE_ACTION", "WORKFLOWS" ] }, "sourceId" : { "type" : "string", "description" : "ID of the source of the property", "example" : null }, "sourceLabel" : { "type" : "string", "description" : "Label of the source of the property", "example" : null }, "sourceMetadata" : { "type" : "string", "description" : "Source metadata encoded as a base64 string", "example" : null }, "sourceUpstreamDeployable" : { "type" : "string", "description" : "Indicates which upstream service made the property change", "example" : null }, "sourceVid" : { "type" : "array", "description" : "The unique identifier associated with the source.", "example" : null, "items" : { "type" : "integer", "format" : "int64", "example" : null } }, "timestamp" : { "type" : "integer", "description" : "Timestamp of the request", "format" : "int64", "example" : null }, "unit" : { "type" : "string", "description" : "The unit", "example" : null }, "updatedByUserId" : { "type" : "integer", "description" : "The ID of the user who last updated the property", "format" : "int32", "example" : null }, "useTimestampAsPersistenceTimestamp" : { "type" : "boolean", "description" : "Indicates if the persistence timestamp is the same as storage version timestamp", "example" : null }, "value" : { "type" : "string", "description" : "Custom property value", "example" : null } }, "description" : "Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes.", "example" : null }, "PublicList" : { "required" : [ "listId", "listVersion", "name", "objectTypeId", "processingStatus", "processingType" ], "type" : "object", "properties" : { "createdAt" : { "type" : "string", "description" : "Timestamp of the creation of the list", "format" : "date-time", "example" : null }, "createdById" : { "type" : "string", "description" : "The ID of the user who created the list", "example" : null }, "deletedAt" : { "type" : "string", "description" : "Timestamp of the deletion of the list", "format" : "date-time", "example" : null }, "filtersUpdatedAt" : { "type" : "string", "description" : "Timestamp of the last update of the list filters", "format" : "date-time", "example" : null }, "listId" : { "type" : "string", "description" : "An internal ID of the list", "example" : null }, "listVersion" : { "type" : "integer", "description" : "A number that represents a version of the list", "format" : "int32", "example" : null }, "name" : { "type" : "string", "description" : "The name of the list", "example" : null }, "objectTypeId" : { "type" : "string", "description" : "The internal ID of the object type of the list", "example" : null }, "processingStatus" : { "type" : "string", "description" : "Represents the current processing status of the list", "example" : null }, "processingType" : { "type" : "string", "description" : "Processing type of the list", "example" : null }, "size" : { "type" : "integer", "description" : "The size of the result list", "format" : "int64", "example" : null }, "updatedAt" : { "type" : "string", "description" : "Timestamp of the last update of the list", "format" : "date-time", "example" : null }, "updatedById" : { "type" : "string", "description" : "The ID of the user who last updated the list", "example" : null } }, "example" : null }, "SearchPublicResponseWrapper" : { "required" : [ "appId", "externalAccountId", "externalEventId", "objectId" ], "type" : "object", "properties" : { "appId" : { "type" : "integer", "description" : "The ID of the source application of the marketing event", "format" : "int32", "example" : null }, "externalAccountId" : { "type" : "string", "description" : "The account ID associated with this marketing event in the external application", "example" : null }, "externalEventId" : { "type" : "string", "description" : "The ID of the marketing event in the external event application", "example" : null }, "objectId" : { "type" : "string", "description" : "The internal ID of the marketing event in HubSpot", "example" : null } }, "example" : null }, "StandardError" : { "required" : [ "category", "context", "errors", "links", "message", "status" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The category of the error", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "The object that contains details of the errors", "example" : null }, "errors" : { "type" : "array", "description" : "The detailed error objects.", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "id" : { "type" : "string", "description" : "The ID of the request", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Results of the request", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : null }, "status" : { "type" : "string", "description" : "Status of the response", "example" : null }, "subCategory" : { "type" : "object", "properties" : { }, "description" : "The Sub-category of the error", "example" : null } }, "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.", "example" : null }, "SubscriberEmailResponse" : { "required" : [ "email", "vid" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "The email of the contact", "example" : null }, "vid" : { "type" : "integer", "description" : "The internal ID of the contact", "format" : "int64", "example" : null } }, "example" : null }, "SubscriberVidResponse" : { "required" : [ "vid" ], "type" : "object", "properties" : { "vid" : { "type" : "integer", "description" : "The internal ID of the contact", "format" : "int64", "example" : null } }, "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "crm.objects.marketing_events.read" : "", "crm.objects.marketing_events.write" : "", "developers-read" : "", "developers-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" } }