Pular para o conteúdo principal
PATCH
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
Atualizar evento de marketing por IDs externos
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": [
    {
      "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>",
  "startDateTime": "2023-11-07T05:31:56Z"
}
'
{
  "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>"
    }
  ],
  "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"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
externalEventId
string
required

O ID do evento de marketing no aplicativo de eventos externos

Query Parameters

​
externalAccountId
string
required

O accountId que está associado a este evento de marketing no aplicativo de eventos externos

Body

application/json
​
customProperties
object[]
required

Uma lista de PropertyValues. Estes podem ser qualquer tipo de nomes e valores de propriedade que você quiser. No entanto, já devem existir na definição do objeto MarketingEvent na conta da HubSpot. Se não existirem, eles serão filtrados e não definidos. Para fazer isso, você precisará criar um novo PropertyGroup no objeto MarketingEvent na conta da HubSpot para seu aplicativo específico e criar a Propriedade personalizada que deseja rastrear nessa conta da HubSpot. Não crie novas propriedades padrão no objeto MarketingEvent, pois estas serão aplicadas a todas as contas da HubSpot.

​
endDateTime
string<date-time>

A data e hora de término do evento de marketing.

​
eventCancelled
boolean

Indica se o evento de marketing foi cancelado. O padrão é "false"

​
eventCompleted
boolean

Indica se o evento de marketing foi concluído. O valor padrão é "false".

​
eventDescription
string

A descrição do evento de marketing.

​
eventName
string

O nome do evento de marketing.

​
eventOrganizer
string

O nome do organizador do evento de marketing.

​
eventType
string

Descreve o tipo de evento. Por exemplo: "WEBINAR", "CONFERENCE", "WORKSHOP"

​
eventUrl
string

Um URL no aplicativo de eventos externos onde o evento de marketing pode ser gerenciado.

​
startDateTime
string<date-time>

A data e hora de início do evento de marketing.

Response

successful operation

​
createdAt
string<date-time>
required

A data e hora de criação do evento de marketing.

​
customProperties
object[]
required

Uma lista de PropertyValues. Estes podem ser qualquer tipo de nomes e valores de propriedade que você quiser. No entanto, já devem existir na definição do objeto MarketingEvent na conta da HubSpot. Se não existirem, eles serão filtrados e não definidos. Para fazer isso, você precisará criar um novo PropertyGroup no objeto MarketingEvent na conta da HubSpot para seu aplicativo específico e criar a Propriedade personalizada que deseja rastrear nessa conta da HubSpot. Não crie novas propriedades padrão no objeto MarketingEvent, pois estas serão aplicadas a todas as contas da HubSpot.

​
eventName
string
required

O nome do evento de marketing.

​
eventOrganizer
string
required

O nome do organizador do evento de marketing.

​
id
string
required

O ID do objeto do CRM do evento de marketing.

​
updatedAt
string<date-time>
required

A data e hora da atualização do evento de marketing.

​
endDateTime
string<date-time>

A data e hora de término do evento de marketing.

​
eventCancelled
boolean

Indica se o evento de marketing foi cancelado.

​
eventCompleted
boolean

Indica se o evento de marketing foi concluído.

​
eventDescription
string

A descrição do evento de marketing.

​
eventType
string

O tipo do evento de marketing.

​
eventUrl
string

Um URL no aplicativo de eventos externos onde o evento de marketing pode ser gerenciado.

​
objectId
string

O ID do objeto do CRM do evento de marketing.

​
startDateTime
string<date-time>

A data e hora de início do evento de marketing.

Last modified on December 10, 2025