Letzte Änderung: 22. August 2025
Run in Postman
Deals erstellen
Um neue Deals zu erstellen, führen Sie einePOST
-Anfrage an /crm/v3/objects/deals
durch.
Schließen Sie im Anforderungstext Ihre Dealdaten in ein properties
-Objekt ein. Sie können auch ein associations
-Objekt hinzufügen, um Ihren neuen Deal vorhandenen Datensätzen (z. B. Kontakte, Unternehmen) oder Aktivitäten (z. B. Meetings, Notizen) zuzuordnen.
Eigenschaften
Dealdetails werden in Dealeigenschaften gespeichert. HubSpot bietet eine Reihe von Standard Dealeigenschaften, aber Sie können auch benutzerdefinierte Eigenschaften erstellen. Beim Erstellen eines neuen sollten Sie die folgenden Eigenschaften in der Anfrage einschließen:dealname
, dealstage
und, wenn Sie mehrere haben, pipeline
. Wenn keine Pipeline angegeben ist, wird die Standard-Pipeline verwendet.
Um alle verfügbaren Eigenschaften anzuzeigen, können Sie eine Liste der Dealeigenschaften Ihres Accounts abrufen, indem Sie eine GET
-Anfrage an /crm/v3/properties/deals
durchführen. Erfahren Sie mehr über die Eigenschaften-API.
Hinweis:
Sie müssen die interne ID einer Dealphase oder -pipeline verwenden, wenn Sie einen Deal über die API erstellen. Die interne ID wird auch zurückgegeben, wenn Sie Deals über die API abrufen. Sie können die interne ID einer Dealphase oder -pipeline in Ihren Dealpipeline-Einstellungen finden.Zuordnungen
Beim Erstellen eines neuen Deals können Sie den Deal auch bestehenden Datensätzen oder Aktivitäten in einemassociations
-Objekt zuordnen. Um beispielsweise einen neuen Deal mit einem bestehenden Kontakt und Unternehmen zu verknüpfen, müsste Ihre Anfrage wie folgt aussehen:
associations
-Objekt sollten Sie Folgendes einschließen:
Parameter | Beschreibung |
---|---|
to | Der Datensatz oder die Aktivität, den bzw. die Sie dem Deal zuordnen möchten, angegeben durch seinen eindeutigen id -Wert. |
types | Der Typ der Zuordnung zwischen Deal 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. |
Deals abrufen
Sie können Deals einzeln oder mehrere gleichzeitig aktualisieren.- Um einen einzelnen Deal abzurufen, führen Sie eine
GET
-Anfrage an/crm/v3/objects/deals/{dealId}
durch. - Um eine Liste aller Deals anzufordern, führen Sie eine
GET
-Anfrage an/crm/v3/objects/deals
durch.
Parameter | Beschreibung |
---|---|
properties | Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn das angefragte Deal 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 das angefragte Deal 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 |
- Um einen Batch von bestimmten Deals nach Datensatz-ID oder einer benutzerdefinierten „Eindeutige ID“-Eigenschaft abzurufen, führen Sie eine
POST
-Anfrage ancrm/v3/objects/deals/batch/read
durch.- Der Batch-Endpunkt kann Zuordnungen nicht abrufen. Erfahren Sie, wie Sie Zuordnungen mit der Zuordnungen-API batchweise lesen.
- Um Deals anhand einer benutzerdefinierten „Eindeutige ID“-Eigenschaft anstelle der Deal-ID abzurufen, fügen Sie den
idProperty
-Parameter in den Anforderungstext ein, um den Namen der Eigenschaft anzugeben. Fügen Sie dann in dasinputs
-Array die Werte der Eigenschaft mit der eindeutigen ID und nicht die Deal-ID ein.
propertiesWithHistory
-Parameter wie unten gezeigt in den Anforderungstext aufnehmen.
Deals aktualisieren
Sie können Deals einzeln oder mehrere gleichzeitig aktualisieren. Bei vorhandenen Deals ist die Deal-ID ein eindeutiger Standardwert, mit dem Sie en Deal über die API aktualisieren können. Sie können Deals jedoch auch mithilfe benutzerdefinierter „Eindeutige ID“-Eigenschaften identifizieren und aktualisieren.- Um einen einzelnen Deal anhand seiner Datensatz-ID zu aktualisieren, führen Sie eine
PATCH
-Anfrage an/crm/v3/objects/deals/{dealId}
durch und schließen Sie die Daten ein, die Sie aktualisieren möchten. - Um mehrere Deals zu aktualisieren, führen Sie eine
POST
-Anfrage an/crm/v3/objects/deals/batch/update
durch. Fügen Sie im Anfragetext ein Array mit den IDs für die Deals und die Eigenschaften hinzu, die Sie aktualisieren möchten.
Bestehende Deals mit Datensätzen oder Aktivitäten verknüpfen
Um einen Deal anderen CRM-Datensätzen oder einer Aktivität zuzuordnen, führen Sie einePUT
-Anfrage an /crm/v3/objects/deals/{dealId}/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.Eine Zuordnung entfernen
Um eine Zuordnung zwischen einem Deal und einem Datensatz oder einer Aktivität zu entfernen, führen Sie eineDELETE
-Anfrage an die folgende URL durch: /crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Eine Aktivität an einen Dealdatensatz anpinnen
Sie können eine Aktivität über die API an einen Dealdatensatz anpinnen, indem Sie denhs_pinned_engagement_id
-Parameter in die Anfrage aufnehmen. Geben Sie für den Wert des Parameters 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 Anheften mit dem Deal verknüpft sein.
Um die angepinnten Aktivitäten eines Deals festzulegen oder zu aktualisieren, könnte Ihre Anfrage wie folgt aussehen:
Deals löschen
Sie können Deals einzeln oder mehrere gleichzeitig löschen, wodurch der Deal in den Papierkorb in HubSpot verschoben wird. Sie können den Deal später in HubSpot wiederherstellen.- Um einen einzelnen Deal anhand seiner ID zu löschen, führen Sie eine
DELETE
-Anfrage an/crm/v3/objects/deals/{dealId}
durch. Für diese Anfrage ist kein Anforderungstext erforderlich. - Um Deals batchweise zu löschen, stellen Sie eine
POST
Anfrage an/crm/v3/objects/deals/batch/archive
. Fügen Sie im Anforderungstext die Deal-ID-Werte alsid
-Eingaben ein, wie im folgenden Anforderungstext gezeigt.