ConvertKit (Unabhängiger Herausgeber)
ConvertKit ist der go-to Marketing-Hub für Ersteller, der Ihnen hilft, Ihre Zielgruppe mühelos zu vergrößern und zu monetarisieren. Konvertieren Sie Ihre Follower aus sozialen Medien, YouTube und mehr in Ihre E-Mail-Liste mit einer schönen Startseite und Opt-In-Vorlagen.
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, Hitachi Solutions |
| Webseite | https://convertkit.com/ |
| Datenschutzrichtlinie | https://convertkit.com/privacy |
| Kategorien | Marketing |
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 |
|---|---|---|---|
| API-Geheimer Schlüssel | securestring | Der API-Geheimschlüssel für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abonnement kündigen |
Kündigen Sie einen Abonnent von allen Formularen und Sequenzen. |
| Abonnenten aktualisieren |
Aktualisiert die Informationen für einen einzelnen Abonnenten. |
| Abonnenten auflisten |
Gibt eine Liste Ihrer Abonnenten zurück. Verwenden Sie für Abonnements nur den bei Wert abgebrochenen Wert für Sortierfeld-Param (derzeit das einzige unterstützte zusätzliche Sortierfeld). |
| Abrufen einer Übertragung |
Ruft die Details einer bestimmten Übertragung ab, einschließlich Entwürfen, geplanten und zuvor gesendeten Übertragungen. |
| Abrufen eines Abonnenten |
Ruft einen einzelnen Abonnentendatensatz ab. |
| Abrufen von Formularen |
Dient zum Abrufen einer Liste aller Formulare für Ihr Konto. |
| Abrufen von Übertragungsstatistiken |
Ruft die Statistiken (Empfängeranzahl, Öffnungsrate, Klickrate, Abonnementanzahl, Gesamtzahl der Klicks, Status und Status senden) für eine bestimmte Übertragung ab. |
| Aktualisieren einer Übertragung |
Aktualisiert die Attribute einer bestimmten Übertragung. Übertragungen, die derzeit gesendet oder gesendet wurden, werden möglicherweise nicht aktualisiert. |
| Auflisten von Abonnements in einem Formular |
Ruft eine Liste von Abonnements für ein Formular einschließlich Abonnentendaten ab. |
| Auflisten von Abonnements zu einem Tag |
Ruft eine Liste von Abonnements für ein Tag einschließlich Abonnentendaten ab. |
| Auflisten von Abonnements zu einer Sequenz |
Ruft Abonnements für eine Sequenz einschließlich Abonnentendaten ab. |
| Auflisten von Tags |
Ruft eine Liste von Tags für das Konto ab. |
| Auflisten von Übertragungen |
Ruft eine Liste aller Übertragungen für Ihr Konto ab. |
| Einkäufe auflisten |
Dient zum Abrufen einer Liste aller Einkäufe für ein Konto. |
| Erstellen einer Übertragung |
Erstellen Sie einen Entwurf oder eine geplante Übertragung. Sie können eine Entwurfsübertragung ohne Attribute erstellen. Geplante Übertragungen sollten mindestens eine Betreffzeile und Ihre Inhalte enthalten. |
| Erstellen eines Kaufs |
Erstellen Sie einen Kauf. |
| Erstellen eines Tags |
Erstellt ein neues Tag. |
| Erwerben eines Einkaufs |
Rufen Sie einen bestimmten Kauf nach ID ab. |
| Hinzufügen eines Abonnenten zu einem Formular |
Abonnieren Sie eine E-Mail-Adresse für eines Ihrer Formulare. |
| Hinzufügen eines Abonnents zu einer Sequenz |
Abonnieren Sie eine E-Mail-Adresse für eine Ihrer Sequenzen. |
| Kategorisieren eines Abonnenten |
Tags werden als Abonnements behandelt. Abonnieren Sie eine E-Mail-Adresse für ein Tag, damit dieses Tag auf den Abonnenten mit dieser E-Mail-Adresse angewendet wird. |
| Konto abrufen |
Ruft das aktuelle Konto ab. |
| Listenabonnenttags |
Ruft eine Liste aller Tags für einen Abonnenten ab. |
| Listensequenzen |
Ruft eine Liste der Sequenzen für das Konto ab. |
| Tag aus Abonnent entfernen |
Entfernt ein Tag aus einem Abonnent. |
| Tag aus Abonnenten per E-Mail entfernen |
Entfernen Sie ein Tag von einem Abonnenten per E-Mail-Adresse. |
| Zerstören einer Übertragung |
Endgültig löschen Sie einen Entwurfs- oder geplanten Übertragungsdatensatz. Übertragungen, die derzeit gesendet oder gesendet wurden, werden möglicherweise nicht gelöscht. |
Abonnement kündigen
Kündigen Sie einen Abonnent von allen Formularen und Sequenzen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Email
|
True | string |
Die E-Mail-Adresse. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscriber.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscriber.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscriber.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriber.created_at | string |
Beim Erstellen bei. |
|
Nachname
|
subscriber.fields.last_name | string |
Der Nachname. |
Abonnenten aktualisieren
Aktualisiert die Informationen für einen einzelnen Abonnenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnenten-ID
|
subscriber_id | True | string |
Der eindeutige Bezeichner des Abonnenten. |
|
Vorname
|
first_name | string |
Der Vorname. |
|
|
E-Mail-Adresse
|
email_address | string |
Die E-Mail-Adresse. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscriber.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscriber.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscriber.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriber.created_at | string |
Beim Erstellen bei. |
Abonnenten auflisten
Gibt eine Liste Ihrer Abonnenten zurück. Verwenden Sie für Abonnements nur den bei Wert abgebrochenen Wert für Sortierfeld-Param (derzeit das einzige unterstützte zusätzliche Sortierfeld).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Von
|
from | string |
Die von. |
|
|
Bis
|
to | string |
The to. |
|
|
Aktualisiert von
|
updated_from | string |
Beim Aktualisieren von. |
|
|
Aktualisiert auf
|
updated_to | string |
Beim Aktualisieren auf. |
|
|
Sortierreihenfolge
|
sort_order | string |
Die Sortierreihenfolge. |
|
|
Sortierfeld
|
sort_field | string |
Das Sortierfeld. |
|
|
E-Mail-Adresse
|
email_address | string |
Die E-Mail-Adresse. |
|
|
Seite
|
page | integer |
Die Seite. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtzahl der Abonnenten
|
total_subscribers | integer |
Die Gesamtzahl der Abonnenten. |
|
Seite
|
page | integer |
Die Seite. |
|
Seiten insgesamt
|
total_pages | integer |
Die Gesamtseiten. |
|
Abonnenten
|
subscribers | array of object | |
|
ID
|
subscribers.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscribers.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscribers.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscribers.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscribers.created_at | string |
Beim Erstellen bei. |
|
Nachname
|
subscribers.fields.last_name | string |
Der Nachname. |
Abrufen einer Übertragung
Ruft die Details einer bestimmten Übertragung ab, einschließlich Entwürfen, geplanten und zuvor gesendeten Übertragungen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Übertragungs-ID
|
broadcast_id | True | string |
Der eindeutige Broadcast-Bezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
Der eindeutige Bezeichner. |
|
Erstellt unter
|
broadcast.created_at | string |
Beim Erstellen bei. |
|
Betreff
|
broadcast.subject | string |
Der Betreff. |
|
Description
|
broadcast.description | string |
Die Beschreibung. |
|
Content
|
broadcast.content | string |
Der Inhalt. |
|
Öffentlichkeit
|
broadcast.public | boolean |
Gibt an, ob öffentlich. |
|
Veröffentlicht unter
|
broadcast.published_at | string |
Wann veröffentlicht unter. |
|
Senden unter
|
broadcast.send_at | string |
Beim Senden an. |
|
Miniaturansicht alt
|
broadcast.thumbnail_alt | string |
Der Alternativtext für die Miniaturansicht. |
|
Miniaturansichts-URL
|
broadcast.thumbnail_url | string |
Die URL-Adresse für die Miniaturansicht. |
|
E-Mail-Adresse
|
broadcast.email_address | string |
Die E-Mail-Adresse. |
|
E-Mail-Layoutvorlage
|
broadcast.email_layout_template | string |
Die E-Mail-Layoutvorlage. |
Abrufen eines Abonnenten
Ruft einen einzelnen Abonnentendatensatz ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnenten-ID
|
subscriber_id | True | string |
Der eindeutige Bezeichner des Abonnenten. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscriber.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscriber.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscriber.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriber.created_at | string |
Beim Erstellen bei. |
|
Nachname
|
subscriber.fields.last_name | string |
Der Nachname. |
Abrufen von Formularen
Dient zum Abrufen einer Liste aller Formulare für Ihr Konto.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Formulare
|
forms | array of object | |
|
ID
|
forms.id | integer |
Der eindeutige Bezeichner. |
|
Name
|
forms.name | string |
Der Name. |
|
Erstellt unter
|
forms.created_at | string |
Beim Erstellen bei. |
|
Typ
|
forms.type | string |
Der Typ. |
|
Format
|
forms.format | string |
Das Format. |
|
URL
|
forms.url | string |
Die URL-Adresse. |
|
Js einbetten
|
forms.embed_js | string |
Das zu einbettende Javascript. |
|
Einbettungs-URL
|
forms.embed_url | string |
Die einzubettende URL-Adresse. |
|
Title
|
forms.title | string |
Der Titel. |
|
Description
|
forms.description | string |
Die Beschreibung. |
|
Text der Registrierungsschaltfläche
|
forms.sign_up_button_text | string |
Der Text der Registrierungsschaltfläche. |
|
Erfolgsmeldung
|
forms.success_message | string |
Die Erfolgsmeldung. |
|
Archived
|
forms.archived | boolean |
Gibt an, ob archiviert. |
|
UID
|
forms.uid | string |
Der eindeutige Bezeichner. |
Abrufen von Übertragungsstatistiken
Ruft die Statistiken (Empfängeranzahl, Öffnungsrate, Klickrate, Abonnementanzahl, Gesamtzahl der Klicks, Status und Status senden) für eine bestimmte Übertragung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Übertragungs-ID
|
broadcast_id | True | string |
Der eindeutige Broadcast-Bezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Übertragen
|
broadcast | array of object | |
|
ID
|
broadcast.id | integer |
Der eindeutige Bezeichner. |
|
Empfänger
|
broadcast.stats.recipients | integer |
Die Empfänger. |
|
Öffnungsrate
|
broadcast.stats.open_rate | float |
Die Öffnungsrate. |
|
Klickrate
|
broadcast.stats.click_rate | float |
Die Klickrate. |
|
Abonnement wird gekündigt...
|
broadcast.stats.unsubscribes | integer |
Die Abonnements werden abbestellt. |
|
Gesamtklicks
|
broadcast.stats.total_clicks | integer |
Die Gesamtzahl der Klicks. |
|
Summenklicks anzeigen
|
broadcast.stats.show_total_clicks | boolean |
Gibt an, ob Gesamtklicks angezeigt werden sollen. |
|
Der Status
|
broadcast.stats.status | string |
Der Status. |
|
Progress
|
broadcast.stats.progress | integer |
Der Fortschritt. |
Aktualisieren einer Übertragung
Aktualisiert die Attribute einer bestimmten Übertragung. Übertragungen, die derzeit gesendet oder gesendet wurden, werden möglicherweise nicht aktualisiert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Übertragungs-ID
|
broadcast_id | True | string |
Der eindeutige Broadcast-Bezeichner. |
|
Description
|
description | string |
Die Beschreibung. |
|
|
Betreff
|
subject | string |
Der Betreff. |
|
|
Content
|
content | string |
Der Inhalt. |
|
|
E-Mail-Adresse
|
email_address | string |
Die E-Mail-Adresse. |
|
|
E-Mail-Layoutvorlage
|
email_layout_template | string |
Die E-Mail-Layoutvorlage. |
|
|
Öffentlichkeit
|
public | boolean |
Gibt an, ob öffentlich. |
|
|
Veröffentlicht unter
|
published_at | string |
Wann veröffentlicht unter. |
|
|
Senden unter
|
send_at | string |
Beim Senden bei. |
|
|
Miniaturansicht alt
|
thumbnail_alt | string |
Der Alternativtext für die Miniaturansicht. |
|
|
Miniaturansichts-URL
|
thumbnail_url | string |
Die URL-Adresse für die Miniaturansicht. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
Der eindeutige Bezeichner. |
|
Erstellt unter
|
broadcast.created_at | string |
Beim Erstellen bei. |
|
Betreff
|
broadcast.subject | string |
Der Betreff. |
|
Description
|
broadcast.description | string |
Die Beschreibung. |
|
Content
|
broadcast.content | string |
Der Inhalt. |
|
Öffentlichkeit
|
broadcast.public | boolean |
Gibt an, ob öffentlich. |
|
Veröffentlicht unter
|
broadcast.published_at | string |
Wann veröffentlicht unter. |
|
Senden unter
|
broadcast.send_at | string |
Beim Senden an. |
|
Miniaturansicht alt
|
broadcast.thumbnail_alt | string |
Der Alternativtext für die Miniaturansicht. |
|
Miniaturansichts-URL
|
broadcast.thumbnail_url | string |
Die URL-Adresse für die Miniaturansicht. |
|
E-Mail-Adresse
|
broadcast.email_address | string |
Die E-Mail-Adresse. |
|
E-Mail-Layoutvorlage
|
broadcast.email_layout_template | string |
Die E-Mail-Layoutvorlage. |
Auflisten von Abonnements in einem Formular
Ruft eine Liste von Abonnements für ein Formular einschließlich Abonnentendaten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Formular-ID
|
form_id | True | string |
Der eindeutige Bezeichner des Formulars. |
|
Sortierreihenfolge
|
sort_order | string |
Die Sortierreihenfolge. |
|
|
Abonnentenstatus
|
subscriber_state | string |
Der Status des Abonnenten. |
|
|
Seite
|
page | integer |
Die Seite. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtabonnements
|
total_subscriptions | integer |
Die Gesamtzahl der Abonnements. |
|
Seite
|
page | integer |
Die Seite. |
|
Seiten insgesamt
|
total_pages | integer |
Die Gesamtseiten. |
|
Abonnements
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
Der eindeutige Bezeichner. |
|
Staat
|
subscriptions.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriptions.created_at | string |
Beim Erstellen bei. |
|
Quelle
|
subscriptions.source | string |
Die Quelle. |
|
Verweiser
|
subscriptions.referrer | string |
Der Verweiser. |
|
Abonnierbare ID
|
subscriptions.subscribable_id | integer |
Der abonnierbare eindeutige Bezeichner. |
|
Abonnierbarer Typ
|
subscriptions.subscribable_type | string |
Der abonnierbare Typ. |
|
ID
|
subscriptions.subscriber.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscriptions.subscriber.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscriptions.subscriber.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscriptions.subscriber.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriptions.subscriber.created_at | string |
Beim Erstellen bei. |
|
Nachname
|
subscriptions.subscriber.fields.last_name | string |
Der Nachname. |
Auflisten von Abonnements zu einem Tag
Ruft eine Liste von Abonnements für ein Tag einschließlich Abonnentendaten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Tag-ID
|
tag_id | True | string |
Der eindeutige Tagbezeichner. |
|
Sortierreihenfolge
|
sort_order | string |
Die Sortierreihenfolge. |
|
|
Abonnentenstatus
|
subscriber_state | string |
Der Status des Abonnenten. |
|
|
Seite
|
page | integer |
Die Seite. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtabonnements
|
total_subscriptions | integer |
Die Gesamtzahl der Abonnements. |
|
Seite
|
page | integer |
Die Seite. |
|
Seiten insgesamt
|
total_pages | integer |
Die Gesamtseiten. |
|
Abonnements
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
Der eindeutige Bezeichner. |
|
Staat
|
subscriptions.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriptions.created_at | string |
Beim Erstellen bei. |
|
Quelle
|
subscriptions.source | string |
Die Quelle. |
|
Verweiser
|
subscriptions.referrer | string |
Der Verweiser. |
|
Abonnierbare ID
|
subscriptions.subscribable_id | integer |
Der abonnierbare eindeutige Bezeichner. |
|
Abonnierbarer Typ
|
subscriptions.subscribable_type | string |
Der abonnierbare Typ. |
|
ID
|
subscriptions.subscriber.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscriptions.subscriber.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscriptions.subscriber.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscriptions.subscriber.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriptions.subscriber.created_at | string |
Beim Erstellen bei. |
|
Nachname
|
subscriptions.subscriber.fields.last_name | string |
Der Nachname. |
Auflisten von Abonnements zu einer Sequenz
Ruft Abonnements für eine Sequenz einschließlich Abonnentendaten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sequenz ID
|
sequence_id | True | string |
Der eindeutige Bezeichner der Sequenz. |
|
Sortierreihenfolge
|
sort_order | string |
Die Sortierreihenfolge. |
|
|
Abonnentenstatus
|
subscriber_state | string |
Der Status des Abonnenten. |
|
|
Seite
|
page | integer |
Die Seite. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtabonnements
|
total_subscriptions | integer |
Die Gesamtzahl der Abonnements. |
|
Seite
|
page | integer |
Die Seite. |
|
Seiten insgesamt
|
total_pages | integer |
Die Gesamtseiten. |
|
Abonnements
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
Der eindeutige Bezeichner. |
|
Staat
|
subscriptions.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriptions.created_at | string |
Beim Erstellen bei. |
|
Quelle
|
subscriptions.source | string |
Die Quelle. |
|
Verweiser
|
subscriptions.referrer | string |
Der Verweiser. |
|
Abonnierbare ID
|
subscriptions.subscribable_id | integer |
Der abonnierbare eindeutige Bezeichner. |
|
Abonnierbarer Typ
|
subscriptions.subscribable_type | string |
Der abonnierbare Typ. |
|
ID
|
subscriptions.subscriber.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscriptions.subscriber.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscriptions.subscriber.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscriptions.subscriber.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscriptions.subscriber.created_at | string |
Beim Erstellen bei. |
|
Nachname
|
subscriptions.subscriber.fields.last_name | string |
Der Nachname. |
Auflisten von Tags
Ruft eine Liste von Tags für das Konto ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Stichwörter
|
tags | array of object | |
|
ID
|
tags.id | integer |
Der eindeutige Bezeichner. |
|
Name
|
tags.name | string |
Der Name. |
|
Erstellt unter
|
tags.created_at | string |
Beim Erstellen bei. |
Auflisten von Übertragungen
Ruft eine Liste aller Übertragungen für Ihr Konto ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Sendungen
|
broadcasts | array of object | |
|
ID
|
broadcasts.id | integer |
Der eindeutige Bezeichner. |
|
Erstellt unter
|
broadcasts.created_at | string |
Beim Erstellen bei. |
|
Betreff
|
broadcasts.subject | string |
Der Betreff. |
Einkäufe auflisten
Dient zum Abrufen einer Liste aller Einkäufe für ein Konto.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Die Seite. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gesamtkäufe
|
total_purchases | integer |
Die Gesamtkäufe. |
|
Seite
|
page | integer |
Die Seite. |
|
Seiten insgesamt
|
total_pages | integer |
Die Gesamtseiten. |
|
Einkäufe
|
purchases | array of object | |
|
ID
|
purchases.id | integer |
Der eindeutige Bezeichner. |
|
Buchungskennung
|
purchases.transaction_id | string |
Der eindeutige Bezeichner der Transaktion. |
|
Der Status
|
purchases.status | string |
Der Status. |
|
E-Mail-Adresse
|
purchases.email_address | string |
Die E-Mail-Adresse. |
|
Währung
|
purchases.currency | string |
Die Währung. |
|
Transaktionszeit
|
purchases.transaction_time | string |
Die Transaktionszeit. |
|
Zwischensumme
|
purchases.subtotal | integer |
Das Teilergebnis. |
|
Versand
|
purchases.shipping | integer |
Der Versand. |
|
Rabatt
|
purchases.discount | integer |
Der Rabatt. |
|
Steuer
|
purchases.tax | integer |
Die Steuer. |
|
Total
|
purchases.total | integer |
Die Summe. |
|
Products
|
purchases.products | array of object | |
|
Einheitspreis
|
purchases.products.unit_price | integer |
Der Einzelpreis. |
|
Menge
|
purchases.products.quantity | integer |
Die Menge. |
|
Artikelnummer (SKU)
|
purchases.products.sku | string |
Die SKU. |
|
Name
|
purchases.products.name | string |
Der Name. |
Erstellen einer Übertragung
Erstellen Sie einen Entwurf oder eine geplante Übertragung. Sie können eine Entwurfsübertragung ohne Attribute erstellen. Geplante Übertragungen sollten mindestens eine Betreffzeile und Ihre Inhalte enthalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Description
|
description | string |
Die Beschreibung. |
|
|
Betreff
|
subject | string |
Der Betreff. |
|
|
Content
|
content | string |
Der Inhalt. |
|
|
E-Mail-Adresse
|
email_address | string |
Die E-Mail-Adresse. |
|
|
E-Mail-Layoutvorlage
|
email_layout_template | string |
Die E-Mail-Layoutvorlage. |
|
|
Öffentlichkeit
|
public | boolean |
Gibt an, ob öffentlich. |
|
|
Veröffentlicht unter
|
published_at | string |
Wann veröffentlicht unter. |
|
|
Senden unter
|
send_at | string |
Beim Senden bei. |
|
|
Miniaturansicht alt
|
thumbnail_alt | string |
Der Alternativtext für die Miniaturansicht. |
|
|
Miniaturansichts-URL
|
thumbnail_url | string |
Die URL-Adresse für die Miniaturansicht. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
Der eindeutige Bezeichner. |
|
Erstellt unter
|
broadcast.created_at | string |
Beim Erstellen bei. |
|
Betreff
|
broadcast.subject | string |
Der Betreff. |
|
Description
|
broadcast.description | string |
Die Beschreibung. |
|
Content
|
broadcast.content | string |
Der Inhalt. |
|
Öffentlichkeit
|
broadcast.public | boolean |
Gibt an, ob öffentlich. |
|
Veröffentlicht unter
|
broadcast.published_at | string |
Wann veröffentlicht unter. |
|
Senden unter
|
broadcast.send_at | string |
Beim Senden an. |
|
Miniaturansicht alt
|
broadcast.thumbnail_alt | string |
Der Alternativtext für die Miniaturansicht. |
|
Miniaturansichts-URL
|
broadcast.thumbnail_url | string |
Die URL-Adresse für die Miniaturansicht. |
|
E-Mail-Adresse
|
broadcast.email_address | string |
Die E-Mail-Adresse. |
|
E-Mail-Layoutvorlage
|
broadcast.email_layout_template | string |
Die E-Mail-Layoutvorlage. |
Erstellen eines Kaufs
Erstellen Sie einen Kauf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Buchungskennung
|
transaction_id | True | string |
Der eindeutige Bezeichner der Transaktion. |
|
E-Mail-Adresse
|
email_address | True | string |
Die E-Mail-Adresse. |
|
Vorname
|
first_name | string |
Der Vorname. |
|
|
Währung
|
currency | True | string |
Die Währung. |
|
Transaktionszeit
|
transaction_time | string |
Die Transaktionszeit. |
|
|
Zwischensumme
|
subtotal | integer |
Das Teilergebnis. |
|
|
Steuer
|
tax | integer |
Die Steuer. |
|
|
Versand
|
shipping | integer |
Der Versand. |
|
|
Rabatt
|
discount | integer |
Der Rabatt. |
|
|
Total
|
total | integer |
Die Summe. |
|
|
Der Status
|
status | string |
Der Status. |
|
|
PID
|
pid | True | integer |
Der persönliche Bezeichner. |
|
DECKEL
|
lid | True | integer |
Der LID. |
|
Name
|
name | True | string |
Der Name. |
|
Artikelnummer (SKU)
|
sku | string |
Die SKU. |
|
|
Einheitspreis
|
unit_price | True | integer |
Der Einzelpreis. |
|
Menge
|
quantity | True | integer |
Die Menge. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der eindeutige Bezeichner. |
|
Buchungskennung
|
transaction_id | string |
Der eindeutige Bezeichner der Transaktion. |
|
Der Status
|
status | string |
Der Status. |
|
E-Mail-Adresse
|
email_address | string |
Die E-Mail-Adresse. |
|
Währung
|
currency | string |
Die Währung. |
|
Transaktionszeit
|
transaction_time | string |
Die Transaktionszeit. |
|
Zwischensumme
|
subtotal | integer |
Das Teilergebnis. |
|
Rabatt
|
discount | integer |
Der Rabatt. |
|
Steuer
|
tax | integer |
Die Steuer. |
|
Versand
|
shipping | integer |
Der Versand. |
|
Total
|
total | integer |
Die Summe. |
|
Products
|
products | array of object | |
|
Einheitspreis
|
products.unit_price | integer |
Der Einzelpreis. |
|
Menge
|
products.quantity | integer |
Die Menge. |
|
Artikelnummer (SKU)
|
products.sku | string |
Die SKU. |
|
Name
|
products.name | string |
Der Name. |
Erstellen eines Tags
Erstellt ein neues Tag.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Konto-ID
|
account_id | integer |
Der eindeutige Kontobezeichner. |
|
Erstellt unter
|
created_at | string |
Beim Erstellen bei. |
|
Gelöscht am
|
deleted_at | string |
Beim Löschen bei. |
|
ID
|
id | integer |
Der eindeutige Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Staat
|
state | string |
Das Land/die Region. |
|
Aktualisiert unter
|
updated_at | string |
Wenn aktualisiert unter. |
Erwerben eines Einkaufs
Rufen Sie einen bestimmten Kauf nach ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Einkaufs-ID
|
purchase_id | True | string |
Der Einkaufsbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der eindeutige Bezeichner. |
|
Buchungskennung
|
transaction_id | string |
Der eindeutige Bezeichner der Transaktion. |
|
Der Status
|
status | string |
Der Status. |
|
E-Mail-Adresse
|
email_address | string |
Die E-Mail-Adresse. |
|
Währung
|
currency | string |
Die Währung. |
|
Transaktionszeit
|
transaction_time | string |
Die Transaktionszeit. |
|
Zwischensumme
|
subtotal | integer |
Das Teilergebnis. |
|
Versand
|
shipping | integer |
Der Versand. |
|
Rabatt
|
discount | integer |
Der Rabatt. |
|
Steuer
|
tax | integer |
Die Steuer. |
|
Total
|
total | integer |
Die Summe. |
|
Products
|
products | array of object | |
|
Einheitspreis
|
products.unit_price | integer |
Der Einzelpreis. |
|
Menge
|
products.quantity | integer |
Die Menge. |
|
Artikelnummer (SKU)
|
products.sku | string |
Die SKU. |
|
Name
|
products.name | string |
Der Name. |
Hinzufügen eines Abonnenten zu einem Formular
Abonnieren Sie eine E-Mail-Adresse für eines Ihrer Formulare.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Formular-ID
|
form_id | True | string |
Der eindeutige Bezeichner des Formulars. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
|
|
Vorname
|
first_name | string |
Der Vorname. |
|
|
Stichwörter
|
tags | array of integer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | integer |
Der eindeutige Bezeichner. |
|
Staat
|
subscription.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscription.created_at | string |
Beim Erstellen bei. |
|
Quelle
|
subscription.source | string |
Die Quelle. |
|
Verweiser
|
subscription.referrer | string |
Der Verweiser. |
|
Abonnierbare ID
|
subscription.subscribable_id | integer |
Der abonnierbare eindeutige Bezeichner. |
|
Abonnierbarer Typ
|
subscription.subscribable_type | string |
Der abonnierbare Typ. |
|
ID
|
subscription.subscriber.id | integer |
Der eindeutige Bezeichner. |
|
Vorname
|
subscription.subscriber.first_name | string |
Der Vorname. |
|
E-Mail-Adresse
|
subscription.subscriber.email_address | string |
Die E-Mail-Adresse. |
|
Staat
|
subscription.subscriber.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscription.subscriber.created_at | string |
Beim Erstellen bei. |
Hinzufügen eines Abonnents zu einer Sequenz
Abonnieren Sie eine E-Mail-Adresse für eine Ihrer Sequenzen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sequenz ID
|
sequence_id | True | string |
Der eindeutige Bezeichner der Sequenz. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
|
|
Vorname
|
first_name | string |
Der Vorname. |
|
|
Stichwörter
|
tags | array of integer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | integer |
Der eindeutige Bezeichner. |
|
Staat
|
subscription.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscription.created_at | string |
Beim Erstellen bei. |
|
Quelle
|
subscription.source | string |
Die Quelle. |
|
Verweiser
|
subscription.referrer | string |
Der Verweiser. |
|
Abonnierbare ID
|
subscription.subscribable_id | integer |
Der abonnierbare eindeutige Bezeichner. |
|
Abonnierbarer Typ
|
subscription.subscribable_type | string |
Der abonnierbare Typ. |
|
ID
|
subscription.subscriber.id | integer |
Der eindeutige Bezeichner. |
Kategorisieren eines Abonnenten
Tags werden als Abonnements behandelt. Abonnieren Sie eine E-Mail-Adresse für ein Tag, damit dieses Tag auf den Abonnenten mit dieser E-Mail-Adresse angewendet wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Tag-ID
|
tag_id | True | string |
Der eindeutige Tagbezeichner. |
|
Email
|
string |
Die E-Mail-Adresse. |
||
|
Vorname
|
first_name | string |
Der Vorname. |
|
|
Stichwörter
|
tags | array of integer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | integer |
Der eindeutige Bezeichner. |
|
Staat
|
subscription.state | string |
Das Land/die Region. |
|
Erstellt unter
|
subscription.created_at | string |
Beim Erstellen bei. |
|
Quelle
|
subscription.source | string |
Die Quelle. |
|
Verweiser
|
subscription.referrer | string |
Der Verweiser. |
|
Abonnierbare ID
|
subscription.subscribable_id | integer |
Der abonnierbare eindeutige Bezeichner. |
|
Abonnierbarer Typ
|
subscription.subscribable_type | string |
Der abonnierbare Typ. |
|
ID
|
subscription.subscriber.id | integer |
Der eindeutige Bezeichner. |
Konto abrufen
Ruft das aktuelle Konto ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Name
|
name | string |
Der Name. |
|
Plantyp
|
plan_type | string |
Der Plantyp. |
|
Primäre E-Mail-Adresse
|
primary_email_address | string |
Die primäre E-Mail-Adresse. |
Listenabonnenttags
Ruft eine Liste aller Tags für einen Abonnenten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnenten-ID
|
subscriber_id | True | string |
Der eindeutige Bezeichner des Abonnenten. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Stichwörter
|
tags | array of object | |
|
ID
|
tags.id | integer |
Der eindeutige Bezeichner. |
|
Name
|
tags.name | string |
Der Name. |
|
Erstellt unter
|
tags.created_at | string |
Beim Erstellen bei. |
Listensequenzen
Ruft eine Liste der Sequenzen für das Konto ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kurse
|
courses | array of object | |
|
ID
|
courses.id | integer |
Der eindeutige Bezeichner. |
|
Name
|
courses.name | string |
Der Name. |
|
Erstellt unter
|
courses.created_at | string |
Beim Erstellen bei. |
Tag aus Abonnent entfernen
Entfernt ein Tag aus einem Abonnent.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnenten-ID
|
subscriber_id | True | string |
Der eindeutige Bezeichner des Abonnenten. |
|
Tag-ID
|
tag_id | True | string |
Der eindeutige Tagbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der eindeutige Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Erstellt unter
|
created_at | string |
Beim Erstellen bei. |
Tag aus Abonnenten per E-Mail entfernen
Entfernen Sie ein Tag von einem Abonnenten per E-Mail-Adresse.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Tag-ID
|
tag_id | True | string |
Der eindeutige Tagbezeichner. |
|
Email
|
True | string |
Die E-Mail-Adresse. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
id | integer |
Der eindeutige Bezeichner. |
|
Name
|
name | string |
Der Name. |
|
Erstellt unter
|
created_at | string |
Beim Erstellen bei. |
Zerstören einer Übertragung
Endgültig löschen Sie einen Entwurfs- oder geplanten Übertragungsdatensatz. Übertragungen, die derzeit gesendet oder gesendet wurden, werden möglicherweise nicht gelöscht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Übertragungs-ID
|
broadcast_id | True | string |
Der eindeutige Broadcast-Bezeichner. |
Gibt zurück
- response
- string
Definitionen
Schnur
Dies ist der grundlegende Datentyp "string".