Letzte Änderung: 22. August 2025

Run in Postman

Verwenden Sie Eigenschaften, um Informationen in CRM-Datensätzen zu speichern. HubSpot bietet eine Reihe von Standardeigenschaften für jedes CRM-Objekt. Außerdem können Sie Ihre eigenen benutzerdefinierten Eigenschaften entweder in HubSpot oder mit der Eigenschaften-API erstellen und verwalten. Beim Erstellen von Eigenschaften sollte die Architektur Ihrer gut überlegt sein. In vielen Fällen ist das Erstellen benutzerdefinierter Eigenschaften für Standardobjekte von HubSpot die richtige Vorgehensweise. Es kann jedoch vorkommen, dass Sie ein separates benutzerdefiniertes Objekt mit seinem eigenen Satz an Eigenschaften erstellen müssen.

Standardeigenschaften

CRM-Objekte werden durch einen primären type und einen Satz von properties definiert. Jeder Typ verfügt über einen eindeutigen Satz an Standardeinstellungen, die von einer Zuordnung von Name/Wert-Paaren dargestellt werden. Erfahren Sie mehr über Standardeigenschaften für verschiedene Objekte:

Eigenschaftsgruppen

Gruppen von Eigenschaften werden verwendet, um zugehörige Eigenschaften zu gruppieren. Gruppierte Eigenschaften werden nebeneinander in HubSpot-Datensätzen angezeigt. Wenn Ihre Integration beliebige benutzerdefinierte Objekteigenschaften erstellt, erleichtert eine benutzerdefinierte Eigenschaftsgruppe das Identifizieren dieser Daten.

Eigenschaftstyp und fieldType-Werte

