Zum Hauptinhalt springen
POST
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
/
{subscriberState}
/
upsert
Registrar um estado de assinante pelo ID de contato
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": [
    {
      "vid": 123,
      "properties": {},
      "interactionDateTime": 123
    }
  ]
}'
{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

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 -Starter
Esta API requer um dos seguintes escopos:
crm.objects.marketing_events.write

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

subscriberState
string
required

O novo estado do assinante para os contatos do HubSpot e o evento de marketing especificado. Por exemplo: "register", "attend" ou "cancel".

Query Parameters

externalAccountId
string
required

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

Body

application/json
inputs
object[]
required

Lista de contatos do HubSpot para inscrever no evento de marketing

Response

default - */*

An error occurred.

correlationId
string<uuid>
required

Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte

Example:

"aeb5f871-7f07-4993-9211-075dc63e7cbf"

message
string
required

Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado

Example:

"Invalid input (details will vary based on the error)"

category
string
required

A categoria de erro

Example:

"VALIDATION_ERROR"

subCategory
string

Uma categoria específica que contém mais detalhes específicos sobre o erro

context
object

Contexto sobre a condição do erro

Example:

"{\"missingScopes\":[\"scope1\",\"scope2\"],\"invalidPropertyName\":[\"propertyValue\"]}"

Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou etapas de correção recomendadas

Example:

"{\"knowledge-base\":\"https://www.hubspot.com/products/service/knowledge-base\"}"

errors
object[]

mais informações sobre o erro

I