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.
Sie können Notizen in CRM-Datensätzen protokollieren, um Informationen zur Datensatzchronik hinzuzufügen oder einen Anhang einem Datensatz zuzuordnen. Wenn Sie z. B. eine Offline-Konversation nachverfolgen müssen, die Sie mit einem Kontakt geführt haben, ist es möglich, eine Notiz zu dessen Kontaktdatensatz hinzuzufügen, die Details und Dokumente zu dieser Konversation enthält. Andere Benutzer im Account können diese Notiz dann anzeigen und darauf verweisen.Notizen lassen sich entweder in HubSpot oder über die Notizen-API verwalten. Im Folgenden erfahren Sie, wie Sie Notizen über die API verwalten können. Alle verfügbaren Endpunkte finden Sie in der Referenzdokumentation.
Um eine Notiz zu erstellen, führen Sie eine POST-Anfrage an /crm/v3/objects/notes durch.Fügen Sie im Anfragetext in einem properties-Objekt Notizdetails hinzu. Sie können auch ein Objekt zur Zuordnung hinzufügen, um Ihre neue Notiz einem vorhandenen Datensatz (z. B. Kontakten, Unternehmen) zuzuordnen.
Im properties-Objekt können Sie die folgenden Felder einschließen:
Feld
Beschreibung
hs_timestamp
Erforderlich. Diese Feld markiert den Zeitpunkt der Erstellung der Notiz und bestimmt, wo sich die Notiz in der Datensatzchronik befindet. Sie können entweder einen Unix-Zeitstempel im Millisekunden- oder UTC-Format verwenden.
hs_note_body
Der Textinhalt der Notiz, begrenzt auf 65.536 Zeichen.
hubspot_owner_id
Die ID des zuständigen Mitarbeiters, die der zugeordnet ist. Diese Feld bestimmt den Benutzer, der in der Datensatzchronik in HubSpot als Notizersteller aufgeführt ist.
hs_attachment_ids
Die IDs der Anhänge der Notiz. Mehrere Anhang-IDs sind durch ein Semikolon getrennt.
Um eine Notiz zu erstellen und bestehenden Datensätzen zuzuordnen, schließen Sie ein Zuordnungsobjekt in Ihre Anfrage ein. Um beispielsweise eine Notiz zu erstellen und sie einem Unternehmen und einem Deal zuzuordnen, könnte Ihr Anfragetext wie folgt aussehen:
Falschen Code melden
Kopieren
KI fragen
// Example POST request to https://api.hubspot.com/crm/v3/objects/notes{ "properties": { "hs_timestamp": "2021-11-12T15:48:22Z", "hs_note_body": "Spoke with decision maker Carla. Attached the proposal and draft of contract.", "hubspot_owner_id": "14240720", "hs_attachment_ids": "24332474034;24332474044" }, "associations": [ { "to": { "id": 301 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 190 } ] }, { "to": { "id": 401 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 214 } ] } ]}
Im Zuordnungsobjekt sollten Sie Folgendes einschließen:
Feld
Beschreibung
to
Der Datensatz, den Sie der Notiz zuordnen möchten, angegeben durch seinen eindeutigen id-Wert.
types
Der Typ der Zuordnung zwischen Notiz und Datensatz. 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.
Erfahren Sie in der Referenzdokumentation mehr über die Batch-Erstellung von Notizen.
Sie können Notizen einzeln oder mehrere gleichzeitig (batchweise) abrufen. Um eine individuelle Notiz abzurufen, führen Sie eine GET-Anfrage an /crm/v3/objects/notes/{noteId} durch.Um eine Liste aller Notizen anzufordern, führen Sie eine GET-Anfrage an /crm/v3/objects/notes durch.Sie können für beide Endpunkte die folgenden Abfrageparameter in die Anfrage-URL einschließen:
Parameter
Beschreibung
properties
Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn die angefragte Notiz keinen Wert für eine Eigenschaft hat, wird sie nicht in der Antwort angezeigt.
associations
Eine durch Kommas getrennte Liste von Objekttypen, 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 beispielsweise Notizen mit ihrem Textinhalt und allen zugehörigen Kontakt-IDs abzurufen, könnte Ihre Anfrage-URL wie folgt aussehen:https://api.hubapi.com/crm/v3/objects/notes?limit=10&properties=hs_note_body&associations=contact&archived=false.Erfahren Sie in der Referenzdokumentation mehr über das Abrufen von Batch-Notizen nach interner ID oder eindeutigem Eigenschaftswert.
Sie können Notizen einzeln oder mehrere gleichzeitig (batchweise) aktualisieren. Um eine einzelne Notiz anhand ihrer Notiz-ID zu aktualisieren, führen Sie eine PATCH-Anfrage an /crm/v3/objects/notes/{noteId} durch.Fügen Sie im Anfragetext die Notizeigenschaften ein, die Sie aktualisieren möchten:
Falschen Code melden
Kopieren
KI fragen
// Example PATCH request to https://api.hubspot.com/crm/v3/objects/notes/{noteID}{ "properties": { "hs_note_body": "Spoke with decision maker Carla.", "hs_attachment_ids": "24332474034;24332474044" }}
HubSpot ignoriert Werte für schreibgeschützte und nicht vorhandene Eigenschaften. Um einen Eigenschaftswert zu löschen, übergeben Sie eine leere Zeichenfolge für die Eigenschaft im Anfragetext.Erfahren Sie in der Referenzdokumentation mehr über Notizen zur Batch-Aktualisierung.
Um eine Notiz anderen CRM-Datensätzen, z. B. einem Kontakt, zuzuordnen, führen Sie eine PUT-Anfrage an /crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId} durch. Die Anfrage-URL enthält die folgenden Felder:
Feld
Beschreibung
noteId
Die ID der Notiz.
toObjectType
Der Typ des Objekts, dem Sie die Notiz zuordnen möchten (z. B. Kontakt oder Unternehmen)
toObjectId
Die ID des Datensatzes, dem Sie die Notiz zuordnen möchten.
associationTypeId
Eine eindeutige ID, die den Zuordnungstyp zwischen der Notiz und dem anderen Objekt angibt. Die ID kann numerisch oder in Snake-Case (z. B. note_to_contact) dargestellt werden. Sie können den Wert über die Zuordnungen-API abrufen.
Ihre Anfrage-URL könnte beispielsweise wie folgt aussehen:https://api.hubspot.com/crm/v3/objects/notes/17147287858/associations/contact/581751/202
Um die Zuordnung zwischen einer Notiz und einem Datensatz zu entfernen, führen Sie eine DELETE-Anfrage an die gleiche URL wie oben durch:/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
Sie können eine Notiz in einem Datensatz anpinnen, sodass sie oben in der Chronik des Datensatzes bleibt. Die Notiz muss bereits vor dem Anpinnen dem Datensatz zugeordnet sein, und Sie können nur eine Aktivität pro Datensatz anpinnen. Um eine Notiz anzupinnen, berücksichtigen Sie die id der Notiz im hs_pinned_engagement_id-Feld, wenn Sie einen Datensatz über die Objekt-APIs erstellen oder aktualisieren. Erfahren Sie mehr über das Verwenden der Unternehmen-, Kontakte-, Deals-, Tickets- und Benutzerdefinierte Objekte-APIs.
Notizen lassen sich einzeln oder mehrere gleichzeitig (batchweise) löschen, wodurch die Notiz dem Papierkorb in HubSpot hinzugefügt wird. Sie können später die Notiz über die Datensatzchronik wiederherstellen.Um eine einzelne Notiz anhand ihrer Notiz-ID zu löschen, führen Sie eine DELETE-Anfrage an /crm/v3/objects/notes/{noteId} durch.Erfahren Sie mehr über das Löschen von Notizen in der Referenzdokumentation.
