Zum Hauptinhalt springen
POST
/
marketing
/
v3
/
marketing-events
/
events
Créer un événement marketing
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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>",
  "externalAccountId": "<string>",
  "externalEventId": "<string>",
  "startDateTime": "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>",
  "objectId": "<string>",
  "startDateTime": "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.write

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
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.

​
externalAccountId
string
required

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

​
externalEventId
string
required

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

​
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é. « faux » par défaut

​
eventCompleted
boolean
​
eventDescription
string

La description de l'événement marketing.

​
eventType
string

Décrit le type d'événement. Par exemple : « WEBINAR », « CONFERENCE », « WORKSHOP »

​
eventUrl
string

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

​
startDateTime
string<date-time>

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

Response

successful operation

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

​
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

L'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.