Criar um evento de marketing

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing Hub -Grátis

Sales Hub -Grátis

Service Hub -Grátis

Content Hub -Grátis

Escopos Necessários

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

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.

Mostrar atributos filhos

customProperties.dataSensitivity

enum<string>

required

Nível de sensibilidade dos dados

Opções disponíveis:

high,

none,

standard

customProperties.isEncrypted

boolean

required

Indica se a propriedade está criptografada

customProperties.isLargeValue

boolean

required

Indica se o valor da propriedade está armazenado como um valor grande no armazenamento

customProperties.name

string

required

Nome da propriedade personalizada

customProperties.persistenceTimestamp

integer<int64>

required

O registro de data e a hora que indica quando o valor que está sendo gravado é persistido no armazenamento

customProperties.requestId

string

required

O ID da solicitação

customProperties.selectedByUser

boolean

required

Indica se a propriedade está selecionada

customProperties.selectedByUserTimestamp

integer<int64>

required

A data e a hora em que a propriedade foi selecionada pelo usuário

customProperties.source

enum<string>

required

Origem da propriedade

Opções disponíveis:

ACADEMY,

ACCEPTANCE_TEST,

ACTIVITY_AUTO_ASSOCIATE,

ADS,

AI_GROUP,

ANALYTICS,

API,

APPROVALS,

ASSISTS,

ASSOCIATIONS,

AUTO_ASSOCIATE_BY_DOMAIN,

AUTOMATION_JOURNEY,

AUTOMATION_PLATFORM,

AVATARS_SERVICE,

BATCH_UPDATE,

BCC_TO_CRM,

BEHAVIORAL_EVENTS,

BET_ASSIGNMENT,

BET_CRM_CONNECTOR,

BIDEN,

BILLING,

BOT,

CALCULATED,

CENTRAL_EXCHANGE_RATES,

CHATSPOT,

CLONE_OBJECTS,

COMMUNICATOR,

COMPANIES,

COMPANY_FAMILIES,

COMPANY_INSIGHTS,

CONTACTS,

CONTACTS_WEB,

CONTENT_MEMBERSHIP,

CONVERSATIONAL_ENRICHMENT,

CONVERSATIONS,

CRM_PROCESSES_PLATFORM,

CRM_UI,

CRM_UI_BULK_ACTION,

CUSTOMER_AGENT,

DATA_ENRICHMENT,

DATASET,

DEALS,

DEFAULT,

DELETE_OBJECTS,

EMAIL,

EMAIL_INBOX_IMPORT,

EMAIL_INTEGRATION,

ENGAGEMENTS,

EXTENSION,

FILE_MANAGER,

FLYWHEEL_PRODUCT_DATA_SYNC,

FORECASTING,

FORM,

FORWARD_TO_CRM,

GMAIL_INTEGRATION,

GOALS,

HEISENBERG,

HELP_DESK,

HELP_DESK_AI,

IMPORT,

INTEGRATION,

INTEGRATIONS_PLATFORM,

INTEGRATIONS_SYNC,

INTENT,

INTERNAL_PROCESSING,

LEADIN,

LEGAL_BASIS_REMEDIATION,

MARKET_SOURCING,

MARKETPLACE,

MEETINGS,

MERGE_COMPANIES,

MERGE_CONTACTS,

MERGE_OBJECTS,

MERGE_REVERT_OBJECTS,

MICROAPPS,

MIGRATION,

MOBILE_ANDROID,

MOBILE_IOS,

PAYMENTS,

PIPELINE_SETTINGS,

PLAYBOOKS,

PORTAL_OBJECT_SYNC,

PORTAL_USER_ASSOCIATOR,

PRESENTATIONS,

PRIMARY_AUTOMATION,

PROPERTY_DEFAULT_VALUE,

PROPERTY_RESTORE,

PROPERTY_SETTINGS,

PROSPECTING_AGENT,

QUOTAS,

QUOTES,

RECYCLING_BIN,

RESTORE_OBJECTS,

SALES,

SALES_MESSAGES,

SALESFORCE,

SEQUENCES,

SETTINGS,

SIDEKICK,

SIGNALS,

SLACK_INTEGRATION,

SOCIAL,

SUCCESS,

TALLY,

TASK,

UNKNOWN,

WAL_INCREMENTAL,

WORK_UI,

WORKFLOW_CONTACT_DELETE_ACTION,

WORKFLOWS

customProperties.sourceId

string

required

Identificação da origem da propriedade

customProperties.sourceLabel

string

required

Rótulo da origem da propriedade

customProperties.sourceMetadata

string

required

Metadados de origem codificados como uma string base64

customProperties.sourceUpstreamDeployable

string

required

Indica qual serviço upstream fez a alteração da propriedade

customProperties.sourceVid

integer<int64>[]

required

The unique identifier associated with the source.

customProperties.timestamp

integer<int64>

required

A data/hora da solicitação

customProperties.unit

string

required

A unidade

customProperties.updatedByUserId

integer<int32>

required

O ID do usuário que atualizou a propriedade pela última vez

customProperties.useTimestampAsPersistenceTimestamp

boolean

required

Indica se a data/hora de persistência é a mesma que a data/hora da versão de armazenamento

customProperties.value

string

required

Valor da propriedade personalizada

eventName

string

required

O nome do evento de marketing.

eventOrganizer

string

required

O nome do organizador do evento de marketing.

externalAccountId

string

required

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

externalEventId

string

required

O ID do evento de marketing no aplicativo de eventos externos.

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.

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

