In Kontaktdatensätzen werden Informationen zu Einzelpersonen gespeichert. Die Kontakte-Endpunkte ermöglichen es Ihnen, diese Daten zu verwalten und zwischen HubSpot und anderen Systemen zu synchronisieren.
POST
-Anfrage an /crm/v3/objects/contacts
durch.
Schließen Sie in Ihrer Anfrage Ihre Kontaktdaten in ein properties-Objekt ein. Sie können auch ein associations-Objekt hinzufügen, um Ihrem neuen Kontakt vorhandene Datensätze (z. B. Unternehmen, Deals) oder Aktivitäten (z. B. Meetings, Notizen) zuzuordnen.
email
, firstname
oder lastname
. Es wird empfohlen, immer email
einzuschließen, da E-Mail-Adressen die primäre eindeutige ID sind, um doppelte Kontakte in HubSpot zu vermeiden.
Um alle verfügbaren Eigenschaften anzuzeigen, können Sie eine Liste der Kontakteigenschaften Ihres Accounts abrufen, indem Sie eine GET
-Anfrage an /crm/v3/properties/contacts
durchführen. Erfahren Sie mehr über die Eigenschaften-API.
lifecyclestage
in Ihre Anfrage aufgenommen haben, müssen sich die Werte auf den internen Namen der Lifecycle-Phase beziehen. Die internen Namen der Standardphasen sind Text-Werte und ändern sich auch nicht, wenn Sie das Label der Phase bearbeiten (z. B. subscriber
oder marketingqualifiedlead
). Die internen Namen von benutzerdefinierten Phasen sind numerische Werte. Sie können die interne ID einer Phase in Ihren Einstellungen für Lifecycle-Phasen finden, oder indem Sie die Lifecycle-Phase-Eigenschaft über die API abrufen.Parameter | Beschreibung |
---|---|
to | Der Datensatz oder die Aktivität, den bzw. die Sie dem Kontakt zuordnen möchten, angegeben durch seinen bzw. ihren eindeutigen id -Wert. |
types | Der Typ der Zuordnung zwischen dem Kontakt und dem Datensatz/der Aktivität. Beziehen Sie die associationCategory und associationTypeId ein. Standardzuordnungstyp-IDs sind hier aufgeführt. Sie können den Wert für benutzerdefinierte Zuordnungstypen (d. h. Label) über die Zuordnungen-API abrufen. |
GET
-Anfrage an /crm/v3/objects/contacts/{contactId} or
/crm/v3/objects/contacts/{email}?idProperty=email
durch.GET
-Anfrage an /crm/v3/objects/contacts
durch.Parameter | Beschreibung |
---|---|
properties | Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn der angefragte Kontakt 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 Kontakt 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/contacts/batch/read
durch. Der Batch-Endpunkt kann Zuordnungen nicht abrufen. Erfahren Sie, wie Sie Zuordnungen mit der Zuordnungen-API batchweise lesen.idProperty
-Parameter verwenden, um Kontakte nach email
oder einer benutzerdefinierten „Eindeutige ID“-Eigenschaft abzurufen. Standardmäßig beziehen sich die id
-Werte in der Anfrage auf die Datensatz-ID (hs_object_id
), sodass der idProperty
-Parameter beim Abrufen nach Datensatz-ID nicht erforderlich ist. Wenn Sie email
oder eine benutzerdefinierte „Eindeutiger Wert“-Eigenschaft zum Abrufen von Kontakten verwenden, müssen Sie den idProperty
-Parameter angeben.
Um beispielsweise einen Batch von Kontakten basierend auf Datensatz-ID-Werten abzurufen, könnte Ihre Anfrage wie folgt aussehen (nur aktuelle Werte oder aktuelle und historische Werte):
Um Kontakte basierend auf der E-Mail-Adresse oder einer benutzerdefinierten „Eindeutige ID“-Eigenschaft (z. B. eine für Ihr Unternehmen eindeutige Kunden-ID-Nummer) abzurufen, sieht Ihre Anfrage wie folgt aus:
id
) oder die E-Mail-Adresse des Kontakts (email
) verwenden.
PATCH
-Anfrage an /crm/v3/objects/contacts/{contactId}
durch und schließen Sie die Daten ein, die Sie aktualisieren möchten.PATCH
-Anfrage an /crm/v3/objects/contacts/{email}?idProperty=email
durch und schließen Sie die Daten ein, die Sie aktualisieren möchten.lifecyclestage
-Eigenschaft aktualisieren, können Sie den Wert in der Phasenreihenfolge nur vorwärts setzen. Um die Lifecycle-Phase nach vorn zu setzen, müssen Sie zunächst den bestehenden Lifecycle-Phasenwert des Datensatzes löschen. Der Wert kann manuell gelöscht werden oder automatisch über einen Workflow oder eine Integration, die Kontaktdaten synchronisiert, gelöscht werden.id
) verwenden. Um mehrere Kontakte zu aktualisieren, führen Sie eine POST
-Anfrage an /crm/v3/objects/contacts/batch/update
durch. Geben Sie in Ihrem Anforderungstext die Datensatz-ID jedes Kontakts als id
und berücksichtigen Sie die Eigenschaften, die Sie aktualisieren möchten.
Zum Beispiel:
email
- oder eine benutzerdefinierte Eigenschaft mit eindeutiger ID verwenden. Wenn die Kontakte bereits vorhanden sind, werden sie nach der Anfrage aktualisiert. Falls die Kontakte noch nicht vorhanden sind, werden sie erstellt.
Für das „Upsert“ von Kontakten stellen Sie eine POST
-Anfrage an /crm/v3/objects/contacts/batch/upsert
. Fügen Sie in Ihrem Anforderungstext den idProperty
-Parameter ein, um zu identifizieren, ob Sie eine email
- oder eine benutzerdefinierte eindeutige ID-Eigenschaft verwenden. Fügen Sie den Wert dieser Eigenschaft als id
sowie die anderen Eigenschaften hinzu, die Sie festlegen oder aktualisieren möchten.
email
als idProperty
für Kontakte verwendet wird. Um ein teilweises „Upsert“ abzuschließen, verwenden Sie stattdessen eine benutzerdefinierte „Eindeutige ID“-Eigenschaft als idProperty
.PUT
-Anfrage an /crm/v3/objects/contacts/{contactId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
durch.
associationTypeId
-Wert abzurufen, verweisen Sie auf diese Liste der Standardwerte oder führen Sie eine GET
-Anfrage an /crm/v4/associations/{fromObjectType}/{toObjectType}/labels
durch.DELETE
-Anfrage an die folgende URL durch: /crm/v3/objects/contacts/{contactID}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
hs_pinned_engagement_id
-Feld in Ihre Anfrage aufnehmen. Geben Sie im Feld die id
der anzupinnenden Aktivität an, die über die Interaktionen-APIs abgerufen werden kann. Sie können eine Aktivität pro Datensatz anpinnen, und die Aktivität muss bereits vor dem Anpinnen mit dem Kontakt verknüpft sein.
Um die angepinnte Aktivität eines Kontakts festzulegen oder zu aktualisieren, könnte Ihre Anfrage wie folgt aussehen:
DELETE
-Anfrage an /crm/v3/objects/contacts/{contactId}
durch.
Erfahren Sie in der Referenzdokumentation mehr über das massenweise Löschen von Kontakten.
properties
-Parameter mit den Eigenschaften email
und hs_additional_emails
ein. Die primäre E-Mail-Adresse eines Kontakts wird im Feld email
angezeigt. Weitere E-Mail-Adressen werden im Feld hs_additional_emails
angezeigt.