Objekt-APIs
Die Objekt-APIs ermöglichen den Zugriff auf Datensätze und Aktivitäten. Für unterstützte Objekte können Sie Objektendpunkte verwenden und{objectTypeId} in der Anfrage-URL durch das gewünschte Objekt ersetzen. Um beispielsweise Kontakte zu erstellen, senden Sie eine POST-Anfrage an crm/v3/objects/0-1, und um Kurse zu erstellen, wäre die Anfrage an crm/v3/objects/0-410 erforderlich. In diesem Artikel finden Sie weitere Informationen zur Verwendung der Objektendpunkte für verschiedene Objekte.
Objekttyp-IDs
Wenn Sie CRM- und andere APIs verwenden, müssen Sie dasobjectTypeId-Feld verwenden, d. h. einen eindeutigen numerischen Wert, der jedem Objekt zugewiesen wird. Um beispielsweise Datensätze abzurufen, stellen Sie eine GET-Anfrage an /crm/v3/objects/{objectTypeId}, oder wenn Sie eine Eigenschaft für ein Objekt erstellen, stellen Sie eine POST-Anfrage an /crm/v3/properties/{objectTypeId}. Die Werte für die Objekttyp-ID sind in der folgenden Tabelle aufgeführt:
Sie können immer den numerischen ID-Wert verwenden, aber in einigen Fällen können Sie auch den Namen des Objekts für Kontakte, Unternehmen, Deals, Tickets oder Notizen verwenden. Zum Beispiel:
- Wenn Sie einen Import mit der Importe-API starten, gibt die
columnObjectTypeIdan, zu welchem Objekt die Daten in Ihrer Datei gehören. Um Daten für zu importieren, könnte Ihr Wert fürcolumnObjectTypeIdentwedercontactoder0-1sein. - Bei Verwendung der Zuordnungen-API geben die Werte
fromObjectTypeundtoObjectTypedie Objekte und die Richtung der Zuordnung an. Um Zuordnungstypen für Kontakte zu Unternehmen anzuzeigen, könnte IhreGET-Anfrage-URLcrm/v4/associations/contact/company/labelsodercrm/v4/associations/0-1/0-2/labelssein.
Eindeutige IDs und Datensatz-IDs
Eine eindeutige ID ist ein Wert, der einen Datensatz in einem CRM von einem anderen Datensatz unterscheidet, selbst wenn sie ansonsten identische Informationen enthalten. Eine Datenbank kann beispielsweise Datensätze für zwei Personen enthalten, die beide Jonathan Schmidt heißen. Um zu vermeiden, dass versehentlich Geld an den falschen Jonathan Schmidt überwiesen wird, wird jedem Datensatz eine Zahl als Datensatz-ID zugewiesen. Wenn ein Datensatz in HubSpot erstellt wird, wird automatisch eine Datensatz-ID (hs_object_id) generiert, die als Zeichenfolge behandelt werden sollte. Datensatz-IDs sind nur innerhalb dieses Objekts 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. Sie können auch benutzerdefinierte „Eindeutige ID“-Eigenschaften erstellen.
In den CRM-APIs verwenden Sie eindeutige ID-Werte, um bestimmte Datensätze zu identifizieren und zu verwalten. Sie können immer den hs_object_id-Wert eines Eintrags verwenden, aber Sie können auch benutzerdefinierte „Eindeutige ID“-Eigenschaften für bestimmte Endpunkte verwenden, die durch den idProperty-Parameter angegeben werden. Um beispielsweise einen Kontakt zu bearbeiten, können Sie eine PATCH-Anfrage an /crm/v3/objects/0-1/{contactId} oder /crm/v3/objects/0-1/{contactEmail}?idProperty=email stellen. In der Wissensdatenbank erfahren Sie mehr darüber, wie HubSpot die Deduplizierung handhabt.
Zuordnungs-API
In HubSpot können Sie anzeigen, wie Objekte durch zugehörige Datensätze miteinander verknüpft sind. Beispielsweise können Sie mehrere Kontakte mit einem Unternehmen verknüpfen und dann das Unternehmen und relevante Kontakte mit einem Deal verknüpfen. Wenn Sie die API-Endpunkte für Zuordnungen verwenden, können Sie Objekte für{toObjectTypeId} und {fromObjectTypeId} in den Anfrage-URLs und Anforderungstexten ersetzen. Um zu verstehen, welche Objekte einander zugeordnet werden können, können Sie vor dem objektübergreifenden Zuordnen von Datensätzen die Zuordnung abrufen. Kontakte können beispielsweise den meisten Objekten zugeordnet werden, während Rechnungen nur Kontakten, Unternehmen, Deals, Artikeln, Rabatten, Gebühren und Steuern zugeordnet werden können. Je nach Abonnement können Sie die spezifische Beziehung zwischen Datensätzen mithilfe von Zuordnungslabeln beschreiben, und Ihr Account kann zusätzliche benutzerdefinierte Objekte enthalten, die den anderen Standardobjekten zugeordnet werden können. Erfahren Sie mehr über Objektbeziehungen und das Verwalten von Zuordnungen mithilfe der Zuordnungen-Endpunkte.
Wenn Sie Zugriff auf einen HubSpot-Account haben, können Sie auch die eindeutigen Objektbeziehungen Ihres Accounts überprüfen, indem Sie zum Datenmodelltool
Eigenschaften-API
Informationen zu Datensätzen werden in Felder, Eigenschaften genannt, gespeichert, die dann in Gruppen organisiert werden. HubSpot bietet eine Reihe von Standardeigenschaften für jedes Objekt. Neben den Standardeigenschaften der einzelnen Objekte können Sie benutzerdefinierte Daten speichern, indem Sie benutzerdefinierte Eigenschaften erstellen. Wenn Sie die Eigenschaften-API verwenden, können Sie Objekte in den Endpunkten ersetzen, um die Eigenschaften eines Objekt zu erstellen und zu verwalten, Zum Beispiel/crm/v3/properties/0-1 für Kontakteigenschaften oder /crm/v3/properties/0-5 für Ticketeigenschaften. Hier erfahren Sie mehr über die Verwendung der Eigenschaften-API.
Such-API
Um Datensätze und Aktivitäten anhand ihrer Eigenschaften und Zuordnungen zu filtern und zu sortieren, können Sie die Such-API verwenden. Wenn Sie die Such-Endpunkte verwenden, ersetzen Sie den{objectTypeId}-Wert für das Objekt, in dem Sie suchen möchten. Um beispielsweise nach Anrufen zu suchen, führen Sie eine POST-Anfrage an /crm/v3/objects/0-48/search durch. In diesem Artikel erfahren Sie mehr über die Verwendung der CRM-Such-API.