Beim Erstellen oder Aktualisieren von Eigenschaften sind sowohl der type-Wert als auch der fieldType-Wert erforderlich. Der type-Wert bestimmt den Typ der Eigenschaft, d. h. eine Zeichenfolge oder eine Zahl. Die fieldType-Eigenschaft bestimmt, wie die Eigenschaft in HubSpot oder in einem Formular angezeigt wird, also als Klartext, als ein Dropdown-Menü oder als eine Datumsauswahl. Erfahren Sie in der folgenden Tabelle mehr über die verfügbaren type-Werte für Eigenschaften und die entsprechenden fieldType-Werte.
typeBeschreibungZulässige fieldType-Werte
boolEin Feld mit binären Optionen (z. B. Yes oder No, True oder False).booleancheckbox, calculation_equation
enumerationEine Zeichenfolge, die eine Reihe von Optionen enthält, die durch ein Semikolon getrennt sind.booleancheckbox, checkbox, radio, select, calculation_equation
dateEin Wert, der einen bestimmten Tag, einen bestimmten Monat und ein bestimmtes Jahr darstellt. Werte müssen in UTC-Zeit angegeben werden und können als ISO 8601-Zeichenfolgen oder EPOCH-Zeitstempel in Millisekunden (z. B. Mitternacht UTC) formatiert werden.date
datetimeEin Wert, der einen bestimmten Tag, einen bestimmten Monat, ein bestimmtes Jahr und eine bestimmte Uhrzeit darstellt. Werte müssen in UTC-Zeit angegeben werden und können als ISO 8601-Zeichenfolgen oder UNIX-Zeitstempel in Millisekunden formatiert werden.date
stringEine Klartext-Zeichenfolge, die auf 65.536 Zeichen begrenzt ist.file, text, textarea, calculation_equation, html, phonenumber
numberEin Zahlenwert mit numerischen Ziffern und höchstens einer Dezimalstelle.number, calculation_equation
object_coordinatesEin Textwert, der zum Verweisen auf andere HubSpot-Objekte verwendet wird und nur für interne Eigenschaften verwendet wird. Eigenschaften dieses Typs können nicht erstellt oder bearbeitet werden und sind in HubSpot nicht sichtbar.text
jsonEin Textwert, der als formatiertes json gespeichert ist und nur für interne Eigenschaften verwendet wird. Eigenschaften dieses Typs können nicht erstellt oder bearbeitet werden und sind in HubSpot nicht sichtbar.text
Zulässige Werte für fieldType sind:
FeldtypBeschreibung
booleancheckboxEine Eingabe, die es Benutzern ermöglicht, entweder „Ja“ oder „Nein“ auszuwählen. Bei Verwendung in einem Formular wird sie als einzelnes Kontrollkästchen angezeigt. Erfahren Sie, wie Sie einen Wert zu Eigenschaften mit einem einzelnen Kontrollkästchen hinzufügen.
calculation_equationEine benutzerdefinierte Gleichung, die Werte basierend auf anderen Eigenschaftswerten und/oder Zuordnungen berechnen kann. Erfahren Sie, wie Sie berechnete Eigenschaften definieren.
checkboxEine Liste der Kontrollkästchen, anhand derer ein Benutzer mehrere Optionen aus einer Reihe von Optionen auswählen kann, die für die Eigenschaft zulässig sind. Erfahren Sie, wie Sie Werte beim Aktualisieren von Eigenschaften mit mehreren Kontrollkästchen formatieren.
dateEin Datumswert, der als Datumsauswahl angezeigt wird.
fileErmöglicht das Hochladen einer Datei in einen Datensatz oder über ein Formular. Speichert eine Datei-ID.
htmlEine Zeichenfolge, die als bereinigter HTML-Code gerendert wird und die Verwendung eines Rich-Text-Editors für die Eigenschaft ermöglicht.
numberEine Ziffernfolge oder Zahlen in Dezimalschreibweise oder in wissenschaftlicher Notation.
phonenumberEine Klartext-Zeichenfolge, die als eine formatierte Telefonnummer angezeigt wird.
radioEine Eingabe, die es Benutzern ermöglicht, eine Option aus einer Reihe von Optionen auszuwählen, die für die Eigenschaft zulässig sind. Bei Verwendung in einem Formular wird dies als eine Reihe von Optionsfeldern angezeigt.
selectEine Dropdown-Eingabe, die es Benutzern ermöglicht, eine Option aus einer Reihe von Optionen auszuwählen, die für die Eigenschaft zulässig sind.
textEine Klartext-Zeichenfolge, die als eine einzeilige Texteingabe angezeigt wird.
textareaEine Klartext-Zeichenfolge, die als eine mehrzeilige Texteingabe angezeigt wird.

Eine Eigenschaft erstellen

Um eine Eigenschaft zur erstellen, führen Sie einePOST-Anfrage an /crm/v3/properties/{objectType} durch. Geben Sie in Ihrem Anfragetext die folgenden Pflichtfelder an:
  • groupName: die Eigenschaftsgruppe, in der sich die Eigenschaft befinden wird.
  • name: der interne Name der Eigenschaft (z. B. favorite_food).
  • label: der Name der Eigenschaft, wie er in HubSpot angezeigt wird (z. B. Favorite Food).
  • type: der Typ der Eigenschaft.
  • fieldType: der Feldtyp der Eigenschaft.
Um beispielsweise eine Kontakteigenschaft mit dem Namen Favorite Food zu erstellen, würde Ihre Anfrage wie folgt aussehen:
{
"groupName": "contactinformation",
"name": "favorite_food",
"label": "Favorite Food",
"type": "string",
"fieldType": "text"
}

„Eindeutige ID“-Eigenschaften erstellen

