Zum Hauptinhalt springen
PATCH
/
events
/
v3
/
event-definitions
/
{eventName}
/
property
/
{propertyName}
Eine Eigenschaft eines vorhandenen benutzerdefinierten Events aktualisieren
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 '
{
  "description": "<string>",
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}
'
{
  "description": "<string>",
  "fieldType": "<string>",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>",
      "displayOrder": 123
    }
  ],
  "type": "<string>",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "calculated": true,
  "calculationFormula": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdUserId": "<string>",
  "dataSensitivity": "highly_sensitive",
  "dateDisplayHint": "absolute",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": true,
    "readOnlyValue": true,
    "readOnlyOptions": true
  },
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise

Autorisierungen

​
Authorization
string
header
erforderlich

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

Pfadparameter

​
eventName
string
erforderlich

Der interne Name des benutzerdefinierten Events.

​
propertyName
string
erforderlich

Der interne Name der zu aktualisierenden Eigenschaft.

Body

application/json
​
description
string

Eine Beschreibung der Eigenschaft, die in HubSpot als Hilfetext angezeigt wird.

​
label
string

Für Menschen lesbares Label für die Eigenschaft. Wird in HubSpot-UI verwendet.

​
options
object[]

Eine Liste der verfügbaren Optionen für die Eigenschaft, wenn es sich um eine Aufzählung handelt. HINWEIS: Dieses Feld gilt nur für Aufzählungseigenschaften.

Antwort

successful operation

HubSpot-Eigenschaft

​
description
string
erforderlich

Eine Übersicht über den Zweck der Eigenschaft.

​
fieldType
string
erforderlich

Legt fest, wie die Eigenschaft in der HubSpot-UI oder in einem Formular angezeigt wird. Weitere Informationen in der Anleitung zur Eigenschaften-API.

​
groupName
string
erforderlich

Der Name der Gruppe, der die Eigenschaft zugeordnet ist.

​
label
string
erforderlich

Das Anzeigelabel für die Eigenschaft.

​
name
string
erforderlich

Der interne Name der Eigenschaft.

​
options
object[]
erforderlich

Eine Liste der gültigen Optionen für die Eigenschaft. Pflichtfeld bei Aufzählungseigenschaften.

​
type
string
erforderlich

Der Datentyp der Eigenschaft, z. B. Zeichenfolge oder Zahl.

​
archived
boolean

Ob die Eigenschaft archiviert ist.

​
archivedAt
string<date-time>

Der Zeitstempel, wann die Eigenschaft archiviert wurde (Format ISO 8601).

​
calculated
boolean

Ob es sich bei der Eigenschaft um ein berechnetes Feld handelt.

​
calculationFormula
string

Die Formel, die für berechnete Eigenschaften verwendet wird.

​
createdAt
string<date-time>

Der Zeitstempel, wann die Eigenschaft erstellt wurde (Format ISO 8601).

​
createdUserId
string

Die ID des Benutzers, der die Eigenschaft erstellt hat.

​
dataSensitivity
enum<string>

Gibt die Vertraulichkeitsstufe der Eigenschaft an, z. B. „non_sensitive“, „sensitive“ oder „highly_sensitive“.

Verfügbare Optionen:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>
Verfügbare Optionen:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

Die Position des Elements in Bezug auf andere Elemente der Liste.

​
externalOptions
boolean

Gilt nur für Eigenschaften vom Typ „Aufzählung“. Muss in Verbindung mit einem „referencedObjectType“ von „OWNER“ auf „true“ (wahr) festgelegt werden. Ist andernfalls „false“ (falsch).

​
formField
boolean

Ob die Eigenschaft in Formularen verwendet werden kann.

​
hasUniqueValue
boolean

Ob es sich bei der Eigenschaft um eine „Eindeutige ID“-Eigenschaft handelt.

​
hidden
boolean

Ob die Eigenschaft aus der HubSpot-UI ausgeblendet wird oder nicht. Empfohlen wird, diese Option bei benutzerdefinierten Eigenschaften auf „false“ (falsch) zu setzen.

Beispiel:

false

​
hubspotDefined
boolean

Ein boolescher Wert, der für Standardeigenschaften von HubSpot auf „true“ (wahr) festgelegt ist.

​
modificationMetadata
object
​
referencedObjectType
string

Veraltet. Verwenden Sie stattdessen „externalOptionsReferenceType“.

​
sensitiveDataCategories
string[]

Führt den in der Eigenschaft enthaltenen Typ vertraulicher Daten (z. B. „HIPAA“) auf, wenn „sensitiveData“ auf „true“ (wahr) festgelegt ist.

​
showCurrencySymbol
boolean

Ob das Währungssymbol in der HubSpot-UI anzeigt wird.

​
updatedAt
string<date-time>

Der Zeitstempel, wann die Eigenschaft zuletzt aktualisiert wurde (Format ISO 8601).

​
updatedUserId
string
Last modified on March 24, 2026