PATCH
/
events
/
v3
/
event-definitions
/
{eventName}
/
property
/
{propertyName}
既存のカスタムイベントプロパティーを更新
curl --request PATCH \
  --url https://api.hubapi.com/events/v3/event-definitions/{eventName}/property/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "options": [
    {
      "hidden": true,
      "displayOrder": 123,
      "description": "<string>",
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "description": "<string>",
  "label": "<string>"
}'
{
  "hidden": false,
  "displayOrder": 123,
  "description": "",
  "showCurrencySymbol": false,
  "type": "",
  "hubspotDefined": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": false,
  "options": "",
  "hasUniqueValue": false,
  "calculated": false,
  "externalOptions": false,
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdUserId": "",
  "modificationMetadata": {
    "readOnlyOptions": true,
    "readOnlyValue": true,
    "readOnlyDefinition": true,
    "archivable": true
  },
  "sensitiveDataCategories": "",
  "label": "",
  "formField": false,
  "dataSensitivity": "",
  "archivedAt": "2023-11-07T05:31:56Z",
  "groupName": "",
  "referencedObjectType": "",
  "name": "",
  "calculationFormula": "",
  "fieldType": "",
  "updatedUserId": "<string>"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

必須スコープ

この API には、次のいずれかのスコープが必要です。
  • behavioral_events.event_definitions.read_write

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

eventName
string
required

カスタムイベントの内部名。

propertyName
string
required

更新するプロパティーの内部名。

Body

application/json

Response

201
application/json

successful operation

A HubSpot property