Zum Hauptinhalt springen
GET
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
Marketingevent nach externen IDs abrufen
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>'
{
  "registrants": 123,
  "eventOrganizer": "<string>",
  "eventUrl": "<string>",
  "attendees": 123,
  "eventType": "<string>",
  "eventCompleted": true,
  "endDateTime": "2023-11-07T05:31:56Z",
  "noShows": 123,
  "cancellations": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "startDateTime": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "sourceId": "",
      "selectedByUser": false,
      "sourceLabel": "",
      "sourceUpstreamDeployable": "<string>",
      "source": "",
      "updatedByUserId": 123,
      "persistenceTimestamp": 123,
      "sourceMetadata": "",
      "dataSensitivity": "",
      "sourceVid": "",
      "unit": "",
      "requestId": "",
      "isEncrypted": false,
      "name": "",
      "useTimestampAsPersistenceTimestamp": true,
      "value": "",
      "selectedByUserTimestamp": 123,
      "timestamp": 123,
      "isLargeValue": true
    }
  ],
  "eventCancelled": true,
  "externalEventId": "<string>",
  "eventDescription": "<string>",
  "eventName": "<string>",
  "id": "<string>",
  "objectId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Starter
Diese API erfordert einen der folgenden Bereiche:
crm.objects.marketing_events.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
externalEventId
string
required

Die ID des Marketingevents in der externen Event-Anwendung

Query Parameters

​
externalAccountId
string
required

Die accountId, die diesem Marketingevent in der externen Event-App zugeordnet ist

Response

successful operation

​
registrants
integer
required

Die Anzahl der HubSpot-Kontakte, die sich für dieses Marketingevent registriert haben

​
eventOrganizer
string
required

Der Name des Organisators des Marketingevents.

​
attendees
integer
required

Die Anzahl der HubSpot-Kontakte, die an diesem Marketingevent teilgenommen haben

​
noShows
integer
required

Die Anzahl der HubSpot-Kontakte, die sich für dieses Marketingevent registriert, aber nicht daran teilgenommen haben. Dieses Feld hatte nur einen Wert für nach dem Event.

​
cancellations
integer
required

Die Anzahl der HubSpot-Kontakte, die sich für dieses Marketingevent registriert, die Registrierung jedoch später storniert haben.

​
createdAt
string<date-time>
required
​
externalEventId
string
required

Die ID des Marketingevents in der externen Event-App.

​
eventName
string
required

Der Name des Marketingevents.

​
id
string
required
​
updatedAt
string<date-time>
required
​
eventUrl
string

Eine URL in der externen Event-App, in der das Marketingevent verwaltet werden kann.

​
eventType
string

Der Typ von Marketingevent.

​
eventCompleted
boolean
​
endDateTime
string<date-time>

Der Endzeitpunkt (Datum und Uhrzeit) des Marketingevents.

​
startDateTime
string<date-time>

Der Startzeitpunkt (Datum und Uhrzeit) des Marketingevents.

​
customProperties
object[]

Eine PropertyValues-Liste. Es kann sich um beliebige Eigenschaftsnamen und -werte handeln, die jedoch bereits in der Definition des MarketingEvent-Objekts im HubSpot-Account enthalten sein müssen. Ist dies nicht der Fall, werden sie herausgefiltert und nicht festgelegt. Um dies auszuschließen, müssen Sie für Ihre App eine neue PropertyGroup für das MarketingEvent-Objekt im HubSpot-Account sowie die benutzerdefinierte Eigenschaft erstellen, die Sie in diesem HubSpot-Account nachverfolgen möchten. Erstellen Sie keine neuen Standardeigenschaften für das MarketingEvent-Objekt, da dies auf alle HubSpot-Accounts angewendet wird.

​
eventCancelled
boolean

Gibt an, ob das Marketingevent storniert wurde.

​
eventDescription
string

Die Beschreibung des Marketingevents.

​
objectId
string
⌘I