Wenn ein Datensatz in HubSpot erstellt wird, wird automatisch eine eindeutige ID (hs_object_id) generiert, die als Zeichenfolge behandelt werden sollte. Diese IDs sind nur innerhalb dieses Objekttyps eindeutig. Daher kann es sowohl einen Kontakt als auch ein Unternehmen mit derselben ID geben. Für Kontakte und Unternehmen gibt es zusätzliche eindeutige IDs, einschließlich der E-Mail-Adresse (email) eines Kontakts und des Domain-Namens (domain) eines Unternehmens. In einigen Fällen möchten Sie möglicherweise Ihre eigene „Eindeutige ID“-Eigenschaft erstellen, damit Sie nicht den gleichen Wert für mehrere Datensätze eingeben können. Sie können über bis zu zehn eindeutige ID-Eigenschaften pro Objekt verfügen. So erstellen Sie eine Eigenschaft, die eindeutige Werte über die API erfordert:
  • Führen Sie eine POST-Anfrage an /crm/v3/properties/{objectType} durch.
  • Legen Sie in Ihrem Anforderungstext für das hasUniqueValue-Feld den Wert auf true fest.
{
"groupName": "dealinformation",
"name": "system_a_unique",
"label": "Unique ID for System A",
"hasUniqueValue": true,
"type": "string",
"fieldType": "text"
}
Nachdem Sie Ihr Feld für die „Eindeutige ID“-Eigenschaft erstellt haben, können Sie sie in einem API-Aufruf verwenden, um spezifische Datensätze abzurufen. Um beispielsweise einen Deal mit einem Wert von abc für die system_a_unique-Eigenschaft abzurufen, wäre Ihre Anfrage-URL /crm/v3/objects/deals/abc?idProperty=system_a_unique. Sie können dann diesen „Eindeutige ID“-Eigenschaftswert verwenden, um bestimmte Datensätze auf die gleiche Weise zu identifizieren und zu aktualisieren, wie Sie hs_object_id, email (Kontakte) oder domain (Unternehmen) verwenden könnten.

Berechnungseigenschaften erstellen

Berechnungseigenschaften definieren einen Eigenschaftswert basierend auf anderen Eigenschaften innerhalb desselben Objektdatensatzes. Sie werden mithilfe einer Formel definiert, die Operationen wie min, max, count, sum oder average umfassen kann. Sie können die Eigenschaften-API verwenden, um berechnete Eigenschaften in Ihrem HubSpot-Account zu lesen oder zu erstellen, indem Sie einen Feldtyp calculation_equation und einen Typ von number, bool, string oder enumeration verwenden. Sie können die Berechnungsformel der Eigenschaft mit dem calculationFormula-Feld definieren.

Hinweis:

Berechnungseigenschafte, die über die API erstellt wurden, können in HubSpot nicht bearbeitet werden. Sie können diese Eigenschaften nur über die Eigenschaften-API bearbeiten.

Berechnungseigenschaftensyntax

Mithilfe von calculationFormula können Sie Ihre Formel mit arithmetischen Operatoren, Vergleichsoperatoren, logischen Operatoren, bedingten Anweisungen und anderen Funktionen schreiben.

Literalsyntax

  • Zeichenfolgenliteral: Konstante Zeichenfolgen können entweder mit einfachen Anführungszeichen ('constant') oder doppelten Anführungszeichen ("constant") dargestellt werden.
  • Zahlliteral: Konstante Zahlen können beliebige reelle Zahlen sein und Punktnotation enthalten. 1005 und 1.5589 sind beide gültige konstante Zahlen.
  • Boolesches Literal: Konstante boolesche Werte können true oder false sein.

Eigenschaftssyntax

  • Zeichenfolgeneigenschaftsvariablen: Damit eine Bezeichnerzeichenfolge als Zeichenfolgeneigenschaft interpretiert werden kann, muss sie in die string-Funktion gehüllt sein. Beispielsweise wird string(var1) als Wert für die Zeichenfolgeneigenschaft var1 interpretiert.
  • Zahleneigenschaftsvariablen: Alle Bezeichner werden als Zahleneigenschaftsvariablen interpretiert. Beispielsweise wird var1 als Wert für die Zahleneigenschaft var1 interpretiert.
  • Boolesche Eigenschaftsvariablen: Damit ein Bezeichner als boolesche Eigenschaft interpretiert werden kann, muss er in die bool-Funktion gehüllt sein. Zum Beispiel wird der Bezeichner bool(var1) als Wert für die boolesche Eigenschaft var1 interpretiert.

