Sign in
Basic

Get Marketing Event by External IDs

Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.

Only Marketing Events created by the same app making the request can be retrieved.

get/marketing/v3/marketing-events/events/{externalEventId}

Path parameters

externalEventIdstring required

The id of the marketing event in the external event application

Query parameters

externalAccountIdstring required

The accountId that is associated with this marketing event in the external event application

Response

successful operation

attendeesinteger required

The number of HubSpot contacts that attended this marketing event.

cancellationsinteger required

The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration.

createdAtstring date-time required

The creation date and time of the marketing event.

endDateTimestring date-time

The end date and time of the marketing event.

eventCancelledboolean

Indicates if the marketing event has been cancelled.

eventCompletedboolean

Indicates if the marketing event has been completed.

eventDescriptionstring

The description of the marketing event.

eventNamestring required

The name of the marketing event.

eventOrganizerstring required

The name of the organizer of the marketing event.

eventTypestring

The type of the marketing event.

eventUrlstring

A URL in the external event application where the marketing event can be managed.

externalEventIdstring required

The id of the marketing event in the external event application.

idstring required

The ID of the marketing event CRM object.

noShowsinteger required

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.

objectIdstring

The ID of the marketing event CRM object.

registrantsinteger required

The number of HubSpot contacts that registered for this marketing event.

startDateTimestring date-time

The start date and time of the marketing event.

updatedAtstring date-time required

The update date and time of the marketing event.