Letzte Änderung: 22. August 2025
Run in Postman
Tickets erstellen
Um neue Tickets zu erstellen, führen Sie einePOST
-Anfrage an /crm/v3/objects/tickets
durch.
Schließen Sie in Ihrer Anfrage Ihre Ticket-Daten in ein properties-Objekt ein. Sie können auch ein associations-Objekt hinzufügen, um Ihrem neuen Ticket vorhandene Datensätze (z. B. Kontakte, Unternehmen) oder Aktivitäten (z. B. Meetings, Notizen) zuzuordnen.
Eigenschaften
Ticket-Details werden in Ticket-Eigenschaften gespeichert. Es gibt Standard-HubSpot-Ticket-Eigenschaften, Sie können jedoch auch benutzerdefinierte Eigenschaften erstellen. Beim Erstellen eines neuen Tickets sollten Sie die folgenden Eigenschaften in Ihrer Anfrage berücksichtigen:subject
(Name des Tickets), hs_pipeline_stage
(Status des Tickets) und, wenn Sie mehrere Pipelines haben, hs_pipeline
. Wenn keine Pipeline angegeben ist, wird die Standard-Pipeline verwendet.
Um alle verfügbaren Eigenschaften anzuzeigen, können Sie eine Liste der Ticket-Eigenschaften Ihres Accounts abrufen, indem Sie eine GET
-Anfrage an /crm/v3/properties/tickets
durchführen. Erfahren Sie mehr über die Eigenschaften-API.
Hinweis: Sie müssen die interne ID eines Ticket-Status oder einer Ticket-Pipeline verwenden, wenn Sie ein Ticket über die API erstellen. Die interne ID ist eine Nummer, die auch zurückgegeben wird, wenn Sie Tickets über die API abrufen. Sie können die interne ID eines Ticket-Status oder einer Ticket-Pipeline in Ihren Ticket-Pipeline-Einstellungen finden.
Zuordnungen
Beim Erstellen eines neuen Tickets können Sie das Ticket auch bestehenden Datensätzen oder Aktivitäten zuordnen, indem Sie ein associations-Objekt einschließen. Um beispielsweise ein neues Ticket mit einem bestehenden Kontakt und Unternehmen zu verknüpfen, müsste Ihre Anfrage wie folgt aussehen:Parameter | Beschreibung |
---|---|
to | Der Datensatz oder die Aktivität, den bzw. die Sie dem Ticket zuordnen möchten, angegeben durch seinen eindeutigen id -Wert. |
types | Der Typ der Zuordnung zwischen Ticket 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. |
Tickets abrufen
Sie können Tickets einzeln oder mehrere gleichzeitig (batchweise) abrufen.- Um ein einzelnes Ticket abzurufen, führen Sie eine
GET
-Anfrage an/crm/v3/objects/tickets/{ticketId}
durch. - Um eine Liste aller Tickets anzufordern, führen Sie eine
GET
-Anfrage an/crm/v3/objects/tickets
durch.
Parameter | Beschreibung |
---|---|
properties | Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn das angefragte Ticket 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 Ticket 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. |
- Um einen Batch von bestimmten Tickets nach Datensatz-ID oder einer benutzerdefinierten „Eindeutige ID“-Eigenschaft abzurufen, führen Sie eine
POST
-Anfrage ancrm/v3/objects/tickets/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 Tickets 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 Tickets zu verwenden, müssen Sie den idProperty
-Parameter einschließen.
Um beispielsweise einen Batch von Tickets abzurufen, könnte Ihre Anfrage wie folgt aussehen:
Um Tickets mit aktuellen und historischen Werten für eine Eigenschaft abzurufen, könnte Ihre Anfrage wie folgt aussehen:
Tickets aktualisieren
Sie haben die Möglichkeit, Tickets einzeln oder mehrere gleichzeitig (batchweise) zu aktualisieren. Bei vorhandenen Tickets ist die Datensatz-ID ein eindeutiger Standardwert, mit dem sich das Ticket über die API aktualisieren lässt. Sie können Tickets jedoch auch mithilfe benutzerdefinierter „Eindeutige ID“-Eigenschaften identifizieren und aktualisieren.- Um ein einzelnes Ticket anhand seiner Datensatz-ID zu aktualisieren, führen Sie eine
PATCH
-Anfrage an/crm/v3/objects/tickets/{ticketId}
durch und schließen Sie die Daten ein, die Sie aktualisieren möchten. - Um mehrere Tickets zu aktualisieren, führen Sie eine
POST
-Anfrage an/crm/v3/objects/tickets/batch/update
durch. Fügen Sie im Anfragetext ein Array mit den IDs für die Tickets und die Eigenschaften hinzu, die Sie aktualisieren möchten.
Vorhandene Tickets mit Datensätzen oder Aktivitäten verknüpfen
Um ein Ticket anderen CRM-Datensätzen oder einer Aktivität zuzuordnen, führen Sie einePUT
-Anfrage an /crm/v3/objects/tickets/{ticketId}/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 Ticket und einem Datensatz oder einer Aktivität zu entfernen, führen Sie eineDELETE
-Anfrage an die folgende URL durch: /crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Eine Aktivität an einen Ticket-Datensatz anpinnen
Sie können eine Aktivität über die API an eine Ticket-Datensatz anpinnen, indem Sie dashs_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 Anheften mit dem Ticket verknüpft sein.
Um die angepinnten Aktivitäten eines Tickets festzulegen oder zu aktualisieren, könnte Ihre Anfrage wie folgt aussehen:
Tickets löschen
Sie können Tickets einzeln oder mehrere gleichzeitig (batchweise) löschen, wodurch der Ticket in den Papierkorb in HubSpot verschoben wird. Sie können das Ticket später in HubSpot wiederherstellen. Um ein einzelnes Ticket anhand seiner ID zu löschen, führen Sie eineDELETE
-Anfrage an /crm/v3/objects/tickets/{ticketId}
durch.
Erfahren Sie in der Referenzdokumentation mehr über das Löschen von Tickets.