customProperties

object[]

required

Mostrar atributos filhos

customProperties.dataSensitivity

enum<string>

required

Nível de sensibilidade dos dados

Opções disponíveis:

high,

none,

standard

customProperties.isEncrypted

boolean

required

Indica se a propriedade está criptografada

customProperties.isLargeValue

boolean

required

Indica se o valor da propriedade está armazenado como um valor grande no armazenamento

customProperties.name

string

required

Nome da propriedade personalizada

customProperties.persistenceTimestamp

integer<int64>

required

O registro de data e a hora que indica quando o valor que está sendo gravado é persistido no armazenamento

customProperties.requestId

string

required

O ID da solicitação

customProperties.selectedByUser

boolean

required

Indica se a propriedade está selecionada

customProperties.selectedByUserTimestamp

integer<int64>

required

A data e a hora em que a propriedade foi selecionada pelo usuário

customProperties.source

enum<string>

required

Origem da propriedade

Opções disponíveis:

ACADEMY,

ACCEPTANCE_TEST,

ACTIVITY_AUTO_ASSOCIATE,

ADS,

AI_GROUP,

ANALYTICS,

API,

APPROVALS,

ASSISTS,

ASSOCIATIONS,

AUTO_ASSOCIATE_BY_DOMAIN,

AUTOMATION_JOURNEY,

AUTOMATION_PLATFORM,

AVATARS_SERVICE,

BATCH_UPDATE,

BCC_TO_CRM,

BEHAVIORAL_EVENTS,

BET_ASSIGNMENT,

BET_CRM_CONNECTOR,

BIDEN,

BILLING,

BOT,

CALCULATED,

CENTRAL_EXCHANGE_RATES,

CHATSPOT,

CLONE_OBJECTS,

COMMUNICATOR,

COMPANIES,

COMPANY_FAMILIES,

COMPANY_INSIGHTS,

CONTACTS,

CONTACTS_WEB,

CONTENT_MEMBERSHIP,

CONVERSATIONAL_ENRICHMENT,

CONVERSATIONS,

CRM_PROCESSES_PLATFORM,

CRM_UI,

CRM_UI_BULK_ACTION,

CUSTOMER_AGENT,

DATA_ENRICHMENT,

DATASET,

DEALS,

DEFAULT,

DELETE_OBJECTS,

EMAIL,

EMAIL_INBOX_IMPORT,

EMAIL_INTEGRATION,

ENGAGEMENTS,

EXTENSION,

FILE_MANAGER,

FLYWHEEL_PRODUCT_DATA_SYNC,

FORECASTING,

FORM,

FORWARD_TO_CRM,

GMAIL_INTEGRATION,

GOALS,

HEISENBERG,

HELP_DESK,

HELP_DESK_AI,

IMPORT,

INTEGRATION,

INTEGRATIONS_PLATFORM,

INTEGRATIONS_SYNC,

INTENT,

INTERNAL_PROCESSING,

LEADIN,

LEGAL_BASIS_REMEDIATION,

MARKET_SOURCING,

MARKETPLACE,

MEETINGS,

MERGE_COMPANIES,

MERGE_CONTACTS,

MERGE_OBJECTS,

MERGE_REVERT_OBJECTS,

MICROAPPS,

MIGRATION,

MOBILE_ANDROID,

MOBILE_IOS,

PAYMENTS,

PIPELINE_SETTINGS,

PLAYBOOKS,

PORTAL_OBJECT_SYNC,

PORTAL_USER_ASSOCIATOR,

PRESENTATIONS,

PRIMARY_AUTOMATION,

PROPERTY_DEFAULT_VALUE,

PROPERTY_RESTORE,

PROPERTY_SETTINGS,

PROSPECTING_AGENT,

QUOTAS,

QUOTES,

RECYCLING_BIN,

RESTORE_OBJECTS,

SALES,

SALES_MESSAGES,

SALESFORCE,

SEQUENCES,

SETTINGS,

SIDEKICK,

SIGNALS,

SLACK_INTEGRATION,

SOCIAL,

SUCCESS,

TALLY,

TASK,

UNKNOWN,

WAL_INCREMENTAL,

WORK_UI,

WORKFLOW_CONTACT_DELETE_ACTION,

WORKFLOWS

customProperties.sourceId

string

required

Identificação da origem da propriedade

customProperties.sourceLabel

string

required

Rótulo da origem da propriedade

customProperties.sourceMetadata

string

required

Metadados de origem codificados como uma string base64

customProperties.sourceUpstreamDeployable

string

required

Indica qual serviço upstream fez a alteração da propriedade

customProperties.sourceVid

integer<int64>[]

required

The unique identifier associated with the source.

customProperties.timestamp

integer<int64>

required

A data/hora da solicitação

customProperties.unit

string

required

A unidade

customProperties.updatedByUserId

integer<int32>

required

O ID do usuário que atualizou a propriedade pela última vez

customProperties.useTimestampAsPersistenceTimestamp

boolean

required

Indica se a data/hora de persistência é a mesma que a data/hora da versão de armazenamento

customProperties.value

string

required

Valor da propriedade personalizada

eventName

string

required

O nome do evento de marketing.

eventOrganizer

string

required

O nome do organizador 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

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

E-mail transacional

Preferências de assinatura v3

Preferências de assinatura v4

E-mails de marketing

Eventos de marketing

Envio único

Campanhas

Formulários

Reuniões

Criar um evento de marketing

Authorizations

Body

Response