Zum Hauptinhalt springen
POST
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
/
cancel
マーケティングイベントをキャンセル済みにする
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>"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
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

外部イベントアプリケーションのマーケティングイベントのID

Query Parameters

externalAccountId
string
required

外部イベントアプリケーションでこのマーケティングイベントに関連付けられているaccountId

Response

successful operation

eventOrganizer
string
required

マーケティングイベントの主催者の名前。

eventName
string
required

マーケティングイベントの名前。

startDateTime
string<date-time>

マーケティングイベントの開始日時。

customProperties
object[]

PropertyValuesのリスト。任意のプロパティーの名前と値を指定できます。ただし、HubSpotアカウントのMarketingEventオブジェクトの定義に存在している必要があります。存在していない場合、除外されて、設定されません。 存在させるには、特定のアプリについてHubSpotアカウントのMarketingEventオブジェクトでPropertyGroupを新規作成し、そのHubSpotアカウントで追跡するカスタムプロパティーを作成する必要があります。MarketingEventで既定のプロパティーを新規作成すると全てのHubSpotアカウントに適用されることになるため、作成しないでください。

eventCancelled
boolean

マーケティングイベントがキャンセルされたかどうかを示します。

eventUrl
string

マーケティングイベントを管理できる外部イベントアプリケーションのURL。

eventDescription
string

マーケティングイベントの説明。

eventType
string

マーケティングイベントのタイプ。

eventCompleted
boolean
endDateTime
string<date-time>

マーケティングイベントの終了日時。

objectId
string
I