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.
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.
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. |
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. |
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. |
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.
PATCH
-Anfrage an /crm/v3/objects/notes/{noteId}
durch.
Fügen Sie im Anfragetext die Notizeigenschaften ein, die Sie aktualisieren möchten:
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. |
https://api.hubspot.com/crm/v3/objects/notes/17147287858/associations/contact/581751/202
DELETE
-Anfrage an die gleiche URL wie oben durch:
/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
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.
DELETE
-Anfrage an /crm/v3/objects/notes/{noteId}
durch.
Erfahren Sie mehr über das Löschen von Notizen in der Referenzdokumentation.