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>'
{
  "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"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubStarter

​
Portées requises

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

​
registrants
integer
required

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

​
eventOrganizer
string
required

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

​
attendees
integer
required

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

​
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é.

​
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
​
externalEventId
string
required

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

​
eventName
string
required

Le nom de l'événement marketing.

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

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

​
eventType
string

Le type de l'événement marketing.

​
eventCompleted
boolean
​
endDateTime
string<date-time>

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

​
startDateTime
string<date-time>

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

​
customProperties
object[]

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.

​
eventCancelled
boolean

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

​
eventDescription
string

La description de l'événement marketing.

​
objectId
string
⌘I