HubSpot: Marketing events schemas

← Marketing events operations · All schemas

Create a marketing event — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
customProperties	array	Required within parent	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. In 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.
customProperties[]	Model	Each item	Expand Create a marketing event — request body — body custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event. Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled. Defaults to `false`
eventCompleted	boolean	Optional	Indicates if the marketing event has been completed. Defaults to `false`
eventDescription	string	Optional	The description of the marketing event.
eventName	string	Required within parent	The name of the marketing event.
eventOrganizer	string	Required within parent	The name of the organizer of the marketing event.
eventType	string	Optional	Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed.
externalAccountId	string	Required within parent	The accountId that is associated with this marketing event in the external event application.
externalEventId	string	Required within parent	The id of the marketing event in the external event application.
startDateTime	string	Optional	The start date and time of the marketing event. Format: date-time

Referenced models: Create a marketing event — request body — body custom Properties item

Create a marketing event — request body — body custom Properties item

Field	Type	Presence	Description and constraints
$	object	Root	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.
dataSensitivity	string	Required within parent	Level of data sensitivity One of: high, none, standard
isEncrypted	boolean	Required within parent	Indicates whether the property is encrypted
isLargeValue	boolean	Required within parent	Indicates whether the property value is stored as a large value in the storage
maskedSubstrings	Model	Required within parent	Expand Create a marketing event — request body — body custom Properties item masked Substrings
name	string	Required within parent	Name of custom property
persistenceTimestamp	integer	Required within parent	The timestamp that indicates when the value being written is persisted in storage Format: int64
requestId	string	Required within parent	The ID of the request
selectedByUser	boolean	Required within parent	Indicates whether the property is selected
selectedByUserTimestamp	integer	Required within parent	Timestamp of when the property was selected by the user Format: int64
source	string	Required within parent	Source of the property One of: 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	string	Required within parent	ID of the source of the property
sourceLabel	string	Required within parent	Label of the source of the property
sourceMetadata	string	Required within parent	Source metadata encoded as a base64 string
sourceUpstreamDeployable	string	Required within parent	Indicates which upstream service made the property change
sourceVid	array	Required within parent	An array of integers representing IDs associated with the source of the property value.
sourceVid[]	integer	Each item	Format: int64
timestamp	integer	Required within parent	Timestamp of the request Format: int64
unit	string	Required within parent	The unit
updatedByUserId	integer	Required within parent	The ID of the user who last updated the property Format: int32
useTimestampAsPersistenceTimestamp	boolean	Required within parent	Indicates if the persistence timestamp is the same as storage version timestamp
value	string	Required within parent	Custom property value

Referenced models: Create a marketing event — request body — body custom Properties item masked Substrings

Create a marketing event — request body — body custom Properties item masked Substrings

Field	Type	Presence	Description and constraints
$	object	Root
substrings	array	Required within parent	An array of masked substring objects, each defining a specific portion of a string to be masked. Each object in the array specifies the start and end positions of the substring to be masked.
substrings[]	Model	Each item	Expand Create a marketing event — request body — body custom Properties item masked Substrings substrings item

Referenced models: Create a marketing event — request body — body custom Properties item masked Substrings substrings item

Create a marketing event — request body — body custom Properties item masked Substrings substrings item

Field	Type	Presence	Description and constraints
$	object	Root
end	integer	Required within parent	An integer indicating the ending position of the masked substring. Format: int32
label	string	Required within parent
start	integer	Required within parent	An integer indicating the starting position of the masked substring. Format: int32

Create a marketing event — response body

Field	Type	Presence	Description and constraints
$	object	Root
customProperties	array	Required within parent	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. In 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.
customProperties[]	Model	Each item	Expand Create a marketing event — response body — custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event. Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled.
eventCompleted	boolean	Optional	Indicates if the marketing event has been completed.
eventDescription	string	Optional	The description of the marketing event.
eventName	string	Required within parent	The name of the marketing event.
eventOrganizer	string	Required within parent	The name of the organizer of the marketing event.
eventType	string	Optional	The type of the marketing event.
eventUrl	string	Optional	The URL in the external event application where the marketing event can be managed.
objectId	string	Optional	The ID of the marketing event CRM object
startDateTime	string	Optional	The start date and time of the marketing event. Format: date-time

Referenced models: Create a marketing event — response body — custom Properties item

Create a marketing event — response body — custom Properties item

