HubSpot Marketing V2 (Unabhängiger Herausgeber) (Vorschau)
Marketingsoftware, mit der Sie Umsatz steigern, Zeit und Ressourcen sparen und Ihre Investitionen messen und optimieren können. Alles auf einer einfach zu bedienenden Plattform. Steigern Sie den Umsatz, indem Sie sich mit Leads zu dem richtigen Zeitpunkt und Ort über E-Mails, Zielseiten, Formulare und vieles mehr verbinden. Verwalten Sie Ihre Kontakte und Kampagnen an einem zentralen Ort und verwenden Sie Automatisierungstools, um Ihre Effizienz zu skalieren. Messen Sie den Erfolg Ihrer Kampagnen mithilfe leistungsstarker Berichterstellungstools.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Troy Taylor |
| Webseite | https://www.hubspot.com/products/marketing |
| Datenschutzrichtlinie | https://legal.hubspot.com/privacy-policy |
| Kategorien | Marketing |
HubSpot Marketing V2
Marketingsoftware, mit der Sie Umsatz steigern, Zeit und Ressourcen sparen und Ihre Investitionen messen und optimieren können. Alles auf einer einfach zu bedienenden Plattform. Steigern Sie den Umsatz, indem Sie sich mit Leads zu dem richtigen Zeitpunkt und Ort über E-Mails, Zielseiten, Formulare und vieles mehr verbinden. Verwalten Sie Ihre Kontakte und Kampagnen an einem zentralen Ort und verwenden Sie Automatisierungstools, um Ihre Effizienz zu skalieren. Messen Sie den Erfolg Ihrer Kampagnen mithilfe leistungsstarker Berichterstellungstools.
Herausgeber: Troy Taylor, Hitachi Solutions
Voraussetzungen
Sie müssen über ein Konto mit HubSpot verfügen und ein Super-Administrator sein.
Abrufen von Anmeldeinformationen
Sobald Sie bei Ihrem Konto angemeldet sind, wechseln Sie zu "Einstellungen" –> Kontoeinrichtung –> Integrationen –> Private Apps. Sie müssen eine private App erstellen und nur die Bereiche zuweisen, für die Sie Aktionen verwenden. Nachdem Ihre private App erstellt wurde, verfügen Sie im Abschnitt "Authentifizierung" der privaten App über ein Zugriffstoken.
Unterstützte Vorgänge
E-Mail senden
Senden Sie asynchron eine Transaktions-E-Mail. Gibt den Status der E-Mail-Nachricht mit einem Statusbezeichner zurück, der verwendet werden kann, um den Status kontinuierlich mithilfe des E-Mail-Sendestatus abzufragen.
Kontakt abonnieren
Abonniert einen Kontakt mit dem angegebenen Abonnementtyp. Diese Aktion ist nicht gültig, um einen Kontakt auf Marken- oder Portalebene zu abonnieren und gibt einen Fehler zurück.
Kontakt kündigen
Gekündigt einen Kontakt vom angegebenen Abonnementtyp. Diese Aktion ist nicht gültig, um einen Kontakt auf Marken- oder Portalebene zu kündigen und gibt einen Fehler zurück.
Abrufen von Status des Kontaktabonnements
Gibt eine Liste der Abonnements und deren Status für einen bestimmten Kontakt zurück.
Erstellen von Massenkommunikationseinstellungen
Erstellt eine Anforderung für Massenkommunikationseinstellungen. Diese Anforderung gibt einen Statusbezeichner zurück, der verwendet werden kann, um den Status kontinuierlich mithilfe des Status der Massenkommunikationseinstellungen abzufragen.
Abrufen von Abonnementdefinitionen
Ruft eine Liste aller Abonnementdefinitionen für das Portal ab.
Aggregierte Statistiken abrufen
Ruft aggregierte Statistiken von E-Mails ab, die in einer bestimmten Zeitspanne gesendet wurden. Außerdem wird die Liste der E-Mails zurückgegeben, die während der Zeitspanne gesendet wurden.
Abrufen aggregierter Statistikintervalle
Ruft aggregierte Statistiken in Intervallen für eine angegebene Zeitspanne ab. Jedes Intervall enthält aggregierte Statistiken zu den E-Mails, die zu diesem Zeitpunkt gesendet wurden.
Abrufen einer AB Marketing-E-Mail-Variation
Ruft die Variation einer A/B-Marketing-E-Mail ab. Wenn die E-Mail Variation A (Master) ist, gibt sie Variation B (Variante) zurück und umgekehrt.
Entwurf zurücksetzen
Setzt den Entwurf auf eine Kopie des Liveobjekts zurück.
Wiederherstellen von Marketing-E-Mails
Stellt eine vorherige Überarbeitung einer Marketing-E-Mail im ENTWURFSzustand wieder her. Wenn derzeit etwas im Entwurf für dieses Objekt vorhanden ist, wird es überschrieben.
Marketing-E-Mail-Entwurf abrufen
Ruft die Entwurfsversion einer E-Mail ab (sofern vorhanden). Wenn keine Entwurfsversion vorhanden ist, wird die veröffentlichte E-Mail zurückgegeben.
Erstellen oder Aktualisieren von E-Mail-Entwürfen
Erstellt oder aktualisiert die Entwurfsversion einer Marketing-E-Mail. Wenn kein Entwurf vorhanden ist, erstellt das System einen Entwurf aus der aktuellen "live"-E-Mail, und wendet dann den Anforderungstext auf diesen Entwurf an. Die Entwurfsversion befindet sich nur im Puffer – die E-Mail wird nicht geklont.
Abrufen von Marketing-E-Mail-Überarbeitungen
Ruft eine Liste aller Versionen einer Marketing-E-Mail mit jedem Eintrag ab, einschließlich des vollständigen Status dieser bestimmten Version. Die aktuelle Revision hat die ID -1.
Abrufen einer Überarbeitung einer Marketing-E-Mail
Ruft eine bestimmte Überarbeitung einer Marketing-E-Mail ab.
Erstellen von AB-Testmarketing-E-Mails
Erstellt eine Variation einer Marketing-E-Mail für einen A/B-Test. Die neue Variation wird als Entwurf erstellt. Wenn bereits eine aktive Variation vorhanden ist, wird kein neues erstellt.
Abrufen von Marketing-E-Mails
Dient zum Abrufen einer Liste aller Marketing-E-Mails. Die Ergebnisse können gefiltert werden, sodass Sie einen bestimmten Satz von E-Mails finden können.
Erstellen von Marketing-E-Mails
Erstellt eine neue Marketing-E-Mail.
Wiederherstellen der Marketing-E-Mail-Revision
Stellt eine vorherige Überarbeitung einer Marketing-E-Mail wieder her. Die aktuelle Revision wird alt, und die wiederhergestellte Revision erhält eine neue Versionsnummer.
Klonen von Marketing-E-Mails
Erstellt eine duplizierte E-Mail mit denselben Eigenschaften wie das Original, mit Ausnahme eines eindeutigen Bezeichners.
Abrufen von Marketing-E-Mails
Ruft die Details für eine Marketing-E-Mail ab.
Löschen von Marketing-E-Mails
Löscht eine Marketing-E-Mail.
Aktualisieren von Marketing-E-Mails
Ändern der Eigenschaften einer Marketing-E-Mail.
Erstellen eines SMTP-Tokens
Erstellt ein SMTP-Token.
Smtp-Token abfragen
Fragt mehrere SMTP-Token nach Kampagnenname oder einem einzelnen Token nach E-Mail-Kampagnen-ID ab.
Token löschen
Löscht ein einzelnes Token nach Bezeichner.
Abfragetoken
Fragt ein einzelnes Token nach Bezeichner ab.
Tokenkennwort zurücksetzen
Ermöglicht die Erstellung eines Ersatzkennworts für ein bestimmtes Token. Nachdem das Kennwort erfolgreich zurückgesetzt wurde, ist das alte Kennwort für das Token ungültig.
Bekannte Probleme und Einschränkungen
Derzeit gibt es keine bekannten Probleme.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Zugriffstoken (im Format "Bearer YOUR_ACCESS_TOKEN") | securestring | Das Zugriffstoken (im Format "Bearer YOUR_ACCESS_TOKEN") für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abfragetoken |
Fragt ein einzelnes Token nach Bezeichner ab. |
| Abrufen aggregierter Statistikintervalle |
Ruft aggregierte Statistiken in Intervallen für eine angegebene Zeitspanne ab. Jedes Intervall enthält aggregierte Statistiken zu den E-Mails, die zu diesem Zeitpunkt gesendet wurden. |
| Abrufen einer AB Marketing-E-Mail-Variation |
Ruft die Variation einer A/B-Marketing-E-Mail ab. Wenn die E-Mail Variation A (Master) ist, gibt sie Variation B (Variante) zurück und umgekehrt. |
| Abrufen einer Überarbeitung einer Marketing-E-Mail |
Ruft eine bestimmte Überarbeitung einer Marketing-E-Mail ab. |
| Abrufen von Abonnementdefinitionen |
Ruft eine Liste aller Abonnementdefinitionen für das Portal ab. |
| Abrufen von Marketing-E-Mail-Überarbeitungen |
Ruft eine Liste aller Versionen einer Marketing-E-Mail mit jedem Eintrag ab, einschließlich des vollständigen Status dieser bestimmten Version. Die aktuelle Revision hat die ID -1. |
| Abrufen von Marketing-E-Mails |
Ruft die Details für eine Marketing-E-Mail ab. |
| Abrufen von Marketing-E-Mails |
Dient zum Abrufen einer Liste aller Marketing-E-Mails. Die Ergebnisse können gefiltert werden, sodass Sie einen bestimmten Satz von E-Mails finden können. |
| Abrufen von Status des Kontaktabonnements |
Gibt eine Liste der Abonnements und deren Status für einen bestimmten Kontakt zurück. |
| Aggregierte Statistiken abrufen |
Ruft aggregierte Statistiken von E-Mails ab, die in einer bestimmten Zeitspanne gesendet wurden. Außerdem wird die Liste der E-Mails zurückgegeben, die während der Zeitspanne gesendet wurden. |
| Aktualisieren von Marketing-E-Mails |
Ändern der Eigenschaften einer Marketing-E-Mail. |
| E-Mail senden |
Senden Sie asynchron eine Transaktions-E-Mail. Gibt den Status der E-Mail-Nachricht mit einem Statusbezeichner zurück, der verwendet werden kann, um den Status kontinuierlich mithilfe des E-Mail-Sendestatus abzufragen. |
| Entwurf zurücksetzen |
Setzt den Entwurf auf eine Kopie des Liveobjekts zurück. |
| Erstellen eines SMTP-Tokens |
Erstellt ein SMTP-Token. |
| Erstellen oder Aktualisieren von E-Mail-Entwürfen |
Erstellt oder aktualisiert die Entwurfsversion einer Marketing-E-Mail. Wenn kein Entwurf vorhanden ist, erstellt das System einen Entwurf aus der aktuellen "live"-E-Mail, und wendet dann den Anforderungstext auf diesen Entwurf an. Die Entwurfsversion befindet sich nur im Puffer – die E-Mail wird nicht geklont. |
| Erstellen von AB-Testmarketing-E-Mails |
Erstellt eine Variation einer Marketing-E-Mail für einen A/B-Test. Die neue Variation wird als Entwurf erstellt. Wenn bereits eine aktive Variation vorhanden ist, wird kein neues erstellt. |
| Erstellen von Marketing-E-Mails |
Erstellt eine neue Marketing-E-Mail. |
| Erstellen von Massenkommunikationseinstellungen |
Erstellt eine Anforderung für Massenkommunikationseinstellungen. Diese Anforderung gibt einen Statusbezeichner zurück, der verwendet werden kann, um den Status kontinuierlich mithilfe des Status der Massenkommunikationseinstellungen abzufragen. |
| Klonen von Marketing-E-Mails |
Erstellt eine duplizierte E-Mail mit denselben Eigenschaften wie das Original, mit Ausnahme eines eindeutigen Bezeichners. |
| Kontakt abonnieren |
Abonniert einen Kontakt mit dem angegebenen Abonnementtyp. Diese Aktion ist nicht gültig, um einen Kontakt auf Marken- oder Portalebene zu abonnieren und gibt einen Fehler zurück. |
| Kontakt kündigen |
Gekündigt einen Kontakt vom angegebenen Abonnementtyp. Diese Aktion ist nicht gültig, um einen Kontakt auf Marken- oder Portalebene zu kündigen und gibt einen Fehler zurück. |
| Löschen von Marketing-E-Mails |
Löscht eine Marketing-E-Mail. |
| Marketing-E-Mail-Entwurf abrufen |
Ruft die Entwurfsversion einer E-Mail ab (sofern vorhanden). Wenn keine Entwurfsversion vorhanden ist, wird die veröffentlichte E-Mail zurückgegeben. |
| Smtp-Token abfragen |
Fragt mehrere SMTP-Token nach Kampagnenname oder einem einzelnen Token nach E-Mail-Kampagnen-ID ab. |
| Token löschen |
Löscht ein einzelnes Token nach Bezeichner. |
| Tokenkennwort zurücksetzen |
Ermöglicht die Erstellung eines Ersatzkennworts für ein bestimmtes Token. Nachdem das Kennwort erfolgreich zurückgesetzt wurde, ist das alte Kennwort für das Token ungültig. |
| Wiederherstellen der Marketing-E-Mail-Revision |
Stellt eine vorherige Überarbeitung einer Marketing-E-Mail wieder her. Die aktuelle Revision wird alt, und die wiederhergestellte Revision erhält eine neue Versionsnummer. |
| Wiederherstellen von Marketing-E-Mails |
Stellt eine vorherige Überarbeitung einer Marketing-E-Mail im ENTWURFSzustand wieder her. Wenn derzeit etwas im Entwurf für dieses Objekt vorhanden ist, wird es überschrieben. |
Abfragetoken
Fragt ein einzelnes Token nach Bezeichner ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
tokenId | True | string |
Der Tokenbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kampagnenname
|
campaignName | string |
Der Kampagnenname. |
|
Kontakt erstellen
|
createContact | string |
Der Kontakt erstellen. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Erstellt von
|
createdBy | string |
Das erstellt von. |
|
E-Mail-Kampagnen-ID
|
emailCampaignId | string |
Die E-Mail-Kampagnen-ID. |
|
ID
|
id | string |
Der Bezeichner. |
|
Kennwort
|
password | string |
Das Kennwort. |
Abrufen aggregierter Statistikintervalle
Ruft aggregierte Statistiken in Intervallen für eine angegebene Zeitspanne ab. Jedes Intervall enthält aggregierte Statistiken zu den E-Mails, die zu diesem Zeitpunkt gesendet wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Intervall
|
interval | string |
Das Intervall. |
|
|
Start
|
startTimestamp | string |
Der Startzeitstempel. |
|
|
ENDE
|
endTimestamp | string |
Der Endzeitstempel. |
|
|
E-Mail-IDs
|
emailIds | string |
Die E-Mail-IDs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnisse
|
results | array of object | |
|
ENDE
|
results.interval.end | string |
Das Ende. |
|
Start
|
results.interval.start | string |
Der Anfang. |
|
Total
|
total | integer |
Die Summe. |
Abrufen einer AB Marketing-E-Mail-Variation
Ruft die Variation einer A/B-Marketing-E-Mail ab. Wenn die E-Mail Variation A (Master) ist, gibt sie Variation B (Variante) zurück und umgekehrt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Name
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Abrufen einer Überarbeitung einer Marketing-E-Mail
Ruft eine bestimmte Überarbeitung einer Marketing-E-Mail ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
|
Revisions-ID
|
revisionId | True | string |
Der Revisionsbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | string |
Der Bezeichner. |
|
Vorlagenpfad
|
object.content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
object.content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Name
|
object.from.fromName | string |
Der Name. |
|
Antworten an
|
object.from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
object.from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
object.id | string |
Der Bezeichner. |
|
Name
|
object.name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
object.sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
object.state | string |
Das Land/die Region. |
|
Unterkategorie
|
object.subcategory | string |
Die Unterkategorie. |
|
Betreff
|
object.subject | string |
Der Betreff. |
|
Include
|
object.to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
object.to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
object.to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
object.to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
object.to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
object.to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
object.createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
object.type | string |
Der Typ. |
|
Aktive Domäne
|
object.activeDomain | string |
Die aktive Domäne. |
|
Archived
|
object.archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
object.folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
object.feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
object.testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
object.testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
object.testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
object.testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
object.testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
object.testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
object.testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
ID
|
object.subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
object.subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
object.subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
object.updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
object.publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
object.language | string |
Die Sprache. |
|
Kampagne
|
object.campaign | string |
Die Kampagne. |
|
Slug
|
object.webversion.slug | string |
Der Strich. |
|
Domäne
|
object.webversion.domain | string |
Die Domäne. |
|
Title
|
object.webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
object.webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
object.webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
object.webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
object.webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
object.rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
object.rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
object.rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
object.rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
object.rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
object.rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
object.rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
object.rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
object.isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
object.isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
object.publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
object.updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
object.createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
object.deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
object.publishedAt | string |
Wann veröffentlicht unter. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Email
|
user.email | string |
Die E-Mail-Adresse. |
|
Vollständiger Name
|
user.fullName | string |
Der vollständige Name. |
|
ID
|
user.id | string |
Der Bezeichner. |
Abrufen von Abonnementdefinitionen
Ruft eine Liste aller Abonnementdefinitionen für das Portal ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abonnementdefinitionen
|
subscriptionDefinitions | array of object | |
|
Erstellt unter
|
subscriptionDefinitions.createdAt | string |
Beim Erstellen bei. |
|
Description
|
subscriptionDefinitions.description | string |
Die Beschreibung. |
|
ID
|
subscriptionDefinitions.id | string |
Der Bezeichner. |
|
Ist aktiv
|
subscriptionDefinitions.isActive | boolean |
Gibt an, ob aktiv ist. |
|
Ist Standard
|
subscriptionDefinitions.isDefault | boolean |
Gibt an, ob der Standardwert ist. |
|
Ist intern
|
subscriptionDefinitions.isInternal | boolean |
Gibt an, ob es sich um eine interne Datei handelt. |
|
Name
|
subscriptionDefinitions.name | string |
Der Name. |
|
Aktualisiert unter
|
subscriptionDefinitions.updatedAt | string |
Wenn aktualisiert unter. |
|
Zweck
|
subscriptionDefinitions.purpose | string |
Der Zweck. |
|
Communication-Methode
|
subscriptionDefinitions.communicationMethod | string |
Die Kommunikationsmethode. |
Abrufen von Marketing-E-Mail-Überarbeitungen
Ruft eine Liste aller Versionen einer Marketing-E-Mail mit jedem Eintrag ab, einschließlich des vollständigen Status dieser bestimmten Version. Die aktuelle Revision hat die ID -1.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nach
|
after | string |
Das Nachher. |
|
|
Vorher
|
before | string |
Das vorher. |
|
|
Limit
|
limit | string |
Die Grenze. |
|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnisse
|
results | array of object | |
|
ID
|
results.id | string |
Der Bezeichner. |
|
AB-Stunden warten
|
results.object.abHoursToWait | string |
Die A/B-Stunden, die gewartet werden sollen. |
|
AB-Status
|
results.object.abStatus | string |
Der A/B-Status. |
|
AB Test-ID
|
results.object.abTestId | string |
Der A/B-Testbezeichner. |
|
Archiviert unter
|
results.object.archivedAt | string |
Bei archivierung bei. |
|
Archiviert im Dashboard
|
results.object.archivedInDashboard | boolean |
Gibt an, ob im Dashboard archiviert wird. |
|
Angefügte Stylesheets
|
results.object.attachedStylesheets | array of object |
Das angefügte Stylesheets-Objekt. |
|
Autor
|
results.object.authorName | string |
Der Name des Autors. |
|
Blog-E-Mail-Typ
|
results.object.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Kampagne
|
results.object.campaign | string |
Die Kampagne. |
|
Kategorie-ID
|
results.object.categoryId | string |
Der Kategoriebezeichner. |
|
Inhaltsgruppen-ID
|
results.object.contentGroupId | string |
Der Inhaltsgruppenbezeichner. |
|
Inhaltstypkategorie
|
results.object.contentTypeCategory | string |
Die Inhaltstypkategorie. |
|
Seite erstellen
|
results.object.createPage | string |
Die Seite "Erstellen". |
|
Erstellt
|
results.object.created | string |
Beim Erstellen. |
|
Erstellt anhand der ID
|
results.object.createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Aktueller Zustand
|
results.object.currentState | string |
Der aktuelle Zustand. |
|
Zurzeit veröffentlicht
|
results.object.currentlyPublished | boolean |
Gibt an, ob zurzeit veröffentlicht wird. |
|
Benutzerdefinierte Antwort auf
|
results.object.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
Benutzerdefinierte Antwort aktiviert
|
results.object.customReplyToEnabled | boolean |
Gibt an, ob benutzerdefinierte Antwort aktiviert ist. |
|
Domäne
|
results.object.domain | string |
Die Domäne. |
|
Datenquellen-ID für dynamische Seiten
|
results.object.dynamicPageDataSourceId | string |
Der Bezeichner für dynamische Seitendatenquelle. |
|
Datenquellentyp für dynamische Seiten
|
results.object.dynamicPageDataSourceType | string |
Der Datenquellentyp für dynamische Seiten. |
|
Dynamic Page HubDb-Tabellen-ID
|
results.object.dynamicPageHubDbTableId | string |
Der HubDb-Tabellenbezeichner der dynamischen Seite. |
|
E-Mail-Typ
|
results.object.emailType | string |
Der E-Mail-Typ. |
|
Aktivieren von Domänen-Stylesheets
|
results.object.enableDomainStylesheets | boolean |
Gibt an, ob Domänenformatvorlagen aktiviert werden sollen. |
|
Layout-Stylesheets aktivieren
|
results.object.enableLayoutStylesheets | boolean |
Gibt an, ob Layout-Stylesheets aktiviert werden sollen. |
|
Empfohlenes Bild
|
results.object.featuredImage | string |
Das empfohlene Bild. |
|
Empfohlenes Bild alternativtext
|
results.object.featuredImageAltText | string |
Der empfohlene Alternativtext des Bilds. |
|
Ordner-ID
|
results.object.folderId | string |
Der Ordnerbezeichner. |
|
Fußzeilen-HTML
|
results.object.footerHtml | string |
Der HTML-Code der Fußzeile. |
|
Von
|
results.object.fromName | string |
Der Name. |
|
Kopf-HTML
|
results.object.headHtml | string |
Der HTML-Code für den Kopf. |
|
HTML-Titel
|
results.object.htmlTitle | string |
Der HTML-Titel. |
|
ID
|
results.object.id | string |
Der Bezeichner. |
|
Einschließen von benutzerdefiniertem Standard-CSS
|
results.object.includeDefaultCustomCss | boolean |
Gibt an, ob benutzerdefinierte Standard-CSS eingeschlossen werden soll. |
|
Ist Graumailunterdrückung aktiviert
|
results.object.isGraymailSuppressionEnabled | boolean |
Gibt an, ob die Graumailunterdrückung aktiviert ist. |
|
Language
|
results.object.language | string |
Die Sprache. |
|
Link Rel (kanonische URL)
|
results.object.linkRelCanonicalUrl | string |
Die link rel (kanonische URL-Adresse). |
|
Mab Experiment ID
|
results.object.mabExperimentId | string |
Der Mab-Experimentbezeichner. |
|
Ausgeschlossene Adressenlisten
|
results.object.mailingListsExcluded | array of string |
Das ausgeschlossene Array der Adressenlisten. |
|
Enthaltene Adressenlisten
|
results.object.mailingListsIncluded | array of string |
Die Adressenlisten enthalten ein Array. |
|
Max RSS-Einträge
|
results.object.maxRssEntries | integer |
Die maximalen RSS-Einträge. |
|
Metabeschreibung
|
results.object.metaDescription | string |
Die Metabeschreibung. |
|
Name
|
results.object.name | string |
Der Name. |
|
Seitenablaufdatum
|
results.object.pageExpiryDate | string |
Das Ablaufdatum der Seite. |
|
Seitenablauf aktiviert
|
results.object.pageExpiryEnabled | boolean |
Gibt an, ob der Seitenablauf aktiviert ist. |
|
Seitenablaufumleitungs-ID
|
results.object.pageExpiryRedirectId | string |
Der Bezeichner für die Seitenablaufumleitung. |
|
Url der Seitenablaufumleitung
|
results.object.pageExpiryRedirectUrl | string |
Die URL-Adresse der Ablaufumleitung der Seite. |
|
Seite umgeleitet
|
results.object.pageRedirected | string |
Die Seite wurde umgeleitet. |
|
Kennwort
|
results.object.password | string |
Das Kennwort. |
|
Aktivierte Regeln für den öffentlichen Zugriff
|
results.object.publicAccessRulesEnabled | boolean |
Gibt an, ob regeln für den öffentlichen Zugriff aktiviert sind. |
|
Veröffentlichungsdatum
|
results.object.publishDate | string |
Das Veröffentlichungsdatum. |
|
Sofort veröffentlichen
|
results.object.publishImmediately | boolean |
Gibt an, ob sie sofort veröffentlicht werden soll. |
|
Antworten an
|
results.object.replyTo | string |
Die Antwort. |
|
Zeilenvorlage "RSS-E-Mail-Autor"
|
results.object.rssEmailAuthorLineTemplate | string |
Die Zeilenvorlage "RSS-E-Mail-Autor". |
|
RSS-E-Mail-Blogbild max. Breite
|
results.object.rssEmailBlogImageMaxWidth | string |
Das RSS-E-Mail-Blogbild max. Breite. |
|
RSS-E-Mail per Text
|
results.object.rssEmailByText | string |
Die RSS-E-Mail per Text. |
|
RSS-E-Mail Klick durch Text
|
results.object.rssEmailClickThroughText | string |
Die RSS-E-Mail klickt durch Text. |
|
RSS-E-Mail-Kommentartext
|
results.object.rssEmailCommentText | string |
Der RSS-E-Mail-Kommentartext. |
|
RSS-E-Mail-Eintragsvorlage
|
results.object.rssEmailEntryTemplate | string |
Die RSS-E-Mail-Eintragsvorlage. |
|
RSS-E-Mail-Eintragsvorlage aktiviert
|
results.object.rssEmailEntryTemplateEnabled | string |
Die RSS-E-Mail-Eintragsvorlage ist aktiviert. |
|
RSS-E-Mail-ID
|
results.object.rssEmailId | string |
Der RSS-E-Mail-Bezeichner. |
|
RSS-E-Mail-URL
|
results.object.rssEmailUrl | string |
Die URL-Adresse der RSS-E-Mail. |
|
Slug
|
results.object.slug | string |
Der Strich. |
|
Staat
|
results.object.state | string |
Das Land/die Region. |
|
Unterkategorie
|
results.object.subcategory | string |
Die Unterkategorie. |
|
Betreff
|
results.object.subject | string |
Der Betreff. |
|
Subscription
|
results.object.subscription | string |
Das Abonnement. |
|
Abonnementblog-ID
|
results.object.subscriptionBlogId | string |
Der Blogbezeichner des Abonnements. |
|
Subscription
|
results.object.subscriptionName | string |
Der Abonnementname. |
|
Vorlagenpfad
|
results.object.templatePath | string |
Der Vorlagenpfad. |
|
Transaktionen
|
results.object.transactional | string |
Die Transaktion. |
|
Übersetzt aus ID
|
results.object.translatedFromId | string |
Der aus dem Bezeichner übersetzte. |
|
Updated
|
results.object.updated | string |
Wenn aktualisiert. |
|
Aktualisiert nach ID
|
results.object.updatedById | string |
Der nach Bezeichner aktualisierte. |
|
URL
|
results.object.url | string |
Die URL-Adresse. |
|
Empfohlenes Bild verwenden
|
results.object.useFeaturedImage | boolean |
Gibt an, ob das empfohlene Bild verwendet werden soll. |
|
RSS-Überschrift als Betreff verwenden
|
results.object.useRssHeadlineAsSubject | boolean |
Gibt an, ob RSS-Überschrift als Thema verwendet werden soll. |
|
VIDs ausgeschlossen
|
results.object.vidsExcluded | array of string |
Die viDs ausgeschlossenes Array. |
|
ENTHALTENe VIDs
|
results.object.vidsIncluded | array of string |
Die VIDs enthalten ein Array. |
|
Workflows
|
results.object.workflowNames | array of string |
Die Workflownamen. |
|
Ist Die Empfängerermüdungsunterdrückung aktiviert
|
results.object.isRecipientFatigueSuppressionEnabled | boolean |
Gibt an, ob die Empfängerermüdung aktiviert ist. |
|
Feedback-Umfrage-ID
|
results.object.feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Email
|
results.user.email | string |
Die E-Mail-Adresse. |
|
Vollständiger Name
|
results.user.fullName | string |
Der vollständige Name. |
|
ID
|
results.user.id | string |
Der Bezeichner. |
|
Aktualisiert unter
|
results.updatedAt | string |
Wenn aktualisiert unter. |
|
Total
|
total | integer |
Die Summe. |
|
Nach
|
paging.next.after | string |
Der Nachlink. |
|
Link
|
paging.next.link | string |
Der Link. |
|
Vorher
|
paging.prev.before | string |
Der Vorlink. |
|
Link
|
paging.prev.link | string |
Der Link. |
Abrufen von Marketing-E-Mails
Ruft die Details für eine Marketing-E-Mail ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Statistiken einschließen
|
includeStats | boolean |
Gibt an, ob Statistiken einbezogen werden sollen. |
|
|
Einschließen von Eigenschaften
|
includedProperties | boolean |
Gibt an, ob Eigenschaften eingeschlossen werden sollen. |
|
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Abrufen von Marketing-E-Mails
Dient zum Abrufen einer Liste aller Marketing-E-Mails. Die Ergebnisse können gefiltert werden, sodass Sie einen bestimmten Satz von E-Mails finden können.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
|
Erstellt nach
|
createdAfter | string |
Die erstellte Nachher.The created after. |
|
|
Erstellt vor
|
createdBefore | string |
Die zuvor erstellte Datei. |
|
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
|
Aktualisiert nach
|
updatedAfter | string |
Die Aktualisierung nach. |
|
|
Aktualisiert vor
|
updatedBefore | string |
Die Aktualisierung vor. |
|
|
Sortieren
|
sort | string |
Die Sortierung. |
|
|
Nach
|
after | string |
Das Nachher. |
|
|
Limit
|
limit | string |
Die Grenze. |
|
|
Statistiken einschließen
|
includeStats | boolean |
Gibt an, ob Statistiken einbezogen werden sollen. |
|
|
Typ
|
type | string |
Der Typ. |
|
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
|
Einschließen von Eigenschaften
|
includedProperties | boolean |
Gibt an, ob Eigenschaften eingeschlossen werden sollen. |
|
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnisse
|
results | array of object | |
|
Vorlagenpfad
|
results.content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
results.content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
results.from.fromName | string |
Der Name. |
|
Antworten an
|
results.from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
results.from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
results.id | string |
Der Bezeichner. |
|
Name
|
results.name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
results.sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
results.state | string |
Das Land/die Region. |
|
Unterkategorie
|
results.subcategory | string |
Die Unterkategorie. |
|
Betreff
|
results.subject | string |
Der Betreff. |
|
Include
|
results.to.contactLists.include | array of string |
Das enthaltene. |
|
Ausschließen
|
results.to.contactLists.exclude | array of string |
Der Ausgeschlossene. |
|
Include
|
results.to.contactIds.include | array of string |
Das enthaltene. |
|
Ausschließen
|
results.to.contactIds.exclude | array of string |
Der Ausgeschlossene. |
|
Sendehäufigkeit einschränken
|
results.to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
results.to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
results.createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
results.type | string |
Der Typ. |
|
Aktive Domäne
|
results.activeDomain | string |
Die aktive Domäne. |
|
Archived
|
results.archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
results.folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
results.feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
results.testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
results.testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
results.testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
results.testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
results.testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
results.testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
results.testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
results.subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
results.subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
results.subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
results.updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
results.publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
results.language | string |
Die Sprache. |
|
Kampagne
|
results.campaign | string |
Die Kampagne. |
|
Slug
|
results.webversion.slug | string |
Der Strich. |
|
Domäne
|
results.webversion.domain | string |
Die Domäne. |
|
Title
|
results.webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
results.webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
results.webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
results.webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
results.webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
results.rssData.maxEntries | string |
Die maximal zulässigen Einträge |
|
URL
|
results.rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
results.rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
results.rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
results.rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
RSS-Eintragsvorlage
|
results.rssData.rssEntryTemplate | string |
Rss . |
|
Überschrift als Betreff verwenden
|
results.rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
results.rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
results.isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
results.isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
results.publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
results.updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
results.createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
results.deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
results.publishedAt | string |
Die veröffentlicht unter. |
|
Total
|
total | integer |
Die Summe. |
|
Nach
|
paging.next.after | string |
Der Nachlink. |
|
Link
|
paging.next.link | string |
Der Link. |
Abrufen von Status des Kontaktabonnements
Gibt eine Liste der Abonnements und deren Status für einen bestimmten Kontakt zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E-Mail-Adresse
|
emailAddress | True | string |
Die E-Mail-Adresse. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Recipient
|
recipient | string |
Der Empfänger. |
|
Abonnementstatus
|
subscriptionStatuses | array of object | |
|
Description
|
subscriptionStatuses.description | string |
Die Beschreibung. |
|
ID
|
subscriptionStatuses.id | string |
Der Bezeichner. |
|
Name
|
subscriptionStatuses.name | string |
Der Name. |
|
Quelle des Status
|
subscriptionStatuses.sourceOfStatus | string |
Die Quelle des Status. |
|
Der Status
|
subscriptionStatuses.status | string |
Der Status. |
|
Marken-ID
|
subscriptionStatuses.brandId | string |
Der Markenbezeichner. |
|
Einstellungsgruppe
|
subscriptionStatuses.preferenceGroupName | string |
Der Einstellungsgruppenname. |
|
Rechtsgrundlage
|
subscriptionStatuses.legalBasis | string |
Die Rechtsgrundlage. |
|
Erklärung der Rechtsgrundlage
|
subscriptionStatuses.legalBasisExplanation | string |
Die Rechtsgrundlagenerklärung. |
Aggregierte Statistiken abrufen
Ruft aggregierte Statistiken von E-Mails ab, die in einer bestimmten Zeitspanne gesendet wurden. Außerdem wird die Liste der E-Mails zurückgegeben, die während der Zeitspanne gesendet wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Start
|
startTimestamp | string |
Der Startzeitstempel. |
|
|
ENDE
|
endTimestamp | string |
Der Endzeitstempel. |
|
|
E-Mail-IDs
|
emailIds | string |
Die E-Mail-IDs. |
|
|
Eigentum
|
property | string |
Die Eigenschaft. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
E-Mails
|
emails | array of string |
Das Array der E-Mail-Adressen. |
Aktualisieren von Marketing-E-Mails
Ändern der Eigenschaften einer Marketing-E-Mail.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
|
Vorlagenpfad
|
templatePath | string |
Der Vorlagenpfad. |
|
|
Nur-Text-Version
|
plainTextVersion | string |
Die Nur-Text-Version. |
|
|
Von
|
fromName | string |
Der Name. |
|
|
Antworten an
|
replyTo | string |
Die Antwort. |
|
|
Benutzerdefinierte Antwort auf
|
customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
|
ID
|
id | string |
Der Bezeichner. |
|
|
Name
|
name | string |
Der Name. |
|
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
|
Staat
|
state | string |
Das Land/die Region. |
|
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
|
Betreff
|
subject | string |
Der Betreff. |
|
|
Include
|
include | array of string |
Das Includearray. |
|
|
Ausschließen
|
exclude | array of string |
Das Ausgeschlossene Array. |
|
|
Include
|
include | array of string |
Das Includearray. |
|
|
Ausschließen
|
exclude | array of string |
Das Ausgeschlossene Array. |
|
|
Sendehäufigkeit einschränken
|
limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
|
Graumail unterdrücken
|
suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
|
Typ
|
type | string |
Der Typ. |
|
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
|
Test-ID
|
testId | string |
Der Testbezeichner. |
|
|
Zu wartende Stunden
|
hoursToWait | integer |
Die Zu wartenden Stunden. |
|
|
AB Success Metric
|
abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
|
Standard für AB-Beispielgröße
|
abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
|
AB-Status
|
abStatus | string |
Der A/B-Status. |
|
|
AB-Testprozentsatz
|
abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
|
AB Sampling Standard
|
abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
|
Abonnement-ID
|
subscriptionId | string |
Der Abonnementbezeichner. |
|
|
Einstellungsgruppen-ID
|
preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
|
Office-Standort-ID
|
officeLocationId | string |
Der Bürostandortbezeichner. |
|
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
|
Language
|
language | string |
Die Langauge. |
|
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
|
Slug
|
slug | string |
Der Strich. |
|
|
Domäne
|
domain | string |
Die Domäne. |
|
|
Title
|
title | string |
Der Titel. |
|
|
Metabeschreibung
|
metaDescription | string |
Die Metabeschreibung. |
|
|
Umleitung zu URL
|
redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
|
Umleitung zu Seiten-ID
|
redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
|
Läuft ab
|
expiresAt | string |
Wann läuft ab. |
|
|
Max. Einträge
|
maxEntries | string |
Die maximalen Einträge. |
|
|
URL
|
url | string |
Die URL-Adresse. |
|
|
HubSpot Blog-ID
|
hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
|
Blog-E-Mail-Typ
|
blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
|
Blogbild max. Breite
|
blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
|
Eintragsvorlage
|
rssEntryTemplate | string |
Die Eintragsvorlage. |
|
|
Überschrift als Betreff verwenden
|
useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
|
Bloglayout
|
blogLayout | string |
Das Bloglayout. |
|
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
E-Mail senden
Senden Sie asynchron eine Transaktions-E-Mail. Gibt den Status der E-Mail-Nachricht mit einem Statusbezeichner zurück, der verwendet werden kann, um den Status kontinuierlich mithilfe des E-Mail-Sendestatus abzufragen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | string |
Der E-Mail-Bezeichner. |
|
|
Bis
|
to | string |
Die Adresse. |
|
|
Von
|
from | string |
Die Absenderadresse. |
|
|
Sende-ID
|
sendId | string |
Der Sendebezeichner. |
|
|
Antworten an
|
replyTo | array of string |
Die Antwort auf das Array. |
|
|
CC
|
cc | array of string |
Das CC-Array. |
|
|
BCC
|
bcc | array of string |
Das BCC-Array. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Der Status
|
status | string |
Der Status. |
|
Status-ID
|
statusId | string |
Der Statusbezeichner. |
|
Ergebnis senden
|
sendResult | string |
Das Sendeergebnis. |
|
Angefordert bei
|
requestedAt | string |
Bei Bedarf bei. |
|
Begonnen am
|
startedAt | string |
Wann beginnen sie bei. |
|
Abgeschlossen bei
|
completedAt | string |
Nach Abschluss bei. |
|
Erstellt
|
eventId.created | string |
Beim Erstellen. |
|
ID
|
eventId.id | string |
Der Bezeichner. |
Entwurf zurücksetzen
Setzt den Entwurf auf eine Kopie des Liveobjekts zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
Gibt zurück
- response
- string
Erstellen eines SMTP-Tokens
Erstellt ein SMTP-Token.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kampagnenname
|
campaignName | string |
Der Kampagnenname. |
|
|
Kontakt erstellen
|
createContact | string |
Der Kontakt erstellen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kampagnenname
|
campaignName | string |
Der Kampagnenname. |
|
Kontakt erstellen
|
createContact | string |
Der Kontakt erstellen. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Erstellt von
|
createdBy | string |
Das erstellt von. |
|
E-Mail-Kampagnen-ID
|
emailCampaignId | string |
Die E-Mail-Kampagnen-ID. |
|
ID
|
id | string |
Der Bezeichner. |
|
Kennwort
|
password | string |
Das Kennwort. |
Erstellen oder Aktualisieren von E-Mail-Entwürfen
Erstellt oder aktualisiert die Entwurfsversion einer Marketing-E-Mail. Wenn kein Entwurf vorhanden ist, erstellt das System einen Entwurf aus der aktuellen "live"-E-Mail, und wendet dann den Anforderungstext auf diesen Entwurf an. Die Entwurfsversion befindet sich nur im Puffer – die E-Mail wird nicht geklont.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
|
Vorlagenpfad
|
templatePath | string |
Der Vorlagenpfad. |
|
|
Nur-Text-Version
|
plainTextVersion | string |
Die Nur-Text-Version. |
|
|
Von
|
fromName | string |
Der Name. |
|
|
Antworten an
|
replyTo | string |
Die Antwort. |
|
|
Benutzerdefinierte Antwort auf
|
customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
|
ID
|
id | string |
Der Bezeichner. |
|
|
Name
|
name | string |
Der Name. |
|
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
|
Staat
|
state | string |
Das Land/die Region. |
|
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
|
Betreff
|
subject | string |
Der Betreff. |
|
|
Include
|
include | array of string |
Das Includearray. |
|
|
Ausschließen
|
exclude | array of string |
Das Ausgeschlossene Array. |
|
|
Include
|
include | array of string |
Das Includearray. |
|
|
Ausschließen
|
exclude | array of string |
Das Ausgeschlossene Array. |
|
|
Sendehäufigkeit einschränken
|
limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
|
Graumail unterdrücken
|
suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
|
Typ
|
type | string |
Der Typ. |
|
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
|
Test-ID
|
testId | string |
Der Testbezeichner. |
|
|
Zu wartende Stunden
|
hoursToWait | integer |
Die Zu wartenden Stunden. |
|
|
AB Success Metric
|
abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
|
Standard für AB-Beispielgröße
|
abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
|
AB-Status
|
abStatus | string |
Der A/B-Status. |
|
|
AB-Testprozentsatz
|
abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
|
AB Sampling Standard
|
abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
|
Abonnement-ID
|
subscriptionId | string |
Der Abonnementbezeichner. |
|
|
Einstellungsgruppen-ID
|
preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
|
Office-Standort-ID
|
officeLocationId | string |
Der Bürostandortbezeichner. |
|
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
|
Language
|
language | string |
Die Langauge. |
|
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
|
Slug
|
slug | string |
Der Strich. |
|
|
Domäne
|
domain | string |
Die Domäne. |
|
|
Title
|
title | string |
Der Titel. |
|
|
Metabeschreibung
|
metaDescription | string |
Die Metabeschreibung. |
|
|
Umleitung zu URL
|
redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
|
Umleitung zu Seiten-ID
|
redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
|
Läuft ab
|
expiresAt | string |
Wann läuft ab. |
|
|
Max. Einträge
|
maxEntries | string |
Die maximalen Einträge. |
|
|
URL
|
url | string |
Die URL-Adresse. |
|
|
HubSpot Blog-ID
|
hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
|
Blog-E-Mail-Typ
|
blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
|
Blogbild max. Breite
|
blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
|
Eintragsvorlage
|
rssEntryTemplate | string |
Die Eintragsvorlage. |
|
|
Überschrift als Betreff verwenden
|
useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
|
Bloglayout
|
blogLayout | string |
Das Bloglayout. |
|
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Erstellen von AB-Testmarketing-E-Mails
Erstellt eine Variation einer Marketing-E-Mail für einen A/B-Test. Die neue Variation wird als Entwurf erstellt. Wenn bereits eine aktive Variation vorhanden ist, wird kein neues erstellt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
|
Inhalts-ID
|
contentId | string |
Der Inhaltsbezeichner. |
|
|
Variationsname
|
variationName | string |
Der Variationsname. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Erstellen von Marketing-E-Mails
Erstellt eine neue Marketing-E-Mail.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagenpfad
|
templatePath | string |
Der Vorlagenpfad. |
|
|
Nur-Text-Version
|
plainTextVersion | string |
Die Nur-Text-Version. |
|
|
Von
|
fromName | string |
Der Name. |
|
|
Antworten an
|
replyTo | string |
Die Antwort. |
|
|
Benutzerdefinierte Antwort auf
|
customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
|
ID
|
id | string |
Der Bezeichner. |
|
|
Name
|
name | string |
Der Name. |
|
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
|
Staat
|
state | string |
Das Land/die Region. |
|
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
|
Betreff
|
subject | string |
Der Betreff. |
|
|
Include
|
include | array of string |
Das Includearray. |
|
|
Ausschließen
|
exclude | array of string |
Das Ausgeschlossene Array. |
|
|
Include
|
include | array of string |
Das Includearray. |
|
|
Ausschließen
|
exclude | array of string |
Das Ausgeschlossene Array. |
|
|
Sendehäufigkeit einschränken
|
limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
|
Graumail unterdrücken
|
suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
|
Typ
|
type | string |
Der Typ. |
|
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
|
Test-ID
|
testId | string |
Der Testbezeichner. |
|
|
Zu wartende Stunden
|
hoursToWait | integer |
Die Zu wartenden Stunden. |
|
|
AB Success Metric
|
abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
|
Standard für AB-Beispielgröße
|
abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
|
AB-Status
|
abStatus | string |
Der A/B-Status. |
|
|
AB-Testprozentsatz
|
abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
|
AB Sampling Standard
|
abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
|
Abonnement-ID
|
subscriptionId | string |
Der Abonnementbezeichner. |
|
|
Einstellungsgruppen-ID
|
preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
|
Office-Standort-ID
|
officeLocationId | string |
Der Bürostandortbezeichner. |
|
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
|
Language
|
language | string |
Die Langauge. |
|
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
|
Slug
|
slug | string |
Der Strich. |
|
|
Domäne
|
domain | string |
Die Domäne. |
|
|
Title
|
title | string |
Der Titel. |
|
|
Metabeschreibung
|
metaDescription | string |
Die Metabeschreibung. |
|
|
Umleitung zu URL
|
redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
|
Umleitung zu Seiten-ID
|
redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
|
Läuft ab
|
expiresAt | string |
Wann läuft ab. |
|
|
Max. Einträge
|
maxEntries | string |
Die maximalen Einträge. |
|
|
URL
|
url | string |
Die URL-Adresse. |
|
|
HubSpot Blog-ID
|
hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
|
Blog-E-Mail-Typ
|
blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
|
Blogbild max. Breite
|
blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
|
Eintragsvorlage
|
rssEntryTemplate | string |
Die Eintragsvorlage. |
|
|
Überschrift als Betreff verwenden
|
useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
|
Bloglayout
|
blogLayout | string |
Das Bloglayout. |
|
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Erstellen von Massenkommunikationseinstellungen
Erstellt eine Anforderung für Massenkommunikationseinstellungen. Diese Anforderung gibt einen Statusbezeichner zurück, der verwendet werden kann, um den Status kontinuierlich mithilfe des Status der Massenkommunikationseinstellungen abzufragen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
body
|
body | True | array of string |
Klonen von Marketing-E-Mails
Erstellt eine duplizierte E-Mail mit denselben Eigenschaften wie das Original, mit Ausnahme eines eindeutigen Bezeichners.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
|
Name
|
name | string |
Der Name. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Kontakt abonnieren
Abonniert einen Kontakt mit dem angegebenen Abonnementtyp. Diese Aktion ist nicht gültig, um einen Kontakt auf Marken- oder Portalebene zu abonnieren und gibt einen Fehler zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E-Mail-Adresse
|
emailAddress | string |
Die E-Mail-Adresse. |
|
|
Abonnement-ID
|
subscriptionId | string |
Der Abonnementbezeichner. |
|
|
Rechtsgrundlage
|
legalBasis | string |
Die Rechtsgrundlage. |
|
|
Erklärung der Rechtsgrundlage
|
legalBasisExplanation | string |
Die Rechtsgrundlagenerklärung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Description
|
description | string |
Die Beschreibung. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Quelle des Status
|
sourceOfStatus | string |
Die Quelle des Status. |
|
Der Status
|
status | string |
Der Status. |
|
Marken-ID
|
brandId | string |
Der Markenbezeichner. |
|
Einstellungsgruppe
|
preferenceGroupName | string |
Der Einstellungsgruppenname. |
|
Rechtsgrundlage
|
legalBasis | string |
Die Rechtsgrundlage. |
|
Erklärung der Rechtsgrundlage
|
legalBasisExplanation | string |
Die Rechtsgrundlagenerklärung. |
Kontakt kündigen
Gekündigt einen Kontakt vom angegebenen Abonnementtyp. Diese Aktion ist nicht gültig, um einen Kontakt auf Marken- oder Portalebene zu kündigen und gibt einen Fehler zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E-Mail-Adresse
|
emailAddress | string |
Die E-Mail-Adresse. |
|
|
Abonnement-ID
|
subscriptionId | string |
Der Abonnementbezeichner. |
|
|
Rechtsgrundlage
|
legalBasis | string |
Die Rechtsgrundlage. |
|
|
Erklärung der Rechtsgrundlage
|
legalBasisExplanation | string |
Die Rechtsgrundlagenerklärung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Description
|
description | string |
Die Beschreibung. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Quelle des Status
|
sourceOfStatus | string |
Die Quelle des Status. |
|
Der Status
|
status | string |
Der Status. |
|
Marken-ID
|
brandId | string |
Der Markenbezeichner. |
|
Einstellungsgruppe
|
preferenceGroupName | string |
Der Einstellungsgruppenname. |
|
Rechtsgrundlage
|
legalBasis | string |
Die Rechtsgrundlage. |
|
Erklärung der Rechtsgrundlage
|
legalBasisExplanation | string |
Die Rechtsgrundlagenerklärung. |
Löschen von Marketing-E-Mails
Löscht eine Marketing-E-Mail.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
Gibt zurück
- response
- string
Marketing-E-Mail-Entwurf abrufen
Ruft die Entwurfsversion einer E-Mail ab (sofern vorhanden). Wenn keine Entwurfsversion vorhanden ist, wird die veröffentlichte E-Mail zurückgegeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Smtp-Token abfragen
Fragt mehrere SMTP-Token nach Kampagnenname oder einem einzelnen Token nach E-Mail-Kampagnen-ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kampagne
|
campaignName | string |
Der Kampagnenname. |
|
|
E-Mail-Kampagne
|
emailCampaignId | string |
Die E-Mail-Kampagnen-ID. |
|
|
Nach
|
after | string |
Das Nachher. |
|
|
Limit
|
limit | string |
Die Grenze. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ergebnisse
|
results | array of object | |
|
Kampagnenname
|
results.campaignName | string |
Der Kampagnenname. |
|
Kontakt erstellen
|
results.createContact | string |
Der Kontakt erstellen. |
|
Erstellt unter
|
results.createdAt | string |
Beim Erstellen bei. |
|
Erstellt von
|
results.createdBy | string |
Das erstellt von. |
|
E-Mail-Kampagnen-ID
|
results.emailCampaignId | string |
Die E-Mail-Kampagnen-ID. |
|
ID
|
results.id | string |
Der Bezeichner. |
|
Kennwort
|
results.password | string |
Das Kennwort. |
|
Nach
|
paging.next.after | string |
Der Nachlink. |
|
Link
|
paging.next.link | string |
Der Link. |
Token löschen
Löscht ein einzelnes Token nach Bezeichner.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
tokenId | True | string |
Der Tokenbezeichner. |
Gibt zurück
- response
- string
Tokenkennwort zurücksetzen
Ermöglicht die Erstellung eines Ersatzkennworts für ein bestimmtes Token. Nachdem das Kennwort erfolgreich zurückgesetzt wurde, ist das alte Kennwort für das Token ungültig.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Token
|
tokenId | True | string |
Der Tokenbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kampagnenname
|
campaignName | string |
Der Kampagnenname. |
|
Kontakt erstellen
|
createContact | string |
Der Kontakt erstellen. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Erstellt von
|
createdBy | string |
Das erstellt von. |
|
E-Mail-Kampagnen-ID
|
emailCampaignId | string |
Die E-Mail-Kampagnen-ID. |
|
ID
|
id | string |
Der Bezeichner. |
|
Kennwort
|
password | string |
Das Kennwort. |
Wiederherstellen der Marketing-E-Mail-Revision
Stellt eine vorherige Überarbeitung einer Marketing-E-Mail wieder her. Die aktuelle Revision wird alt, und die wiederhergestellte Revision erhält eine neue Versionsnummer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
|
Revisions-ID
|
revisionId | True | string |
Der Revisionsbezeichner. |
Gibt zurück
- response
- string
Wiederherstellen von Marketing-E-Mails
Stellt eine vorherige Überarbeitung einer Marketing-E-Mail im ENTWURFSzustand wieder her. Wenn derzeit etwas im Entwurf für dieses Objekt vorhanden ist, wird es überschrieben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email-ID
|
emailId | True | string |
Der E-Mail-Bezeichner. |
|
Revisions-ID
|
revisionId | True | string |
Der Revisionsbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Vorlagenpfad
|
content.templatePath | string |
Der Vorlagenpfad. |
|
Nur-Text-Version
|
content.plainTextVersion | string |
Die Nur-Text-Version. |
|
Von
|
from.fromName | string |
Der Name. |
|
Antworten an
|
from.replyTo | string |
Die Antwort. |
|
Benutzerdefinierte Antwort auf
|
from.customReplyTo | string |
Die benutzerdefinierte Antwort. |
|
ID
|
id | string |
Der Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Beim Veröffentlichen senden
|
sendOnPublish | boolean |
Gibt an, ob beim Veröffentlichen gesendet werden soll. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Unterkategorie
|
subcategory | string |
Die Unterkategorie. |
|
Betreff
|
subject | string |
Der Betreff. |
|
Include
|
to.contactLists.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactLists.exclude | array of string |
Das Ausgeschlossene Array. |
|
Include
|
to.contactIds.include | array of string |
Das Includearray. |
|
Ausschließen
|
to.contactIds.exclude | array of string |
Das Ausgeschlossene Array. |
|
Sendehäufigkeit einschränken
|
to.limitSendFrequency | boolean |
Gibt an, ob die Sendehäufigkeit eingeschränkt werden soll. |
|
Graumail unterdrücken
|
to.suppressGraymail | boolean |
Gibt an, ob Graumail unterdrückt werden soll. |
|
Erstellt anhand der ID
|
createdById | string |
Der durch bezeichner erstellte Bezeichner. |
|
Typ
|
type | string |
Der Typ. |
|
Aktive Domäne
|
activeDomain | string |
Die aktive Domäne. |
|
Archived
|
archived | boolean |
Gibt an, ob archiviert. |
|
Ordner-ID
|
folderId | string |
Der Ordnerbezeichner. |
|
Feedback-Umfrage-ID
|
feedbackSurveyId | string |
Die Feedbackumfrage-ID. |
|
Test-ID
|
testing.testId | string |
Der Testbezeichner. |
|
Zu wartende Stunden
|
testing.hoursToWait | integer |
Die Zu wartenden Stunden. |
|
AB Success Metric
|
testing.abSuccessMetric | string |
Die Erfolgsmetrik A/B. |
|
Standard für AB-Beispielgröße
|
testing.abSampleSizeDefault | string |
Die Standardeinstellung für die A/B-Beispielgröße. |
|
AB-Status
|
testing.abStatus | string |
Der A/B-Status. |
|
AB-Testprozentsatz
|
testing.abTestPercentage | string |
Der A/B-Testprozentsatz. |
|
AB Sampling Standard
|
testing.abSamplingDefault | string |
Die Standardeinstellung für das A/B-Sampling. |
|
Abonnement-ID
|
subscriptionDetails.subscriptionId | string |
Der Abonnementbezeichner. |
|
Einstellungsgruppen-ID
|
subscriptionDetails.preferencesGroupId | string |
Der Gruppenbezeichner der Einstellungen. |
|
Office-Standort-ID
|
subscriptionDetails.officeLocationId | string |
Der Bürostandortbezeichner. |
|
Aktualisiert nach ID
|
updatedById | string |
Der nach Bezeichner aktualisierte. |
|
Veröffentlicht nach ID
|
publishedById | string |
Der vom Bezeichner veröffentlichte. |
|
Language
|
language | string |
Die Langauge. |
|
Kampagne
|
campaign | string |
Die Kampagne. |
|
Slug
|
webversion.slug | string |
Der Strich. |
|
Domäne
|
webversion.domain | string |
Die Domäne. |
|
Title
|
webversion.title | string |
Der Titel. |
|
Metabeschreibung
|
webversion.metaDescription | string |
Die Metabeschreibung. |
|
Umleitung zu URL
|
webversion.redirectToUrl | string |
Die Umleitung an die URL-Adresse. |
|
Umleitung zu Seiten-ID
|
webversion.redirectToPageId | string |
Die Umleitung zum Seitenbezeichner. |
|
Läuft ab
|
webversion.expiresAt | string |
Wann läuft ab. |
|
Max. Einträge
|
rssData.maxEntries | string |
Die maximalen Einträge. |
|
URL
|
rssData.url | string |
Die URL-Adresse. |
|
HubSpot Blog-ID
|
rssData.hubspotBlogId | string |
Der HubSpot-Blogbezeichner. |
|
Blog-E-Mail-Typ
|
rssData.blogEmailType | string |
Der E-Mail-Typ des Blogs. |
|
Blogbild max. Breite
|
rssData.blogImageMaxWidth | string |
Die maximale Breite des Blogbilds. |
|
Eintragsvorlage
|
rssData.rssEntryTemplate | string |
Die Eintragsvorlage. |
|
Überschrift als Betreff verwenden
|
rssData.useHeadlineAsSubject | boolean |
Gibt an, ob Überschrift als Thema verwendet werden soll. |
|
Bloglayout
|
rssData.blogLayout | string |
Das Bloglayout. |
|
Ist Transaktional
|
isTransactional | boolean |
Gibt an, ob es sich um eine Transaktion handelt. |
|
Wird veröffentlicht
|
isPublished | boolean |
Gibt an, ob veröffentlicht wird. |
|
Veröffentlichungsdatum
|
publishDate | string |
Das Veröffentlichungsdatum. |
|
Aktualisiert unter
|
updatedAt | string |
Wenn aktualisiert unter. |
|
Erstellt unter
|
createdAt | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deletedAt | string |
Beim Löschen bei. |
|
Veröffentlicht unter
|
publishedAt | string |
Die veröffentlicht unter. |
Definitionen
Schnur
Dies ist der grundlegende Datentyp "string".