Mit benutzerdefinierten HubSpot-Objekten können Unternehmen diese Daten basierend auf Ihren Geschäftsanforderungen mit der API für benutzerdefinierte Objekte darstellen und organisieren.
POST
-Anfrage an crm/v3/schemas
durch. Fügen Sie im Anforderungstext Definitionen für Ihr Objektschema ein, einschließlich Name, Eigenschaften und Zuordnungen.
Wenn Sie Ihr benutzerdefiniertes Objekt benennen, beachten Sie Folgendes:
secondaryDisplayProperties
aufgeführt ist, wird auch als vierter Filter auf der Indexseite des Objekts hinzugefügt, wenn es sich um einen der folgenden Eigenschaftstypen handelt:
string
number
enumeration
boolean
datetime
type
der Eigenschaft auf string
und der fieldType
auf text
festgelegt. Unten sind die Werte, die Sie verwenden können, um verschiedene Typen von Eigenschaften zu erstellen.
type | Beschreibung | Zulässige fieldType -Werte |
---|---|---|
enumeration | Eine Zeichenfolge, die eine Reihe von Optionen enthält, die durch ein Semikolon getrennt sind. | booleancheckbox , checkbox , radio , select |
date | Ein ISO 8601-formatierter Wert, der einen bestimmten Tag, einen bestimmten Monat und ein bestimmtes Jahr darstellt. | date |
dateTime | Ein ISO 8601-formatierter Wert, der einen bestimmten Tag, einen bestimmten Monat, ein bestimmtes Jahr und eine bestimmte Uhrzeit darstellt. Die HubSpot-App zeigt nicht die Uhrzeit an. | date |
string | Eine Klartext-Zeichenfolge, die auf 65.536 Zeichen begrenzt ist. | file , text , textarea |
number | Ein Zahlenwert mit numerischen Ziffern und höchstens einer Dezimalstelle. | number |
fieldType | 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. |
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. |
date | Ein Datumswert, der als Datumsauswahl angezeigt wird. |
file | Ermöglicht, dass eine Datei zu einem Formular hochgeladen wird. Wird als URL-Link gespeichert und der Datei angezeigt. |
number | Eine Ziffernfolge oder Zahlen in Dezimalschreibweise oder in wissenschaftlicher Notation. |
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. |
objectTypeId
-Werts. Zum Beispiel:
GET
-Anfrage an /crm/v3/schemas
durch.
Um ein bestimmtes benutzerdefiniertes Objekt abzurufen, führen Sie eine GET
-Anfrage an einen der folgenden Endpunkte durch:
/crm/v3/schemas/{objectTypeId}
/crm/v3/schemas/p_{object_name}
/crm/v3/schemas/{fullyQualifiedName}
. Sie können den
fullyQualifiedName
eines Objekts in seinem Schema finden, das von p{portal_id}_{object_name}
abgeleitet wird. Sie können die Portal-ID Ihres Accounts mithilfe der Account-Informationen-API finden.
1234
und ein Objekt mit dem Namen lender
könnte Ihre Anfrage-URL beispielsweise wie folgt aussehen:
https://api.hubapi.com/crm/v3/schemas/2-3465404
https://api.hubapi.com/crm/v3/schemas/p_lender
https://api.hubapi.com/crm/v3/schemas/p1234_lende
GET
-Anfrage an crm/v3/objects/{objectType}/{recordId}
durch.Parameter | Beschreibung |
---|---|
properties | Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn der angefragte benutzerdefinierte Objektdatensatz keinen Wert für eine Eigenschaft hat, wird er nicht in der Antwort angezeigt. |
propertiesWithHistory | Eine durch Kommas getrennte Liste der aktuellen und historischen Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn der angefragte benutzerdefinierte Objektdatensatz keinen Wert für eine Eigenschaft hat, wird er nicht in der Antwort angezeigt. |
associations | Eine durch Kommas getrennte Liste von Objekten, für die zugehörige IDs abgerufen werden sollen. Alle angegebenen Zuordnungen, die nicht vorhanden sind, werden nicht in der Antwort zurückgegeben. Erfahren Sie mehr über die Zuordnungen-API |
POST
-Anfrage an crm/v3/objects/{objectType}/batch/read
durch. Der Batch-Endpunkt kann Zuordnungen nicht abrufen. Erfahren Sie, wie Sie Zuordnungen mit der Zuordnungen-API batchweise lesen.hs_object_id
) abrufen oder nach einer benutzerdefinierten „Eindeutige ID“-Eigenschaft. Standardmäßig beziehen sich die id
-Werte in der Anfrage auf die Datensatz-ID, sodass der idProperty
-Parameter beim Abrufen nach Datensatz-ID nicht erforderlich ist. Um eine benutzerdefinierte „Eindeutiger Wert“-Eigenschaft zu verwenden, müssen Sie den idProperty
-Parameter einschließen.
Um beispielsweise einen Batch von benutzerdefinierten Objektdatensätzen abzurufen, könnte Ihre Anfrage wie folgt aussehen:
PATCH
-Anfrage an https://api.hubapi.com/crm/v3/schemas/{objectTypeId}
durch.
Sobald Ihr benutzerdefiniertes Objekt definiert ist:
primaryDisplayProperty
, searchableProperties
, requiredProperties
und secondaryDisplayProperties
können durch Aktualisieren des Schemas des Objekts geändert werden. Um eine neue Eigenschaft als erforderlich, durchsuchbar oder Anzeigeeigenschaft festzulegen, müssen Sie die Eigenschaft vor dem Aktualisieren des Schemas erstellen.POST
-Anfrage an /crm/v3/schemas/_{objectTypeId}_/associations
durch.
Sie können Ihr benutzerdefiniertes Objekt nur Standard-HubSpot-Objekten (z. B. Kontakte, Unternehmen, Deals oder Tickets) oder anderen benutzerdefinierten Objekten zuordnen. Identifizieren Sie im toObjectTypeId
-Feld benutzerdefinierte Objekte nach ihrem objectTypeId
-Wert und Standardobjekte nach ihrem Namen. Zum Beispiel:
DELETE
-Anfrage an /crm/v3/schemas/{objectType}
durch.
Wenn Sie ein neues benutzerdefiniertes Objekt mit dem gleichen Namen wie das gelöschte Objekt erstellen müssen, müssen Sie das Schema dauerhaft löschen, indem Sie eine DELETE
-Anfrage an /crm/v3/schemas/{objectType}?archived=true
durchführen. Sie können einen benutzerdefinierten Objekttyp nur löschen, nachdem alle Objektinstanzen von diesem Typ, alle Zuordnungen und benutzerdefinierten Objekteigenschaften gelöscht wurden.
secondaryDisplayProperties
) mit der neuen Eigenschaft
POST
-Anfrage an /crm/v3/schemas
mit dem folgenden Anforderungstext durchführt:
{objectTypeId}
-Feld des neuen Objekts zu notieren, da es später zum Abrufen und Aktualisieren des Objekts verwendet wird. Sie können auch den {fullyQualifiedName}
-Wert verwenden, wenn sie es vorziehen.POST
-Anfrage an /crm/v3/objects/2-3465404
mit dem folgenden Anforderungstext durchführt:
id
-Wert verwenden, um das Auto später einem vorhandenen Kontakt zuzuordnen.
GET
-Anfrage an https://api.hubapi.com/crm/v3/objects/2-3465404/181308?portalId=1234567&properties=year&properties=make&properties=model
durchführen.181308
) und der ID eines anderen Datensatzes können Sie einen benutzerdefinierten Objektdatensatz einem Datensatz eines anderen Objekts zuordnen.
Um eine Zuordnung zu erstellen, führen Sie eine PUT
-Anfrage an /crm/v3/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType}
durch. Wenn die Objektbeziehung bereits definiert ist, führen Sie eine associationType
-Anfrage an GET
durch, um den crm/v3/schemas/{objectType}
-Wert zu bestimmen.
Beispielsweise kann CarSpot mit der Kontakt-ID 51
und dem Zuordnungstyp 75
den Fahrzeugdatensatz einem Kontakt zuordnen. Mithilfe der obigen IDs wird die Anfrage-URL wie folgt erstellt:
https://api.hubspot.com/crm/v3/objects/2-3465404/181308/associations/contacts/51/75
POST
-Anfrage an /crm/v3/schemas/2-3465404/associations
mit dem folgenden Anforderungstext durchführt:
POST
-Anfrage an /crm/v3/properties/2-3465404
mit dem folgenden Anforderungstext durch:
secondaryDisplayProperties
hinzu, indem es eine PATCH
-Anfrage an /crm/v3/schemas/2-3465404
mit dem folgenden Anforderungstext durchführt: