Die CRM-Eigenschaften-Endpunkte ermöglichen es Ihnen, benutzerdefinierte Eigenschaften zu verwalten und Details für Standardeigenschaften für jedes Objekt anzuzeigen.
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:
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.
type | Beschreibung | Zulässige fieldType -Werte |
---|---|---|
bool | Ein Feld mit binären Optionen (z. B. Yes oder No , True oder False ). | booleancheckbox , calculation_equation |
enumeration | Eine Zeichenfolge, die eine Reihe von Optionen enthält, die durch ein Semikolon getrennt sind. | booleancheckbox , checkbox , radio , select , calculation_equation |
date | Ein 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 |
datetime | Ein 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 |
string | Eine Klartext-Zeichenfolge, die auf 65.536 Zeichen begrenzt ist. | file , text , textarea , calculation_equation , html , phonenumber |
number | Ein Zahlenwert mit numerischen Ziffern und höchstens einer Dezimalstelle. | number , calculation_equation |
object_coordinates | Ein 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 |
json | Ein 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 |
fieldType
sind:
Feldtyp | Beschreibung |
---|---|
booleancheckbox | Eine 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_equation | Eine benutzerdefinierte Gleichung, die Werte basierend auf anderen Eigenschaftswerten und/oder Zuordnungen berechnen kann. Erfahren Sie, wie Sie berechnete Eigenschaften definieren. |
checkbox | Eine 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. |
date | Ein Datumswert, der als Datumsauswahl angezeigt wird. |
file | Ermöglicht das Hochladen einer Datei in einen Datensatz oder über ein Formular. Speichert eine Datei-ID. |
html | Eine Zeichenfolge, die als bereinigter HTML-Code gerendert wird und die Verwendung eines Rich-Text-Editors für die Eigenschaft ermöglicht. |
number | Eine Ziffernfolge oder Zahlen in Dezimalschreibweise oder in wissenschaftlicher Notation. |
phonenumber | Eine Klartext-Zeichenfolge, die als eine formatierte Telefonnummer angezeigt wird. |
radio | Eine 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. |
select | Eine Dropdown-Eingabe, die es Benutzern ermöglicht, eine Option aus einer Reihe von Optionen auszuwählen, die für die Eigenschaft zulässig sind. |
text | Eine Klartext-Zeichenfolge, die als eine einzeilige Texteingabe angezeigt wird. |
textarea | Eine Klartext-Zeichenfolge, die als eine mehrzeilige Texteingabe angezeigt wird. |
POST
-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.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:
POST
-Anfrage an /crm/v3/properties/{objectType}
durch.hasUniqueValue
-Feld den Wert auf true
fest.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.
calculation_equation
und einen Typ von number
, bool
, string
oder enumeration
verwenden.
Sie können die Berechnungsformel der Eigenschaft mit dem calculationFormula
-Feld definieren.
calculationFormula
können Sie Ihre Formel mit arithmetischen Operatoren, Vergleichsoperatoren, logischen Operatoren, bedingten Anweisungen und anderen Funktionen schreiben.
'constant'
) oder doppelten Anführungszeichen ("constant"
) dargestellt werden.1005
und 1.5589
sind beide gültige konstante Zahlen.true
oder false
sein.string
-Funktion gehüllt sein. Beispielsweise wird string(var1)
als Wert für die Zeichenfolgeneigenschaft var1 interpretiert.var1
als Wert für die Zahleneigenschaft var1 interpretiert.bool
-Funktion gehüllt sein. Zum Beispiel wird der Bezeichner bool(var1)
als Wert für die boolesche Eigenschaft var1 interpretiert.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.Operator | Beschreibung | Beispiele |
---|---|---|
+ | 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 |
equals | Prü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' |
or | Prüft, ob einer oder zwei Werte wahr sind. | a > b or b <= c |
and | Prüft, ob beide Werte wahr sind. | bool(a) and bool(c) |
not | Prüft, ob keiner der Werte wahr ist. | not (bool(a) and bool(c)) |
Funktion | Beschreibung | Beispiele |
---|---|---|
max | Hat zwischen 2 und 100 Eingabenummern und gibt die Höchstanzahl aller Eingaben zurück. | max(a, b, c, 100) oder max(a, b) |
min | Hat zwischen 2 und 100 Eingabenummern und gibt die Mindestanzahl aller Eingaben zurück. | min(a, b, c, 100) oder min(a, b) |
is_present | Wertet 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. |
contains | Hat 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. |
concatenate | Verbindet eine Liste von Zeichenfolgen. Die Liste der Eingaben kann von 2 bis zu 100 reichen. | concatenate('a', 'b', string(a), string(b)) |
number_to_string
: versucht, den eingegebenen Zahlenausdruck in eine Zeichenfolge zu konvertieren.string_to_number
: versucht, den eingegebenen Zeichenfolgenausdruck in eine Zahl zu konvertieren."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.
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.
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
.GET
-Anfrage an /crm/v3/properties/{objectType}
durch.dataSensitivity
-Abfrageparameter mit dem Wert sensitive
ein. Erfahren Sie mehr über das Verwalten vertraulicher Daten über die API (nur BETA, Enterprise).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.
2020-02-29
).2020-02-29T03:30:17.000Z
). Alle Zeiten werden in UTC angezeigt, damit die Werte immer den UTC-Bezeichner „Z“ verwenden.”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).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:
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.true
sein. Um als Nein angezeigt zu werden oder in HubSpot nicht markiert zu werden, muss Ihr Wert false
sein.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: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"}}
.
firstname
aus einem Kontaktobjekt zu löschen, senden Sie eine PATCH
-Anfrage mit dem Text { "properties": { "firstname": ""}}
an /crm/v3/objects/contacts/{contactId}
.