E-mail transacional
Preferências de assinatura v3
Preferências de assinatura v4
E-mails de marketing
Eventos de marketing
Campanhas
Formulários
Reuniões
curl --request POST \
--url https://api.hubapi.com/marketing/v3/marketing-events/events/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"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>",
"externalAccountId": "<string>",
"externalEventId": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": true,
"eventCompleted": true,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"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"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}Criar ou atualizar vários eventos de marketing
Insere ou atualiza vários Eventos de marketing. Se um Evento de marketing com o ID especificado já existir, ele será atualizado; caso contrário, um novo evento será criado.
Somente Eventos de marketing originalmente criados pelo mesmo aplicativo podem ser atualizados.
curl --request POST \
--url https://api.hubapi.com/marketing/v3/marketing-events/events/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"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>",
"externalAccountId": "<string>",
"externalEventId": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": true,
"eventCompleted": true,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"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"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}Produtos suportados
Produtos suportados
Marketing Hub -Grátis
Sales Hub -Grátis
Service Hub -Grátis
Content Hub -GrátisEscopos Necessários
Escopos Necessários
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Mostrar atributos filhos
Mostrar atributos filhos
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
Mostrar atributos filhos
Nível de sensibilidade dos dados
high, none, standard Indica se a propriedade está criptografada
Indica se o valor da propriedade está armazenado como um valor grande no armazenamento
Nome da propriedade personalizada
O registro de data e a hora que indica quando o valor que está sendo gravado é persistido no armazenamento
O ID da solicitação
Indica se a propriedade está selecionada
A data e a hora em que a propriedade foi selecionada pelo usuário
Origem da propriedade
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 Identificação da origem da propriedade
Rótulo da origem da propriedade
Metadados de origem codificados como uma string base64
Indica qual serviço upstream fez a alteração da propriedade
The unique identifier associated with the source.
A data e hora da solicitação
A unidade
O ID do usuário que atualizou a propriedade pela última vez
Indica se a data/hora de persistência é a mesma que a data/hora da versão de armazenamento
Valor da propriedade personalizada
O nome do evento de marketing.
O nome do organizador do evento de marketing.
O accountId que está associado a este evento de marketing no aplicativo de eventos externos.
O ID do evento de marketing no aplicativo de eventos externos.
A data e hora de término do evento de marketing.
Indica se o evento de marketing foi cancelado. O padrão é "false"
Indica se o evento de marketing foi concluído. O valor padrão é "false".
A descrição do evento de marketing.
Descreve o tipo de evento. Por exemplo: "WEBINAR", "CONFERENCE", "WORKSHOP"
Um URL no aplicativo de eventos externos onde o evento de marketing pode ser gerenciado.
A data e hora de início do evento de marketing.
Response
successful operation
A data e a hora de conclusão da solicitação.
Mostrar atributos filhos
Mostrar atributos filhos
A data e hora de criação do evento de marketing.
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
Mostrar atributos filhos
Nível de sensibilidade dos dados
high, none, standard Indica se a propriedade está criptografada
Indica se o valor da propriedade está armazenado como um valor grande no armazenamento
Nome da propriedade personalizada
O registro de data e a hora que indica quando o valor que está sendo gravado é persistido no armazenamento
O ID da solicitação
Indica se a propriedade está selecionada
A data e a hora em que a propriedade foi selecionada pelo usuário
Origem da propriedade
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 Identificação da origem da propriedade
Rótulo da origem da propriedade
Metadados de origem codificados como uma string base64
Indica qual serviço upstream fez a alteração da propriedade
The unique identifier associated with the source.
A data e hora da solicitação
A unidade
O ID do usuário que atualizou a propriedade pela última vez
Indica se a data/hora de persistência é a mesma que a data/hora da versão de armazenamento
Valor da propriedade personalizada
O nome do evento de marketing.
O nome do organizador do evento de marketing.
O ID do objeto do CRM do evento de marketing.
A data e hora da atualização do evento de marketing.
A data e hora de término do evento de marketing.
Indica se o evento de marketing foi cancelado.
Indica se o evento de marketing foi concluído.
A descrição do evento de marketing.
O tipo do evento de marketing.
Um URL no aplicativo de eventos externos onde o evento de marketing pode ser gerenciado.
O ID do objeto do CRM do evento de marketing.
A data e hora de início do evento de marketing.
O registro da data e a hora do início do processamento da solicitação.
O status da resposta.
CANCELED, COMPLETE, PENDING, PROCESSING Mostrar atributos filhos
Mostrar atributos filhos
A categoria do erro
The detailed error objects.
Mostrar atributos filhos
Mostrar atributos filhos
Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado
O código de status associado ao detalhe do erro
O nome do campo ou parâmetro no qual o erro foi encontrado.
Uma categoria específica que contém mais detalhes específicos sobre o erro
A mensagem de erro
Status da resposta
O ID da solicitação
A subcategoria do erro
O número de erros que ocorreram durante a solicitação.
A data e a hora do envio da solicitação.