Pular para o conteúdo principal
PATCH
Atualizar uma definição de evento personalizado

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

eventName
string
obrigatório

Nome exclusivo da definição de evento a ser atualizada.

Corpo

application/json
description
string

Uma descrição do evento que será exibida como texto de ajuda no HubSpot.

label
string

Rótulo legível por humanos para o evento. Usado na interface do HubSpot

Resposta

successful operation

archived
boolean
obrigatório

Um booleano que indica se o tipo de evento está arquivado.

associations
object[]
obrigatório

Uma matriz de definições de associação que definem as associações relacionadas ao tipo de evento.

fullyQualifiedName
string
obrigatório

Uma string que representa o nome totalmente qualificado do tipo de evento.

id
string
obrigatório

Uma string que representa o identificador exclusivo do tipo de evento.

labels
object
obrigatório
name
string
obrigatório

Uma string que representa o nome do tipo de evento.

objectTypeId
string
obrigatório

Uma string que representa o ID do tipo de objeto do tipo de evento.

properties
object[]
obrigatório

Uma matriz de objetos de propriedade que definem as propriedades do tipo de evento.

comboEventRules
object
createdAt
string<date-time>

Uma string que representa a data e a hora em que o tipo de evento foi criado, no formato ISO 8601.

createdUserId
integer<int32>

Um número inteiro que representa o ID do usuário que criou o tipo de evento.

customMatchingId
object
description
string

Uma string que fornece uma descrição do tipo de evento.

detailTemplate
string

Uma string usada como modelo para os detalhes do tipo de evento.

headerTemplate
string

Uma string usada como modelo para o cabeçalho do tipo de evento.

primaryObject
string

Uma string que representa o objeto principal associado ao tipo de evento.

primaryObjectId
string

Uma string que representa o ID do objeto principal associado ao tipo de evento.

trackingType
enum<string>

Uma string que especifica o tipo de rastreamento do evento. Os valores válidos incluem "VISITED_URL", "CLICKED_ELEMENT", "CUSTOM_SCRIPT" e outros.

Opções disponíveis:
APP_EVENT,
AUTOCAPTURE_EVENT,
CLICKED_ELEMENT,
COMBO_EVENT,
CUSTOM_SCRIPT,
CUSTOM_SIGNAL,
IMPORT,
MANUAL,
POLLING,
PROPERTY_CHANGE,
VISITED_URL,
WEBHOOK
updatedAt
string<date-time>

Uma string que representa a data e a hora em que o tipo de evento foi atualizado pela última vez, no formato ISO 8601.

updatedUserId
integer<int32>

Um número inteiro que representa o ID do usuário que atualizou pela última vez o tipo de evento.

Última modificação em 6 de outubro de 2026