Hinweis:

Die verwendete Sprache unterscheidet zwischen Groß- und Kleinschreibung für alle Typen außer Zeichenfolgen. Zum Beispiel, wenn If A ThEn B genau das gleiche ist wie if a then b, aber 'a' nicht das gleiche wie 'A' ist. Leerzeichen, Tabulatoren und neue Zeilen werden für die Tokenisierung verwendet, aber ignoriert.

Operatoren

Operatoren können mit Literal- und Eigenschaftswerten verwendet werden. Bei arithmetischen Operatoren können Sie die Präfixnotation zum Multiplizieren verwenden, und mithilfe von Klammern kann die Reihenfolge der Operationen festgelegt werden.
OperatorBeschreibungBeispiele
+Zahlen oder Zeichenfolgen hinzufügen.property1 + 100
-Zahlen subtrahieren.property1 + 100 - property2
*Zahlen multiplizieren.10property1 = 10 * property1
/Zahlen dividieren.property1 * (100 - property2/(50 - property3))
<Prüft, ob ein Wert kleiner als ein anderer ist. Unterstützt durch Zahleneigenschaften oder Konstanten.a < 100
>Prüft, ob ein Wert größer als ein anderer ist. Unterstützt durch Zahleneigenschaften oder Konstanten.a > 50
<=Prüft, ob ein Wert kleiner oder gleich einem anderen ist. Unterstützt durch Zahleneigenschaften oder Konstanten.a <= b
>=Prüft, ob ein Wert größer oder gleich einem anderen ist. Unterstützt durch Zahleneigenschaften oder Konstanten.b>= c
=Prüft, ob ein Wert gleich einem anderen ist. Unterstützt sowohl durch Zahlen als auch durch Zeichenfolgen.(a + b - 100c * 150.652) = 150-230b
equalsPrüft, ob ein Wert gleich einem anderen ist. Unterstützt sowohl durch Zahlen als auch durch Zeichenfolgen.a + b - 100.2c * 150 equals 150 - 230
!=Prüft, ob ein Wert ungleich einem anderen ist. Unterstützt sowohl durch Zahlen als auch durch Zeichenfolgen.string(property1) != 'test_string'
orPrüft, ob einer oder zwei Werte wahr sind.a > b or b <= c
andPrüft, ob beide Werte wahr sind.bool(a) and bool(c)
notPrüft, ob keiner der Werte wahr ist.not (bool(a) and bool(c))

Funktionen

Die folgenden Funktionen werden unterstützt:
FunktionBeschreibungBeispiele
maxHat zwischen 2 und 100 Eingabenummern und gibt die Höchstanzahl aller Eingaben zurück.max(a, b, c, 100) oder max(a, b)
minHat zwischen 2 und 100 Eingabenummern und gibt die Mindestanzahl aller Eingaben zurück.min(a, b, c, 100) oder min(a, b)
is_presentWertet aus, ob ein Ausdruck ausgewertet werden kann.is_present(bool(a))= true, wenn die Eigenschaft boolesch ist, aber is_present(bool(a)) = false, wenn die Eigenschaft leer oder nicht boolesch ist.
containsHat zwei Zeichenfolgen als Eingaben und gibt true zurück, wenn die erste Eingabe die zweite enthält.contains('hello', 'ello') = true während contains('ello', 'hello') = false.
concatenateVerbindet eine Liste von Zeichenfolgen. Die Liste der Eingaben kann von 2 bis zu 100 reichen.concatenate('a', 'b', string(a), string(b))
Es gibt auch zwei Parsing-Funktionen:
  • number_to_string: versucht, den eingegebenen Zahlenausdruck in eine Zeichenfolge zu konvertieren.
  • string_to_number: versucht, den eingegebenen Zeichenfolgenausdruck in eine Zahl zu konvertieren.
Beispielsweise ist "Number of cars: " + num_cars keine gültige Eigenschaft, da Sie keine Zeichenfolge mit einer Zahl hinzufügen können, "Number of cars: " + number_to_string(num_cars) dagegen schon.

