Unternehmen 

ÜberblickEndpunkte

In HubSpot speichern Unternehmen Informationen zu Organisationen gespeichert, die mit Ihrer Geschäft interagieren. Die Unternehmen-Endpunkte ermöglichen es Ihnen, Unternehmensdatensätze zu erstellen und zu verwalten sowie Unternehmensdaten zwischen HubSpot und anderen Systemen zu synchronisieren. 

Erfahren Sie mehr über Objekte, Datensätze, Eigenschaften und Zuordnungen-APIs im Leitfaden Grundlegendes zum CRM. Weitere allgemeine Informationen zu Objekten und Datensätzen in HubSpot finden Sie in diesem Artikel über das Verwalten Ihrer CRM-Datenbank.

Unternehmen erstellen

Um neue Unternehmen zu erstellen, nehmen Sie eine POST-Anfrage an /crm/v3/objects/companies vor.

Schließen Sie in Ihrer Anfrage Ihre Unternehmensdaten in ein properties-Objekt ein. Sie können auch ein associations-Objekt hinzufügen, um Ihrem neuen Unternehmen vorhandene Datensätze (z. B. Kontakte, Deals) oder Aktivitäten (z. B. Meetings, Notizen) zuzuordnen.

Eigenschaften

Unternehmensdetails werden in Unternehmenseigenschaften gespeichert. Es gibt Standard-HubSpot-Unternehmenseigenschaften, Sie können jedoch auch benutzerdefinierte Eigenschaften erstellen.

Wenn Sie ein neues Unternehmen erstellen, sollten Sie mindestens eine der folgenden Eigenschaften in Ihre Anfrage aufnehmen: name oder domain. Es wird empfohlen, immer domain einzuschließen, da Domain-Namen die primäre eindeutige ID sind, um doppelte Unternehmen in HubSpot zu vermeiden. Wenn ein Unternehmen über mehrere Domains verfügt, können Sie diese über die API hinzufügen, indem Sie das hs_additional_domains-Feld mit Semikolons zur Trennung der einzelnen Domains verwenden. Zum Beispiel: "hs_additional_domains" : "domain.com; domain2.com; domain3.com".

Um alle verfügbaren Eigenschaften anzuzeigen, können Sie eine Liste der Unternehmenseigenschaften Ihres Accounts abrufen, indem Sie eine GET-Anfrage an /crm/v3/properties/companies durchführen. Erfahren Sie mehr über die Eigenschaften-API.

Bitte beachten: Wenn Sie 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 Textwerte 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.

Um beispielsweise ein neues Unternehmen zu erstellen, kann Ihre Anfrage wie folgt aussehen:

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" } }

Zuordnungen

Beim Erstellen eines neuen Unternehmens können Sie das Unternehmen auch bestehenden Datensätzen oder Aktivitäten zuordnen. Schließen Sie im associations-Objekt die folgenden Felder ein:

Use this table to describe parameters / fields
ParameterDescription
toObjectId

Die ID des Datensatzes oder der Aktivität, dem oder der Sie das Unternehmen zuordnen möchten.

associationTypeId

Eine eindeutige ID, die den Zuordnungstyp zwischen dem Unternehmen und dem anderen Objekt oder der anderen Aktivität angibt. Standardzuordnungstypen sind hier aufgeführt, oder Sie können den Wert abrufen, indem Sie eine GET-Anfrage an /crm/v4/associations/{fromObjectType}/{toObjectType}/labels durchführen. Erfahren Sie mehr über die Zuordnungen-API.

Sie können auch das label-Feld hinzufügen, um ein definiertes Zuordnungslabel zuzuweisen, das die Zuordnung beschreibt. Erfahren Sie mehr über das Zuordnen von Datensätzen über die Zuordnungen-API.

Um beispielsweise ein neues Unternehmen mit einem bestehenden Kontakt und einer vorhandenen E-Mail zu verknüpfen, würde Ihre Anfrage wie folgt aussehen:

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" }, "associations": [ { "to": { "id": 101 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 280 } ] }, { "to": { "id": 556677 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 185 } ] }] }

Unternehmen abrufen

Sie können Unternehmen einzeln oder in Batches abrufen.

  • Um ein einzelnes Unternehmen abzurufen, führen Sie eine GET-Anfrage an /crm/v3/objects/companies/{companyId} durch.
  • Um eine Liste aller Unternehmen anzufragen, führen Sie eine GET-Anfrage an /crm/v3/objects/companies durch.

