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

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Starter
Cette API requiert l'une des portées suivantes :
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

L'identifiant de l'événement marketing dans l'application d'événements externe

Query Parameters

​
externalAccountId
string
required

L'ID de compte associé à cet événement marketing dans l'application d'événement externe.

Response

successful operation

​
attendees
integer
required

Le nombre de contacts HubSpot qui ont assisté à cet événement marketing.

​
cancellations
integer
required

Le nombre de contacts HubSpot qui se sont inscrits à cet événement marketing, mais ont annulé leur inscription par la suite.

​
createdAt
string<date-time>
required
​
customProperties
object[]
required

Une liste de « PropertyValues ». Il peut s'agir de n'importe quel type de noms et de valeurs de propriétés que vous souhaitez. Toutefois, ils doivent déjà exister dans la définition de l'objet « MarketingEvent » du compte HubSpot. S'ils n'existent pas, ils seront filtrés et non définis. Pour ce faire, vous devrez créer un nouveau «  PropertyGroup » sur l'objet MarketingEvent du compte HubSpot pour votre application spécifique et créer la propriété personnalisée que vous souhaitez suivre sur ce compte HubSpot. Ne créez aucune nouvelle propriété par défaut sur l'objet MarketingEvent, car cela s'appliquerait à tous les comptes HubSpot.

​
eventName
string
required

Le nom de l'événement marketing.

​
eventOrganizer
string
required

Le nom de l'organisateur de l'événement marketing.

​
externalEventId
string
required

L'identifiant de l'événement marketing dans l'application d'événements externe.

​
id
string
required
​
noShows
integer
required

Le nombre de contacts HubSpot qui se sont inscrits à cet événement marketing, mais n'y ont pas assisté. Ce champ n'a de valeur que lorsque l'événement est terminé.

​
registrants
integer
required

Le nombre de contacts HubSpot qui se sont inscrits à cet événement marketing.

​
updatedAt
string<date-time>
required
​
endDateTime
string<date-time>

La date et l'heure de fin de l'événement marketing.

​
eventCancelled
boolean

Indique si l'événement marketing a été annulé.

​
eventCompleted
boolean
​
eventDescription
string

La description de l'événement marketing.

​
eventType
string

Le type de l'événement marketing.

​
eventUrl
string

Une URL dans l'application d'événement externe d'où il est possible de gérer l'événement marketing.

​
objectId
string
​
startDateTime
string<date-time>

La date et l'heure de début de l'événement marketing.