Record a subscriber state by contact ID

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"
  }
}

POST

marketing

marketing-events

events

{externalEventId}

{subscriberState}

upsert

Record a subscriber state by contact ID

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"
  }
}

Supported products

Requires one of the following products or higher.

Marketing Hub -Free

Sales Hub -Free

Service Hub -Free

Content Hub -Starter

Required Scopes

This API requires one of the following scopes:

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

The id of the marketing event in the external event application

subscriberState

string

required

The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.

Query Parameters

externalAccountId

string

required

The accountId that is associated with this marketing event in the external event application

Body

application/json

inputs

object[]

required

List of HubSpot contacts to subscribe to the marketing event

Show child attributes

Response

default - */*

An error occurred.

correlationId

string<uuid>

required

A unique identifier for the request. Include this value with any error reports or support tickets

Example:

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

message

string

required

A human readable message describing the error along with remediation steps where appropriate

Example:

"An error occurred"