In Unternehmensdatensätzen werden Daten zu Unternehmen gespeichert. Unternehmen-Endpunkte ermöglichen es Ihnen, diese Daten zu verwalten und zwischen HubSpot und anderen Systemen zu synchronisieren.
POST
-Anfrage an /crm/v3/objects/companies
durch.
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.
name
oder domain
. Es wird empfohlen, domain
immer 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.
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.Parameter | Beschreibung |
---|---|
to | Der Datensatz oder die Aktivität, den bzw. die Sie dem Unternehmen zuordnen möchten, angegeben durch seinen eindeutigen id -Wert. |
types | Der Typ der Zuordnung zwischen Unternehmen und Datensatz/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/companies/{companyId}
durch.GET
-Anfrage an/crm/v3/objects/companies
durch.Parameter | Beschreibung |
---|---|
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. |
POST
-Anfrage an crm/v3/objects/companies/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 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:
Um Unternehmen mit aktuellen und historischen Werten für eine Eigenschaft abzurufen, könnte Ihre Anfrage wie folgt aussehen:
PATCH
-Anfrage an /crm/v3/objects/companies/{companyId}
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.PUT
-Anfrage an /crm/v3/objects/companies/{companyId}/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/companies/{companyId}/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 Unternehmen verknüpft sein.
Um die angepinnten Aktivitäten eines Unternehmens festzulegen oder zu aktualisieren, könnte Ihre Anfrage wie folgt aussehen:
DELETE
-Anfrage an /crm/v3/objects/companies/{companyId}
durch.
In der Referenzdokumentation erfahren Sie mehr über das Löschen mehrerer Unternehmen.