Sie können für diese Endpunkte die folgenden Abfrageparameter in die Anfrage-URL einschließen: 

Use this table to describe parameters / fields
ParameterDescription
properties

Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn das angefragte Unternehmen keinen Wert für eine Eigenschaft hat, wird es 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 das angefragte Unternehmen keinen Wert für eine Eigenschaft hat, wird es 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.

Für den Batch-Leseendpunkt können Sie auch den optionalen idProperty-Parameter verwenden, um Unternehmen anhand 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. Um eine benutzerdefinierte „Eindeutiger Wert“-Eigenschaft zum Abrufen von Unternehmen zu verwenden, müssen Sie den idProperty-Parameter einschließen.

Um beispielsweise einen Batch von Unternehmen abzurufen, könnte Ihre Anfrage wie folgt aussehen:

///Example request body with record ID { "properties": [ "name", "domain" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }
///Example request body with a unique value property { "properties": [ "name", "domain" ], "idProperty": "uniquepropertyexample", "inputs": [ { "id": "abc" }, { "id": "def" } ] }

Um Unternehmen mit aktuellen und historischen Werten für eine Eigenschaft abzurufen, könnte Ihre Anfrage wie folgt aussehen:

///Example request body with record ID (current and historical values) { "propertiesWithHistory": [ "name" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }

Unternehmen aktualisieren

Sie können Unternehmen einzeln oder mehrere gleichzeitig aktualisieren. Für bestehende Unternehmen ist die Datensatz-ID des Unternehmens ein eindeutiger Wert, den Sie verwenden können, um das Unternehmen über die API zu aktualisieren.

Um ein einzelnes Unternehmen anhand seiner Unternehmens-ID zu aktualisieren, führen Sie eine PATCH-Anfrage an /crm/v3/objects/companies/{companyId} durch und schließen Sie die Daten ein, die Sie aktualisieren möchten.

Bestehende Unternehmen mit Datensätzen und Aktivitäten verknüpfen

Um ein Unternehmen anderen CRM-Datensätzen oder einer Aktivität zuzuordnen, führen Sie eine PUT-Anfrage an /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId} durch.

Um den 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.

Erfahren Sie mehr über das Zuordnen von Datensätzen mit der Zuordnungen-API.

Eine Zuordnung entfernen

Um eine Verknüpfung zwischen einem Unternehmen und einem Datensatz oder einer Aktivität zu entfernen, führen Sie eine DELETE-Anfrage an die folgende URL durch:/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.

Eine Aktivität in einem Unternehmensdatensatz anpinnen

Sie können eine Aktivität über eine API an einen Unternehmensdatensatz anpinnen, indem Sie das 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 Unternehmen verknüpft sein.

Um die angepinnten Aktivitäten eines Unternehmens festzulegen oder zu aktualisieren, könnte Ihre Anfrage wie folgt aussehen:

///Example request body PATCH /crm/v3/objects/companies/{companyId} { "properties": { "hs_pinned_engagement_id": 123456789 } }

Sie können auch ein Unternehmen erstellen, es mit einer vorhandenen Aktivität verknüpfen und die Aktivität in derselben Anfrage anpinnen. Zum Beispiel:

///Example request body POST /crm/v3/objects/companies { "properties": { "domain": "example.com", "name": "Example Company", "hs_pinned_engagement_id": 123456789 }, "associations": [ { "to": { "id": 123456789 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 189 }] }] }

Unternehmen löschen

Sie können Unternehmen einzeln oder mehrere gleichzeitig löschen, wodurch das Unternehmen in den Papierkorb in HubSpot verschoben wird. Sie können das Unternehmen später in HubSpot wiederherstellen.

Um ein einzelnes Unternehmen anhand seiner ID zu löschen, führen Sie eine DELETE-Anfrage an /crm/v3/objects/companies/{companyId} durch.

Erfahren Sie mehr über das gleichzeitige Löschen von mehreren Unternehmen, indem Sie oben in diesem Artikel auf die Registerkarte Endpunkte klicken.

War dieser Artikel hilfreich?
Dieses Formular dient dazu, Feedback zu unserer Entwicklerdokumentation zu sammeln. Wenn Sie uns Ihre Meinung zu HubSpot-Produkten mitteilen möchten, teilen Sie diese bitte im Ideenforum der Community.