Bedingte Anweisungen

Sie können Ihre Formel auch mit bedingten Anweisungen schreiben, indem Sie if, elseif, endif und else verwenden. Beispielsweise könnte eine bedingte Anweisung wie folgt aussehen: if boolean_expression then statement [elseif expression then statement]* [else statement | endif] wobei die [a]-Klammern angeben, dass a optional ist, a|b gibt an, dass entweder a oder b funktionieren wird, und * 0 oder mehr bedeutet. endif kann verwendet werden, um eine bedingte Anweisung vorzeitig zu beenden, um sicherzustellen, dass der Parser identifizieren kann, zu welchem if das nächste elseif gehört.

Beispielformeln

Im Folgenden finden Sie Beispiele, mit denen Sie Ihre eigenen Berechnungsformeln definieren können:
"calculationFormula": "closed - started"
Ein etwas komplexeres Beispiel mit Bedingungen:
"calculationFormula": "if is_present(hs_latest_sequence_enrolled_date) then
  if is_present(hs_sequences_actively_enrolled_count) an hs_sequences_actively_enrolled_count >= 1 then
    true
  else
    false
else
  ''"

Eigenschaften abrufen

Sie können Informationen für einzelne Eigenschaften oder alle Eigenschaften innerhalb eines Objekts abrufen.
  • Um eine einzelne Eigenschaft abzurufen, führen Sie eine GET-Anfrage an crm/v3/properties/{object}/{propertyName} durch. Um beispielsweise die Eigenschaft favorite_food abzurufen, wäre Ihre Anfrage-URL /crm/v3/properties/contacts/favorite_food.
  • Um alle Eigenschaften für ein Objekt abzurufen, führen Sie eine GET-Anfrage an /crm/v3/properties/{objectType} durch.

Hinweis:

Beim Abrufen aller Eigenschaften werden standardmäßig nur nicht vertrauliche Eigenschaften zurückgegeben. Um Eigenschaften vertraulicher Daten abzurufen, fügen Sie den dataSensitivity-Abfrageparameter mit dem Wert sensitive ein. Erfahren Sie mehr über das Verwalten vertraulicher Daten über die API (nur BETA, Enterprise).

Die Werte einer Eigenschaft aktualisieren oder löschen

Um einen Eigenschaftswert für einen Datensatz zu aktualisieren, führen Sie eine PATCH-Anfrage an crm/v3/objects/{objectType}/{recordId} durch. Fügen Sie in Ihrem Anfragetext die Eigenschaften und deren Werte in ein Array ein. Erfahren Sie mehr über das Aktualisieren von Datensätzen über die Objekt-APIs.

Werte zu „date“- und „datetime“-Eigenschaften hinzufügen

Zeitwerte werden im ISO 8601-Format in Antworten dargestellt, die HubSpot-APIs akzeptieren jedoch jedes der beiden Formaten für Datums- und Zeitwerte:
  • ISO 8601-formatierte Zeichenfolgen: Je nach Datentyp sind diese eines von zwei verschiedenen Formaten:
    • Für Werte, die ein bestimmtes Datum darstellen, wird das vollständige Datumsformat verwendet: JJJJ-MM-TT (z. B. 2020-02-29).
    • Für Werte, die ein bestimmtes Datum und eine bestimmte Zeit darstellen, werden die vollständigen Daten plus Stunden, Minuten, Sekunden und ein Dezimalbruch eines zweiten Formats verwendet: JJJJ-MM-TTThh:mm:ss.sTZD (z. B. 2020-02-29T03:30:17.000Z). Alle Zeiten werden in UTC angezeigt, damit die Werte immer den UTC-Bezeichner „Z“ verwenden.”
  • UNIX-formatierte Zeitstempel in Millisekunden: Zeitstempelwerte in Millisekunden, die in UTC-Zeit dargestellt werden. Der Zeitstempelwert 1427997766000 wird zum Beispiel zu 2. April 2015 18:02:46 UTC oder 2. April 2015, 2:02:46 PM EDT (Eastern Daylight Saving Time).
