Update an event property

Eigenschaft aktualisieren

curl --request PATCH \
  --url https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "displayOrder": 123,
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

payload = {
    "description": "<string>",
    "displayOrder": 123,
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    displayOrder: 123,
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'displayOrder' => 123,
    'hidden' => true,
    'label' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "currencyPropertyName": "<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
  },
  "numberDisplayHint": "currency",
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

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

PATCH

events

2026-09

event-definitions

{eventName}

property

{propertyName}

Eigenschaft aktualisieren

curl --request PATCH \
  --url https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "displayOrder": 123,
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

payload = {
    "description": "<string>",
    "displayOrder": 123,
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    displayOrder: 123,
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ]
  })
};

fetch('https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'displayOrder' => 123,
    'hidden' => true,
    'label' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "currencyPropertyName": "<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
  },
  "numberDisplayHint": "currency",
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

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

Required Scopes

Autorisierungen

Authorization

string

header

erforderlich

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

FlowAuthorization Code

Authorization URL: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token

Scopes1

behavioral_events.event_definitions.read_write

Pfadparameter

eventName

string

erforderlich

Die eindeutige ID des Events, dessen Eigenschaft Sie aktualisieren möchten.

propertyName

string

erforderlich

Der Name der Eigenschaft, die innerhalb des angegebenen Events aktualisiert werden soll.

Body

application/json

description

string

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

displayOrder

integer<int32>

Für nicht ausgeblendete Eigenschaften gibt dies die Reihenfolge an, in der die Eigenschaft in der Aktivitätenchronik des Datensatzes angezeigt werden soll (z. B. displayOrder: 0 ist ganz oben).

hidden

boolean

Steuert, ob diese Eigenschaft in der Aktivitätenchronik des Datensatzes 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.

Show child attributes

Antwort

successful operation

A HubSpot property

description

string

erforderlich

Eine Beschreibung der Eigenschaft.

fieldType

string

erforderlich

Der Feldtyp der Eigenschaft.

groupName

string

erforderlich

Der Name der Gruppe, zu der diese Eigenschaft gehört.

label

string

erforderlich

Das Anzeigelabel für die Eigenschaft.

name

string

erforderlich

Der eindeutige Name der Eigenschaft.

options

object[]

erforderlich

Ein Array von Optionen, die für diese Eigenschaft verfügbar sind. Anwendbar, wenn die Eigenschaft mehrere Werte unterstützt.

Show child attributes

type

string

erforderlich

Der Datentyp der Eigenschaft.

archived

boolean

Gibt an, ob die Eigenschaft archiviert ist.

archivedAt

string<date-time>

Der Zeitpunkt (Datum und Uhrzeit) der Archivierung dieser Eigenschaft im ISO-8601-Format.

calculated

boolean

Gibt an, ob die Eigenschaft berechnet wird.

calculationFormula

string

Die Formel zur Berechnung des Eigenschaftswerts, falls zutreffend.

createdAt

string<date-time>

Der Zeitpunkt (Datum und Uhrzeit) der Erstellung dieser Eigenschaft im ISO-8601-Format.

createdUserId

string

Die ID des Benutzers, der diese Eigenschaft erstellt hat.

currencyPropertyName

string

Der Name der Währungseigenschaft, die dieser Eigenschaft zugeordnet ist.

dataSensitivity

enum<string>

Die Vertraulichkeitsstufe der Daten, mit gültigen Werten wie „non_sensitive“, „sensitive“ und „highly_sensitive“.

Verfügbare Optionen:

highly_sensitive,

non_sensitive,

sensitive

dateDisplayHint

enum<string>

Ein Hinweis zur Anzeige von Datumseigenschaften, mit gültigen Werten wie „absolute“, „absolute_with_relative“, „time_since“ und „time_until“.

Verfügbare Optionen:

absolute,

absolute_with_relative,

time_since,

time_until

displayOrder

integer<int32>

Die Reihenfolge, in der diese Eigenschaft im Verhältnis zu anderen Eigenschaften angezeigt wird.

externalOptions

boolean

Gibt an, ob die Eigenschaftsoptionen extern sind.

formField

boolean

Gibt an, ob die Eigenschaft ein Formularfeld ist.

hasUniqueValue

boolean

Gibt an, ob die Eigenschaft einen eindeutigen Wert hat.

hidden

boolean

Gibt an, ob die Eigenschaft ausgeblendet ist.

Beispiel:

false

hubspotDefined

boolean

Gibt an, ob die Eigenschaft von HubSpot definiert wird.

modificationMetadata

object

Show child attributes

numberDisplayHint

enum<string>

Ein Hinweis zur Anzeige von Zahleneigenschaften, mit gültigen Werten wie „unformatted“, „formatted“, „currency“, „percentage“, „duration“ und „probability“.

Verfügbare Optionen:

currency,

duration,

formatted,

percentage,

probability,

unformatted

referencedObjectType

string

Der Objekttyp, auf den diese Eigenschaft verweist.

sensitiveDataCategories

string[]

Ein Array von Kategorien, die die Sensibilität der Daten angeben.

showCurrencySymbol

boolean

Gibt an, ob ein Währungssymbol für die Eigenschaft angezeigt wird.

textDisplayHint

enum<string>

Ein Hinweis zur Anzeige von Texteigenschaften, mit gültigen Werten wie „unformatted_single_line“, „multi_line“, „email“, „phone_number“, „domain_name“, „ip_address“, „physical_address“ und „postal_code“.

Verfügbare Optionen:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

updatedAt

string<date-time>

Der Zeitpunkt (Datum und Uhrzeit) der letzten Aktualisierung dieser Eigenschaften im ISO-8601-Format.

updatedUserId

string

Die ID des Benutzers, der diese Eigenschaft zuletzt aktualisiert hat.

Zuletzt geändert am 24. September 2026

Account & Einstellungen

App-Verwaltung

Authentifizierung

Automatisierung

CMS

Kommunikationseinstellungen

Konversationen

CRM

Data Studio

Veranstaltungen

Dateien

Marketing

Meetings

Umsatz

Webhooks

Webhook-Journal

Update an event property

Autorisierungen

Pfadparameter

Body

Antwort