Verwenden Sie die E-Mail-Interaktionen-API, um E-Mails in CRM-Datensätzen zu protokollieren und zu verwalten.
POST
-Anfrage an /crm/v3/objects/emails
durch.
Fügen Sie im Anfragetext E-Mail-Details in einem properties-Objekt hinzu. Sie können auch ein associations-Objekt hinzufügen, um Ihre neue E-Mail einem vorhandenen Datensatz (z. B. Kontakten, Unternehmen) zuzuordnen.
Feld | Beschreibung |
---|---|
hs_timestamp | Erforderlich. Dieses Feld markiert den Zeitpunkt der Erstellung der E-Mail und bestimmt, wo Sie die E-Mail in der Datensatzchronik finden. Sie können entweder einen Unix-Zeitstempel im Millisekunden- oder UTC-Format verwenden. |
hubspot_owner_id | Die ID des zuständigen Mitarbeiters, der der E-Mail zugeordnet ist. Dieses Feld bestimmt den Benutzer, der in der Datensatzchronik als E-Mail-Ersteller aufgeführt ist. |
hs_email_direction | Die Richtung, in der die E-Mail gesendet wurde Mögliche Werte sind: EMAIL : Die E-Mail wurde vom CRM aus gesendet oder wurde gesendet und mit der BCC-Adresse beim CRM protokolliert. INCOMING_EMAIL : Die E-Mail war eine Antwort auf eine protokollierte ausgehende E-Mail. FORWARDED_EMAIL : Die E-Mail wurde an das CRM weitergeleitet. |
hs_email_html | Der Text einer E-Mail, wenn sie von einem CRM-Datensatz gesendet wird. |
hs_email_status | Der Sendestatus der E-Mail. Der Wert kann BOUNCED , FAILED , SCHEDULED , SENDING oder SENT sein. |
hs_email_subject | Die Betreffzeile der protokollierten E-Mail. |
hs_email_text | Der Text der E-Mail. |
hs_attachment_ids | Die IDs der Anhänge der E-Mail. Mehrere Anhang-IDs sind durch ein Semikolon getrennt. |
hs_email_headers | Die Header der E-Mail. Der Wert für diese Eigenschaft wird automatisch in bestimmte schreibgeschützte E-Mail-Eigenschaften übernommen. Erfahren Sie, wie Sie E-Mail-Header festlegen. |
hs_email_headers
-Wert übernommen.
Feld | Beschreibung |
---|---|
hs_email_from_email | Die E-Mail-Adresse des Absenders der E-Mail |
hs_email_from_firstname | Der Vorname des E-Mail-Absenders |
hs_email_from_lastname | Der Nachname des E-Mail-Absenders |
hs_email_to_email | Die E-Mail-Adressen der Empfänger der E-Mail |
hs_email_to_firstname | Die Vornamen der Empfänger der E-Mail |
hs_email_to_lastname | Die Nachnamen der Empfänger der E-Mail |
From
als auch Sender
Werte vorhanden sind. Diese sind oft identisch, aber da Sender
identifiziert, durch was eine E-Mail tatsächlich gesendet wurde, gibt es Szenarien, in denen die Werte abweichen können. Wird beispielsweise eine E-Mail von einem E-Mail-Alias gesendet, bezieht sich der From
-Wert auf die tatsächliche E-Mail-Adresse des Benutzers und der Sender
-Wert auf den E-Mail-Alias.hs_email_headers
-Wert festzulegen, können Sie eine mit JSON-Escape-Zeichen versehene Zeichenfolge mit den folgenden Daten verwenden:
Feld | Beschreibung |
---|---|
to | Der Datensatz, den Sie der E-Mail zuordnen möchten, angegeben durch ihren eindeutigen id -Wert. |
types | Der Typ der Zuordnung zwischen E-Mail 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/emails/{emailId}
durch. Sie können auch die folgenden Parameter in der Anfrage-URL berücksichtigen:
Parameter | Beschreibung |
---|---|
properties | Eine durch Kommas getrennte Liste der Eigenschaften, die zurückgegeben werden sollen. |
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. |
GET
-Anfrage an crm/v3/objects/emails
durch. Sie können die folgenden Parameter in der Anfrage-URL berücksichtigen:
Parameter | Beschreibung |
---|---|
limit | Die maximale Anzahl an Ergebnissen, die pro Seite angezeigt werden können. |
properties | Eine durch Kommas getrennte Liste der Eigenschaften, die zurückgegeben werden sollen. |
PATCH
-Anfrage an /crm/v3/objects/emails/{emailId}
durch.
Fügen Sie im Anfragetext die E-Mail-Eigenschaften ein, die Sie aktualisieren möchten. Ihr Anfragetext kann beispielsweise wie folgt aussehen:
PUT
-Anfrage an /crm/v3/objects/emails/{emailId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
durch. Die Anfrage-URL enthält die folgenden Felder:
Feld | Beschreibung |
---|---|
emailId | Die ID der E-Mail |
toObjectType | Der Typ des Objekts, dem Sie die E-Mail zuordnen möchten (z. B. Kontakt oder Unternehmen) |
toObjectId | Die ID des Datensatzes, dem Sie die E-Mail zuordnen möchten |
associationTypeId | Eine eindeutige ID, die den Zuordnungstyp zwischen der E-Mail und dem anderen Objekt angibt. Die ID kann numerisch oder in Snake-Case (z. B. email_to_contact ) dargestellt werden. Sie können den Wert über die Zuordnungen-API abrufen. |
https://api.hubspot.com/crm/v3/objects/emails/17691787884/associations/contact/104901/198
DELETE
-Anfrage an die gleiche URL wie oben durch:
/crm/v3/objects/emails/{emailId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
id
der E-Mail 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/emails/{emailId}
durch.
Weitere Informationen zum Löschen von E-Mails finden Sie in der Referenzdokumentation.