Partially update event by external ID

Mettre à jour l'événement marketing par ID externes

curl --request PATCH \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customProperties": [
    {
      "isEncrypted": true,
      "isLargeValue": true,
      "name": "<string>",
      "persistenceTimestamp": 123,
      "requestId": "<string>",
      "selectedByUser": true,
      "selectedByUserTimestamp": 123,
      "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>",
  "startDateTime": "2023-11-07T05:31:56Z"
}
'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "isEncrypted": true,
      "isLargeValue": true,
      "name": "<string>",
      "persistenceTimestamp": 123,
      "requestId": "<string>",
      "selectedByUser": true,
      "selectedByUserTimestamp": 123,
      "sourceId": "<string>",
      "sourceLabel": "<string>",
      "sourceMetadata": "<string>",
      "sourceUpstreamDeployable": "<string>",
      "sourceVid": [
        123
      ],
      "timestamp": 123,
      "unit": "<string>",
      "updatedByUserId": 123,
      "useTimestampAsPersistenceTimestamp": true,
      "value": "<string>"
    }
  ],
  "eventName": "<string>",
  "eventOrganizer": "<string>",
  "id": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "endDateTime": "2023-11-07T05:31:56Z",
  "eventCancelled": true,
  "eventCompleted": true,
  "eventDescription": "<string>",
  "eventType": "<string>",
  "eventUrl": "<string>",
  "objectId": "<string>",
  "startDateTime": "2023-11-07T05:31:56Z"
}

PATCH

marketing

marketing-events

events

{externalEventId}

Mettre à jour l'événement marketing par ID externes

curl --request PATCH \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customProperties": [
    {
      "isEncrypted": true,
      "isLargeValue": true,
      "name": "<string>",
      "persistenceTimestamp": 123,
      "requestId": "<string>",
      "selectedByUser": true,
      "selectedByUserTimestamp": 123,
      "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>",
  "startDateTime": "2023-11-07T05:31:56Z"
}
'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "isEncrypted": true,
      "isLargeValue": true,
      "name": "<string>",
      "persistenceTimestamp": 123,
      "requestId": "<string>",
      "selectedByUser": true,
      "selectedByUserTimestamp": 123,
      "sourceId": "<string>",
      "sourceLabel": "<string>",
      "sourceMetadata": "<string>",
      "sourceUpstreamDeployable": "<string>",
      "sourceVid": [
        123
      ],
      "timestamp": 123,
      "unit": "<string>",
      "updatedByUserId": 123,
      "useTimestampAsPersistenceTimestamp": true,
      "value": "<string>"
    }
  ],
  "eventName": "<string>",
  "eventOrganizer": "<string>",
  "id": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "endDateTime": "2023-11-07T05:31:56Z",
  "eventCancelled": true,
  "eventCompleted": true,
  "eventDescription": "<string>",
  "eventType": "<string>",
  "eventUrl": "<string>",
  "objectId": "<string>",
  "startDateTime": "2023-11-07T05:31:56Z"
}

Supported products

Required Scopes

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

externalEventId

string

requis

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

Paramètres de requête

externalAccountId

string

requis

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

Corps

application/json

customProperties

object[]

requis

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.

Show child attributes

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é. Par défaut, « faux »

eventCompleted

boolean

Indique si l'événement marketing est terminé. La valeur par défaut est « faux ».

eventDescription

string

La description de l'événement marketing.

eventName

string

Le nom de l'événement marketing.

eventOrganizer

string

Le nom de l'organisateur 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.

Réponse

successful operation

createdAt

string<date-time>

requis

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

customProperties

object[]

requis

Show child attributes

eventName

string

requis

Le nom de l'événement marketing.

eventOrganizer

string

requis

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

string

requis

L'ID de l'objet CRM de l'événement marketing.

updatedAt

string<date-time>

requis

La date et l'heure de mise à jour 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

Indique si l'événement marketing est terminé.

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

L'ID de l'objet CRM de l'événement marketing.

startDateTime

string<date-time>

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

Dernière modification le 13 avril 2026

Retrieve all events

Update event by HubSpot ID

⌘I