Es gibt zwei Arten von Eigenschaften zum Speichern von Datumsangaben (date und datetime), die sich auch auf die Formatierung von Werten auswirken:
  • date-Eigenschaften speichern das Datum, nicht die Uhrzeit. date-Eigenschaften zeigen das Datum an, auf das sie festgelegt sind, unabhängig von der Zeitzoneneinstellung des Accounts oder Benutzers. Für date-Eigenschaftswerte wird empfohlen, das vollständige Datumsformat ISO 8601 zu verwenden. Wenn Sie das UNIX-Zeitstempelformat verwenden, müssen Sie einen Epochen-Millisekunden-Zeitstempel verwenden (d. h., der Wert muss für das Datum auf Mitternacht UTC festgelegt sein). So stellen Sie beispielsweise den 1. Mai 2015 in einem der folgenden Formate dar:
    • IOS 8601: 2015-05-01
    • UNIX-Millisekunden-Zeitstempel: 1430438400000
  • datetime-Eigenschaften speichern das Datum und die Uhrzeit. Beide Zeitstempelformate werden akzeptiert. In HubSpot werden datetime-Eigenschaften basierend auf der Zeitzone des Benutzers angezeigt, der den Datensatz anzeigt, sodass der Wert in die lokale Zeitzone des Benutzers konvertiert wird.

Werte zu den Eigenschaften des Kontrollkästchentyps hinzufügen

Wenn Sie Werte für die Eigenschaften des Kontrollkästchentyps eines Datensatzes aktualisieren, formatieren Sie die Werte wie folgt:
  • Boolesche Kontrollkästcheneigenschaft: Um als Ja oder in HubSpot markiert angezeigt zu werden, muss Ihr Wert true sein. Um als Nein angezeigt zu werden oder in HubSpot nicht markiert zu werden, muss Ihr Wert false sein.
  • Eigenschaft mit mehreren Kontrollkästchen: Um Werte zu einer Eigenschaft mit mehreren Kontrollkästchen hinzuzufügen oder anzuhängen, fügen Sie ein Semikolon vor dem ersten Wert hinzu und trennen Sie die Werte durch Semikolon ohne Leerzeichen dazwischen. Wenn die Eigenschaft einen vorhandenen Wert hat, hängt das führende Semikolon die Werte an, anstatt den Wert zu überschreiben. Ein Kontakt hat beispielsweise den vorhandenen Wert DECISION_MAKER für die Eigenschaft hs_buying_role. Um zusätzliche Werte hinzuzufügen, ohne den vorhandenen Wert zu ersetzen, würde Ihre Anfrage wie folgt aussehen:
{
"properties": {
"hs_buying_role": ";BUDGET_HOLDER;END_USER"
}
}

Für Datensätze zuständige Mitarbeiter mit Benutzereigenschaften zuweisen

Beim Zuweisen von Benutzern zu CRM-Datensätzen über die API muss Ihr Wert die id des Benutzers für den zuständigen Mitarbeiter sein, die Sie in Ihren Eigenschafteneinstellungen oder über die Zuständige Mitarbeiter-API finden. Um beispielsweise einen Benutzer als zuständigen Mitarbeiter eines Kontakts zuzuweisen, senden Sie eine PATCH -Anfrage an crm/v3/objects/contacts/{contactId} mit dem Text { "properties":{ "hubspot_owner_id": "41629779"}}.

Einen Eigenschaftswert löschen

Sie können einen Objekteigenschaftswert über die API löschen, indem Sie den Eigenschaftswert auf eine leere Zeichenfolge festlegen. Um z. B. den firstname aus einem Kontaktobjekt zu löschen, senden Sie eine PATCH-Anfrage mit dem Text { "properties": { "firstname": ""}} an /crm/v3/objects/contacts/{contactId}.