Skip to main content
POST
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
/
cancel
Mark a marketing event as cancelled
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "startDateTime": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "sourceId": "",
      "selectedByUser": false,
      "sourceLabel": "",
      "sourceUpstreamDeployable": "<string>",
      "source": "",
      "updatedByUserId": 123,
      "persistenceTimestamp": 123,
      "sourceMetadata": "",
      "dataSensitivity": "",
      "sourceVid": "",
      "unit": "",
      "requestId": "",
      "isEncrypted": false,
      "name": "",
      "useTimestampAsPersistenceTimestamp": true,
      "value": "",
      "selectedByUserTimestamp": 123,
      "timestamp": 123,
      "isLargeValue": true
    }
  ],
  "eventCancelled": true,
  "eventOrganizer": "<string>",
  "eventUrl": "<string>",
  "eventDescription": "<string>",
  "eventName": "<string>",
  "eventType": "<string>",
  "eventCompleted": true,
  "endDateTime": "2023-11-07T05:31:56Z",
  "objectId": "<string>"
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Starter
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

Query Parameters

​
externalAccountId
string
required

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

Response

successful operation

​
customProperties
object[]
required

A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set. In order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.

​
eventOrganizer
string
required

The name of the organizer of the marketing event.

​
eventName
string
required

The name of the marketing event.

​
startDateTime
string<date-time>

The start date and time of the marketing event.

​
eventCancelled
boolean

Indicates if the marketing event has been cancelled.

​
eventUrl
string

The URL in the external event application where the marketing event can be managed.

​
eventDescription
string

The description of the marketing event.

​
eventType
string

The type of the marketing event.

​
eventCompleted
boolean
​
endDateTime
string<date-time>

The end date and time of the marketing event.

​
objectId
string