Field	Type	Presence	Description and constraints
$	object	Root	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.
dataSensitivity	string	Required within parent	Level of data sensitivity Known values: high, none, standard
isEncrypted	boolean	Required within parent	Indicates whether the property is encrypted
isLargeValue	boolean	Required within parent	Indicates whether the property value is stored as a large value in the storage
maskedSubstrings	Model	Required within parent	Expand Create a marketing event — response body — custom Properties item masked Substrings
name	string	Required within parent	Name of custom property
persistenceTimestamp	JSON	Required within parent
persistenceTimestamp (anyOf 1)	integer	Alternative	The timestamp that indicates when the value being written is persisted in storage Format: int64
persistenceTimestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestId	string	Required within parent	The ID of the request
selectedByUser	boolean	Required within parent	Indicates whether the property is selected
selectedByUserTimestamp	JSON	Required within parent
selectedByUserTimestamp (anyOf 1)	integer	Alternative	Timestamp of when the property was selected by the user Format: int64
selectedByUserTimestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source	string	Required within parent	Source of the property Known values: 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	string	Required within parent	ID of the source of the property
sourceLabel	string	Required within parent	Label of the source of the property
sourceMetadata	string	Required within parent	Source metadata encoded as a base64 string
sourceUpstreamDeployable	string	Required within parent	Indicates which upstream service made the property change
sourceVid	array	Required within parent	An array of integers representing IDs associated with the source of the property value.
sourceVid[]	JSON	Each item
sourceVid[] (anyOf 1)	integer	Alternative	Format: int64
sourceVid[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timestamp	JSON	Required within parent
timestamp (anyOf 1)	integer	Alternative	Timestamp of the request Format: int64
timestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit	string	Required within parent	The unit
updatedByUserId	JSON	Required within parent
updatedByUserId (anyOf 1)	integer	Alternative	The ID of the user who last updated the property Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
useTimestampAsPersistenceTimestamp	boolean	Required within parent	Indicates if the persistence timestamp is the same as storage version timestamp
value	string	Required within parent	Custom property value

Referenced models: Create a marketing event — response body — custom Properties item masked Substrings

Create a marketing event — response body — custom Properties item masked Substrings

Field	Type	Presence	Description and constraints
$	object	Root
substrings	array	Required within parent	An array of masked substring objects, each defining a specific portion of a string to be masked. Each object in the array specifies the start and end positions of the substring to be masked.
substrings[]	Model	Each item	Expand Create a marketing event — response body — custom Properties item masked Substrings substrings item

Referenced models: Create a marketing event — response body — custom Properties item masked Substrings substrings item

Create a marketing event — response body — custom Properties item masked Substrings substrings item

Field	Type	Presence	Description and constraints
$	object	Root
end	JSON	Required within parent
end (anyOf 1)	integer	Alternative	An integer indicating the ending position of the masked substring. Format: int32
end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
label	string	Required within parent
start	JSON	Required within parent
start (anyOf 1)	integer	Alternative	An integer indicating the starting position of the masked substring. Format: int32
start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create or Update Multiple Marketing Events — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of MarketingEventCreateRequestParams objects, each containing the necessary details to create a marketing event. This includes properties such as event name, organizer, and custom properties.
inputs[]	Model	Each item	Expand Create a marketing event — request body — body

Referenced models: Create a marketing event — request body — body

Create or Update Multiple Marketing Events — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	Timestamp of when the request was completed. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each item detailing a specific error.
errors[]	Model	Each item	Expand Create or Update Multiple Marketing Events — response body — errors item
links	object	Optional	Result of the request. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the request. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	Timestamp of when the request was sent. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each item representing a response for an individual marketing event.
results[]	Model	Each item	Expand Create or update a marketing event — response body
startedAt	string	Required within parent	Timestamp of when the request started processing. Format: date-time
status	string	Required within parent	Status of the response. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create or Update Multiple Marketing Events — response body — errors item, Create or update a marketing event — response body

Create or Update Multiple Marketing Events — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	The category of the error
context	object	Required within parent	The object that contains details of the errors Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	The ID of the request
links	object	Required within parent	Results of the request Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
status	string	Required within parent	Status of the response
subCategory	object	Optional	The Sub-category of the error

Referenced models: Batch insert events — response body — errors item errors item

Create or update a marketing event — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The creation date and time of the marketing event. Format: date-time
customProperties	array	Required within parent	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. In 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.
customProperties[]	Model	Each item	Expand Create a marketing event — response body — custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event. Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled.
eventCompleted	boolean	Optional	Indicates if the marketing event has been completed.
eventDescription	string	Optional	The description of the marketing event.
eventName	string	Required within parent	The name of the marketing event.
eventOrganizer	string	Required within parent	The name of the organizer of the marketing event.
eventType	string	Optional	The type of the marketing event.
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed.
id	string	Required within parent	The ID of the marketing event CRM object.
objectId	string	Optional	The ID of the marketing event CRM object.
startDateTime	string	Optional	The start date and time of the marketing event. Format: date-time
updatedAt	string	Required within parent	The update date and time of the marketing event. Format: date-time

Referenced models: Create a marketing event — response body — custom Properties item

Delete Multiple Marketing Events by External Ids — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of MarketingEventExternalUniqueIdentifier objects, each representing a unique identifier for a marketing event. This is required for batch operations.
inputs[]	Model	Each item	Expand Delete Multiple Marketing Events by External Ids — request body — body inputs item

Referenced models: Delete Multiple Marketing Events by External Ids — request body — body inputs item

Delete Multiple Marketing Events by External Ids — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
appId	integer	Required within parent	The id of the application that created the marketing event in HubSpot. Format: int32
externalAccountId	string	Required within parent	The accountId that is associated with this marketing event in the external event application.
externalEventId	string	Required within parent	The id of the marketing event in the external event application.

Delete Multiple Marketing Events by Object Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of marketing event public object IDs to be deleted. Each item in the array is a MarketingEventPublicObjectIdDeleteRequest object.
inputs[]	Model	Each item	Expand Delete Multiple Marketing Events by Object Id — request body — body inputs item

Referenced models: Delete Multiple Marketing Events by Object Id — request body — body inputs item

Delete Multiple Marketing Events by Object Id — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
objectId	string	Required within parent	The internal ID of the marketing event in HubSpot

Find App-Specific Marketing Events by External Event Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of search result objects, each represented by a SearchPublicResponseWrapper. This property contains the search results returned by the API.
results[]	Model	Each item	Expand Find App-Specific Marketing Events by External Event Id — response body — results item

Referenced models: Find App-Specific Marketing Events by External Event Id — response body — results item

Find App-Specific Marketing Events by External Event Id — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
appId	JSON	Required within parent
appId (anyOf 1)	integer	Alternative	The ID of the source application of the marketing event Format: int32
appId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
externalAccountId	string	Required within parent	The account ID associated with this marketing event in the external application
externalEventId	string	Required within parent	The ID of the marketing event in the external event application
objectId	string	Required within parent	The internal ID of the marketing event in HubSpot

Find Marketing Events by External Event Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Find Marketing Events by External Event Id — response body — paging
results	array	Required within parent	An array containing the marketing event identifiers. Each item in the array is a MarketingEventIdentifiersResponse object.
results[]	Model	Each item	Expand Find Marketing Events by External Event Id — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of marketing event identifiers. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Find Marketing Events by External Event Id — response body — results item, Find Marketing Events by External Event Id — response body — paging

Find Marketing Events by External Event Id — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List — marketing Events get Marketing Events — response body — paging next
prev	Model	Optional	Expand Find Marketing Events by External Event Id — response body — paging prev

Referenced models: List — marketing Events get Marketing Events — response body — paging next, Find Marketing Events by External Event Id — response body — paging prev

Find Marketing Events by External Event Id — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string that serves as a cursor indicating the position before the first item in the current set of results, used to fetch the previous set of results.
link	string	Optional	A string containing the URL link to the previous page of results.

Find Marketing Events by External Event Id — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
appInfo	Model	Optional	Expand Get Marketing Event by object Id — response body — app Info
externalAccountId	string	Optional	The accountId that is associated with this marketing event in the external event application
externalEventId	string	Required within parent	The ID that is associated with this marketing event in the external event application
marketingEventName	string	Required within parent	The name of the marketing event
objectId	string	Required within parent	The internal ID of the marketing event in HubSpot CRM

Referenced models: Get Marketing Event by object Id — response body — app Info

Get Marketing Event by External I Ds — response body

Field	Type	Presence	Description and constraints
$	object	Root
attendees	JSON	Required within parent
attendees (anyOf 1)	integer	Alternative	The number of HubSpot contacts that attended this marketing event. Format: int32
attendees (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cancellations	JSON	Required within parent
cancellations (anyOf 1)	integer	Alternative	The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration. Format: int32
cancellations (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Required within parent	The creation date and time of the marketing event. Format: date-time
customProperties	array	Required within parent	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. In 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.
customProperties[]	Model	Each item	Expand Create a marketing event — response body — custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event. Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled.
eventCompleted	boolean	Optional	Indicates if the marketing event has been completed.
eventDescription	string	Optional	The description of the marketing event.
eventName	string	Required within parent	The name of the marketing event.
eventOrganizer	string	Required within parent	The name of the organizer of the marketing event.
eventType	string	Optional	The type of the marketing event.
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed.
externalEventId	string	Required within parent	The id of the marketing event in the external event application.
id	string	Required within parent	The ID of the marketing event CRM object.
noShows	JSON	Required within parent
noShows (anyOf 1)	integer	Alternative	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
noShows (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
objectId	string	Optional	The ID of the marketing event CRM object.
registrants	JSON	Required within parent
registrants (anyOf 1)	integer	Alternative	The number of HubSpot contacts that registered for this marketing event. Format: int32
registrants (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDateTime	string	Optional	The start date and time of the marketing event. Format: date-time
updatedAt	string	Required within parent	The update date and time of the marketing event. Format: date-time

Referenced models: Create a marketing event — response body — custom Properties item

Get Marketing Event by object Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
appInfo	Model	Optional	Expand Get Marketing Event by object Id — response body — app Info
attendees	JSON	Optional
attendees (anyOf 1)	integer	Alternative	Number of attended contact records of a marketing event Format: int32
attendees (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cancellations	JSON	Optional
cancellations (anyOf 1)	integer	Alternative	Number of cancelled contact records of a marketing event Format: int32
cancellations (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Required within parent	The creation date and time of the marketing event Format: date-time
customProperties	array	Required within parent	An array of custom properties associated with the event.
customProperties[]	Model	Each item	Expand Get Marketing Event by object Id — response body — custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled
eventCompleted	boolean	Optional	Indicates if the marketing event has been completed
eventDescription	string	Optional	The description of the marketing event
eventName	string	Required within parent	The name of the marketing event
eventOrganizer	string	Optional	The name of the organizer of the marketing event
eventStatus	string	Optional	The status of the marketing event
eventStatusV2	string	Optional	The version 2 status of the event, represented as a string.
eventType	string	Optional	The type of the marketing event
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed
externalEventId	string	Optional	The ID that is associated with this marketing event in the external event application
noShows	JSON	Optional
noShows (anyOf 1)	integer	Alternative	Number of no-show contact records of a marketing event Format: int32
noShows (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
objectId	string	Required within parent	The internal ID of the marketing event in HubSpot
registrants	JSON	Optional
registrants (anyOf 1)	integer	Alternative	Number of registered contact records of a marketing event Format: int32
registrants (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDateTime	string	Optional	The start date and time of the marketing event Format: date-time
updatedAt	string	Required within parent	The update date and time of the marketing event Format: date-time

Referenced models: Get Marketing Event by object Id — response body — app Info, Get Marketing Event by object Id — response body — custom Properties item

Get Marketing Event by object Id — response body — app Info

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The ID of the application
name	string	Required within parent	The name of the application

Get Marketing Event by object Id — response body — custom Properties item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	The name of the property in the CRM
value	string	Required within parent	The value of the property in the CRM

Get lists associated with a marketing event — marketing Events get Associations Lists — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Find Marketing Events by External Event Id — response body — paging
results	array	Required within parent	An array of public lists, where each list contains details such as list ID, version, name, and processing status.
results[]	Model	Each item	Expand Get lists associated with a marketing event — marketing Events get Associations Lists — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of public lists available. It is an integer value. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Find Marketing Events by External Event Id — response body — paging, Get lists associated with a marketing event — marketing Events get Associations Lists — response body — results item

Get lists associated with a marketing event — marketing Events get Associations Lists — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Optional	Timestamp of the creation of the list Format: date-time
createdById	string	Optional	The ID of the user who created the list
deletedAt	string	Optional	Timestamp of the deletion of the list Format: date-time
filtersUpdatedAt	string	Optional	Timestamp of the last update of the list filters Format: date-time
listId	string	Required within parent	An internal ID of the list
listVersion	JSON	Required within parent
listVersion (anyOf 1)	integer	Alternative	A number that represents a version of the list Format: int32
listVersion (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the list
objectTypeId	string	Required within parent	The internal ID of the object type of the list
processingStatus	string	Required within parent	Represents the current processing status of the list
processingType	string	Required within parent	Processing type of the list
size	JSON	Optional
size (anyOf 1)	integer	Alternative	The size of the result list Format: int64
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Optional	Timestamp of the last update of the list Format: date-time
updatedById	string	Optional	The ID of the user who last updated the list

List — marketing Events get Marketing Events — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List — marketing Events get Marketing Events — response body — paging
results	array	Required within parent	An array of marketing event public read responses, each containing details about a specific marketing event.
results[]	Model	Each item	Expand Get Marketing Event by object Id — response body

Referenced models: List — marketing Events get Marketing Events — response body — paging, Get Marketing Event by object Id — response body

List — marketing Events get Marketing Events — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List — marketing Events get Marketing Events — response body — paging next

Referenced models: List — marketing Events get Marketing Events — response body — paging next

List — marketing Events get Marketing Events — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	The ID element at the start of the page
link	string	Optional	Link to the next page

Mark a marketing event as completed — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
endDateTime	string	Required within parent	The end date and time of the marketing event in ISO 8601 format Format: date-time
startDateTime	string	Required within parent	The start date and time of the marketing event in ISO 8601 format Format: date-time

Read participations breakdown by Contact identifier — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Find Marketing Events by External Event Id — response body — paging
results	array	Required within parent	An array of participation breakdown objects, each detailing a specific participation instance.
results[]	Model	Each item	Expand Read participations breakdown by Contact identifier — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of participation breakdowns available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Find Marketing Events by External Event Id — response body — paging, Read participations breakdown by Contact identifier — response body — results item

Read participations breakdown by Contact identifier — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
associations	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item associations
createdAt	string	Required within parent	The creation time and date of the target marketing event Format: date-time
id	string	Required within parent	The internal ID of the target marketing event
properties	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item properties

Referenced models: Read participations breakdown by Contact identifier — response body — results item associations, Read participations breakdown by Contact identifier — response body — results item properties

Read participations breakdown by Contact identifier — response body — results item associations

Field	Type	Presence	Description and constraints
$	object	Root
contact	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item associations contact
marketingEvent	Model	Required within parent	Expand Read participations breakdown by Contact identifier — response body — results item associations marketing Event

Referenced models: Read participations breakdown by Contact identifier — response body — results item associations contact, Read participations breakdown by Contact identifier — response body — results item associations marketing Event

Read participations breakdown by Contact identifier — response body — results item associations contact

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	The internal ID of the contact in HubSpot
email	string	Required within parent	The email of the contact in HubSpot
firstname	string	Optional	The first name of the contact in HubSpot
lastname	string	Optional	The last name of the contact in HubSpot

Read participations breakdown by Contact identifier — response body — results item associations marketing Event

Field	Type	Presence	Description and constraints
$	object	Root
externalAccountId	string	Optional	The account ID that is associated with this marketing event in the external event application
externalEventId	string	Optional	The event ID that is associated with this marketing event in the external event application
marketingEventId	string	Required within parent	The internal ID of the marketing event in HubSpot
name	string	Required within parent	The name of the marketing event in HubSpot

Read participations breakdown by Contact identifier — response body — results item properties

Field	Type	Presence	Description and constraints
$	object	Root
attendanceDurationSeconds	JSON	Optional
attendanceDurationSeconds (anyOf 1)	integer	Alternative	The number of seconds the participation lasted Format: int32
attendanceDurationSeconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attendancePercentage	string	Optional	Percentage of the participation duration relative to the event duration
attendanceState	string	Required within parent	The state of the participation Known values: ATTENDED, CANCELLED, EMPTY, NO_SHOW, REGISTERED
occurredAt	JSON	Required within parent
occurredAt (anyOf 1)	integer	Alternative	Timestamp of when the participation occurred Format: int64
occurredAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Read participations counters by Marketing Event external identifier — response body

Field	Type	Presence	Description and constraints
$	object	Root
attended	JSON	Required within parent
attended (anyOf 1)	integer	Alternative	Number of attended contact records of a marketing event Format: int32
attended (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cancelled	JSON	Required within parent
cancelled (anyOf 1)	integer	Alternative	Number of cancelled contact records of a marketing event Format: int32
cancelled (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
noShows	JSON	Required within parent
noShows (anyOf 1)	integer	Alternative	Number of no-show contact records of a marketing event Format: int32
noShows (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
registered	JSON	Required within parent
registered (anyOf 1)	integer	Alternative	Number of registered contact records of a marketing event Format: int32
registered (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Record Participants by Contact Id with Marketing Event Object Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	Timestamp that represents when the request finished processing Format: date-time
errors	array	Optional	An array of StandardError objects, each detailing an error encountered during the batch operation.
errors[]	Model	Each item	Expand Create or Update Multiple Marketing Events — response body — errors item
links	object	Optional	Result of the request Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the processing Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	Timestamp that represents when the request was made Format: date-time
results	array	Required within parent	An array of SubscriberVidResponse objects, each representing the result of processing an individual subscriber VID.
results[]	Model	Each item	Expand Record Participants by Contact Id with Marketing Event Object Id — response body — results item
startedAt	string	Required within parent	Timestamp that represents when the request started processing Format: date-time
status	string	Required within parent	The status of the request processing Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create or Update Multiple Marketing Events — response body — errors item, Record Participants by Contact Id with Marketing Event Object Id — response body — results item

Record Participants by Contact Id with Marketing Event Object Id — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
vid	JSON	Required within parent
vid (anyOf 1)	integer	Alternative	The internal ID of the contact Format: int64
vid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Record Participants by Email with Marketing Event Object Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	Timestamp that represents when the request finished processing Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each providing details about the error.
errors[]	Model	Each item	Expand Create or Update Multiple Marketing Events — response body — errors item
links	object	Optional	Result of the request Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the processing Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	Timestamp that represents when the request was made Format: date-time
results	array	Required within parent	An array of results from the batch operation, each containing details about a subscriber email response.
results[]	Model	Each item	Expand Record Participants by Email with Marketing Event Object Id — response body — results item
startedAt	string	Required within parent	Timestamp that represents when the request started processing Format: date-time
status	string	Required within parent	The status of the request processing Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create or Update Multiple Marketing Events — response body — errors item, Record Participants by Email with Marketing Event Object Id — response body — results item

Record Participants by Email with Marketing Event Object Id — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email of the contact
vid	JSON	Required within parent
vid (anyOf 1)	integer	Alternative	The internal ID of the contact Format: int64
vid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Record a subscriber state by contact ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	List of HubSpot contacts to subscribe to the marketing event
inputs[]	Model	Each item	Expand Record a subscriber state by contact ID — request body — body inputs item

Referenced models: Record a subscriber state by contact ID — request body — body inputs item

Record a subscriber state by contact ID — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
interactionDateTime	integer	Required within parent	Timestamp in milliseconds at which the contact subscribed to the event. Format: int64
properties	object	Required within parent	The key-value set of the properties of the contact Additional keys: see wildcard field
properties.*	string	Additional keys
vid	integer	Required within parent	The ID of the contact in HubSpot Format: int64

Record a subscriber state by contact email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	List of marketing event details to create or update
inputs[]	Model	Each item	Expand Record a subscriber state by contact email — request body — body inputs item

Referenced models: Record a subscriber state by contact email — request body — body inputs item

Record a subscriber state by contact email — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
contactProperties	object	Required within parent	The key-value set that contains properties of the contact. Additional keys: see wildcard field
contactProperties.*	string	Additional keys
email	string	Required within parent	The email address of the contact in HubSpot to associate with the event.
interactionDateTime	integer	Required within parent	Timestamp in milliseconds at which the contact subscribed to the event. Format: int64
properties	object	Required within parent	The key-value set that contains properties of the marketing event. Additional keys: see wildcard field
properties.*	string	Additional keys

Update Marketing Event by External I Ds — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
customProperties	array	Required within parent	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. In 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.
customProperties[]	Model	Each item	Expand Create a marketing event — request body — body custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event. Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled. Defaults to `false`
eventCompleted	boolean	Optional	Indicates if the marketing event has been completed. Defaults to `false`
eventDescription	string	Optional	The description of the marketing event.
eventName	string	Optional	The name of the marketing event.
eventOrganizer	string	Optional	The name of the organizer of the marketing event.
eventType	string	Optional	Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed.
startDateTime	string	Optional	The start date and time of the marketing event. Format: date-time

Referenced models: Create a marketing event — request body — body custom Properties item

Update Marketing Event by object Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
customProperties	array	Required within parent	An array of custom properties associated with the event.
customProperties[]	Model	Each item	Expand Create a marketing event — request body — body custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled
eventDescription	string	Optional	The description of the marketing event
eventName	string	Optional	The name of the marketing event
eventOrganizer	string	Optional	The name of the organizer of the marketing event
eventType	string	Optional	The type of the marketing event
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed
startDateTime	string	Optional	The start date and time of the marketing event Format: date-time

Referenced models: Create a marketing event — request body — body custom Properties item

Update Marketing Event by object Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
appInfo	Model	Optional	Expand Get Marketing Event by object Id — response body — app Info
createdAt	string	Required within parent	The creation date and time of the marketing event Format: date-time
customProperties	array	Required within parent	An array of custom properties associated with the marketing event, each represented by a CrmPropertyWrapper object.
customProperties[]	Model	Each item	Expand Get Marketing Event by object Id — response body — custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled
eventCompleted	boolean	Optional	Indicates if the marketing event has been completed
eventDescription	string	Optional	The description of the marketing event
eventName	string	Required within parent	The name of the marketing event
eventOrganizer	string	Optional	The name of the organizer of the marketing event
eventType	string	Optional	The type of the marketing event
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed
objectId	string	Required within parent	The internal ID of the marketing event in HubSpot
startDateTime	string	Optional	The start date and time of the marketing event Format: date-time
updatedAt	string	Required within parent	The update date and time of the marketing event Format: date-time

Referenced models: Get Marketing Event by object Id — response body — app Info, Get Marketing Event by object Id — response body — custom Properties item

Update Multiple Marketing Events by Object Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of MarketingEventPublicUpdateRequestFullV2 objects, each representing a marketing event update request. This property is required.
inputs[]	Model	Each item	Expand Update Multiple Marketing Events by Object Id — request body — body inputs item

Referenced models: Update Multiple Marketing Events by Object Id — request body — body inputs item

Update Multiple Marketing Events by Object Id — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
customProperties	array	Required within parent	An array of custom properties associated with the event, where each property is defined by a PropertyValue object.
customProperties[]	Model	Each item	Expand Create a marketing event — request body — body custom Properties item
endDateTime	string	Optional	The end date and time of the marketing event Format: date-time
eventCancelled	boolean	Optional	Indicates if the marketing event has been cancelled
eventDescription	string	Optional	The description of the marketing event
eventName	string	Optional	The name of the marketing event
eventOrganizer	string	Optional	The name of the organizer of the marketing event
eventType	string	Optional	The type of the marketing event
eventUrl	string	Optional	A URL in the external event application where the marketing event can be managed
objectId	string	Required within parent	The internal ID of the marketing event in HubSpot
startDateTime	string	Optional	The start date and time of the marketing event Format: date-time

Referenced models: Create a marketing event — request body — body custom Properties item

Update Multiple Marketing Events by ObjectId — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Marketing Event Public Default Response V2

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	Timestamp of when the request was processed. Format: date-time
links	object	Optional	Result object of the request. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	Timestamp of when the request was sent. Format: date-time
results	array	Required within parent	An array containing the results of the batch operation, with each item representing a marketing event response.
results[]	Model	Each item	Expand Update Marketing Event by object Id — response body
startedAt	string	Required within parent	Timestamp of when the request started processing. Format: date-time
status	string	Required within parent	The status of the response. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Update Marketing Event by object Id — response body

Update Multiple Marketing Events by ObjectId — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Marketing Event Public Default Response V2 With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	Timestamp that represents when the request finished processing Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each represented as a StandardError object.
errors[]	Model	Each item	Expand Create or Update Multiple Marketing Events — response body — errors item
links	object	Optional	Result of the request Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the processing Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	Timestamp that represents when the request was made Format: date-time
results	array	Required within parent	An array containing the results of the batch operation, each represented as a MarketingEventPublicDefaultResponseV2 object.
results[]	Model	Each item	Expand Update Marketing Event by object Id — response body
startedAt	string	Required within parent	Timestamp that represents when the request started processing Format: date-time
status	string	Required within parent	The status of the request processing Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Update Marketing Event by object Id — response body, Create or Update Multiple Marketing Events — response body — errors item