Marketo MA (Vorschau)
Marketo Marketing Automation. Diese API bietet Zugriff auf Marketo-Objekte wie Kampagnen, Programme, Leads, Listen (Statisch und Smart) sowie Dateisystemobjekte wie Dateien und Ordner.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Norm | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - 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 China-Regionen - US Department of Defense (DoD) |
| Power Apps | Norm | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Norm | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Marketo Developer Relations |
| URL | http://developers.marketo.com |
| developerfeedback@marketo.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Microsoft Inc. |
| Webseite | https://www.marketo.com/ |
| Datenschutzrichtlinie | https://documents.marketo.com/legal/privacy/ |
| Nutzungsbedingungen | https://go.microsoft.com/fwlink/?linkid=2237005 |
| Kategorien | Marketing; Vertrieb und CRM |
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 |
|---|---|---|---|
| MunchkinID | Schnur | Ihre Marketo MunchkinID (siehe Administratorseite) | Richtig |
| Kunden-ID | Schnur | Kunden-ID | Richtig |
| Geheimer Clientschlüssel | securestring | Geheimer Clientschlüssel | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen von Dateien |
Gibt die Dateien aus dem angegebenen Ordner zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Abrufen von Export-Leadaufträgen |
Gibt eine Liste der Exportaufträge zurück, die in den letzten 7 Tagen erstellt wurden. Erforderliche Berechtigungen: Read-Only Lead |
| Abrufen von Exportprogramm-Mitgliedsaufträgen |
Gibt eine Liste der Exportaufträge zurück, die in den letzten 7 Tagen erstellt wurden. Erforderliche Berechtigungen: Read-Only Lead |
| Abrufen von Import-Leadfehlern |
Gibt die Liste der Fehler für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead |
| Abrufen von Importvorführungswarnungen |
Gibt die Liste der Warnungen für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead |
| Abrufen von Warnungen zu Importprogrammmitglieden |
Gibt die Liste der Warnungen für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead |
| Anforderungskampagne |
Übergibt eine Reihe von Leads an eine Triggerkampagne, um den Fluss der Kampagne zu durchlaufen. Die angegebene Kampagne muss über eine Kampagne verfügen: Webdienst-API-Trigger und muss aktiv sein. Meine lokalen Token im übergeordneten Programm der Kampagne können für die Ausführung überschrieben werden, um Inhalte anzupassen. Pro Anruf sind maximal 100 Leads zulässig. Erforderliche Berechtigungen: Kampagne ausführen |
| Aus Liste entfernen |
Entfernt eine bestimmte Gruppe von Personendatensätzen aus einer statischen Zielliste. Erforderliche Berechtigungen: Read-Write Lead |
| Beschreiben von Lead |
Gibt Metadaten zu Leadobjekten in der Zielinstanz zurück, einschließlich einer Liste aller Felder, die über die APIs für die Interaktion verfügbar sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Beschreiben von Lead2 |
Gibt eine Liste der durchsuchbaren Felder für Leadobjekte in der Zielinstanz zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Datei erstellen |
Erstellt eine neue Datei aus der enthaltenen Nutzlast. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Datei nach ID abrufen |
Gibt den Dateidatensatz für die angegebene ID zurück. Erforderliche Berechtigungen: Read-Only Assets, Read-Write Assets |
| Datei nach Name abrufen |
Gibt Dateien Datensätze für den angegebenen Namen zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Dateiinhalt aktualisieren |
Ersetzt den aktuellen Inhalt der Datei durch die enthaltene Nutzlast. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Enqueue Export Lead Job |
Exportauftrag Enqueue. Dadurch wird der Exportauftrag in der Warteschlange platziert und der Auftrag gestartet, wenn Computerressourcen verfügbar werden. Der Exportauftrag muss sich im Zustand "Erstellt" befinden. Verwenden Sie den Endpunkt "Export lead job status" zum Abrufen des Status des Exportauftrags. Erforderliche Berechtigungen: Read-Only Lead |
| Enqueue Export Program Mitglied Job |
Exportauftrag Enqueue. Dadurch wird der Exportauftrag in der Warteschlange platziert und der Auftrag gestartet, wenn Computerressourcen verfügbar werden. Der Exportauftrag muss sich im Zustand "Erstellt" befinden. |
| Export-Leadauftrag erstellen |
Erstellen Sie den Exportauftrag für Suchkriterien, die über den Parameter "filter" definiert sind. Die Anforderung gibt die "exportId" zurück, die als Parameter in nachfolgenden Aufrufen von Leads-Endpunkten für Massenexporte übergeben wird. Verwenden Sie den Enqueue Export Lead Job-Endpunkt, um den Exportauftrag für die Verarbeitung in die Warteschlange zu stellen. Verwenden Sie den Endpunkt "Export lead job status" zum Abrufen des Status des Exportauftrags. Erforderliche Berechtigungen: Read-Only Lead |
| Export Leadauftragsstatus abrufen |
Gibt den Status eines Exportauftrags zurück. Der Auftragsstatus ist 30 Tage nach Dem Erreichen des Status "Abgeschlossen" oder "Fehlgeschlagen" verfügbar. Erforderliche Berechtigungen: Read-Only Lead |
| Export-Leaddatei abrufen |
Gibt den Dateiinhalt eines Exportauftrags zurück. Der Exportauftrag muss sich im Status "Abgeschlossen" befinden. Verwenden Sie den Endpunkt "Export lead job status" zum Abrufen des Status des Exportauftrags. Erforderliche Berechtigungen: Read-Only Lead |
| Exportprogrammmitgliedsauftrag abbrechen |
Exportauftrag abbrechen. Erforderliche Berechtigungen: Read-Only Lead |
| Exportprogrammmitgliedsauftrag erstellen |
Erstellen Sie den Exportauftrag für Suchkriterien, die über den Parameter "filter" definiert sind. Die Anforderung gibt die "exportId" zurück, die als Parameter in nachfolgenden Aufrufen an Endpunkte des Massenexportprogramms übergeben wird. |
| Exportprogrammmitgliedsdatei abrufen |
Gibt den Dateiinhalt eines Exportauftrags zurück. Der Exportauftrag muss sich im Status "Abgeschlossen" befinden. Verwenden Sie den Endpunkt "Export Program Member Job Status", um den Status des Exportauftrags abzurufen. Erforderliche Berechtigungen: Read-Only Lead |
| Exportvorstellung abbrechen |
Exportauftrag abbrechen. Erforderliche Berechtigungen: Read-Only Lead |
| Fehler des Importprogramms abrufen |
Gibt die Liste der Fehler für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead |
| Identität |
Rufen Sie ein Zugriffstoken von Marketo ab. Aufrufe an diesen Endpunkt werden nicht auf das API-Aufruflimit gezählt. |
| Identität |
Rufen Sie ein Zugriffstoken von Marketo ab. Aufrufe an diesen Endpunkt werden nicht auf das API-Aufruflimit gezählt. |
| Import-Leadstatus abrufen |
Gibt den Status eines Importbatchauftrags zurück. Erforderliche Berechtigungen: Read-Write Lead |
| Importprogrammmitglieder |
Importiert eine Datei, die Datensätze enthält, in die Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead |
| Importprogrammmitgliedsstatus abrufen |
Gibt den Status eines Importbatchauftrags zurück. Erforderliche Berechtigungen: Read-Write Lead |
| Intelligente Liste klonen |
Klont die festgelegte Smart List. Erforderliche Berechtigungen: Read-Write Ressource |
| Intelligente Liste löschen |
Löscht die festgelegte Smart List. Erforderliche Berechtigungen: Read-Write Ressource |
| Intelligente Liste nach ID abrufen |
Ruft einen Smart List-Eintrag anhand seiner ID ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource |
| Intelligente Liste nach Name abrufen |
Ruft einen Smart List-Eintrag anhand seines Namens ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource |
| Intelligente Liste nach Programm-ID abrufen |
Ruft einen Smart List-Eintrag anhand seiner E-Mail-Programm-ID ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource |
| Intelligente Listen abrufen |
Ruft eine Liste der vom Benutzer erstellten Smart List-Datensätze ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource |
| Kampagne nach ID abrufen |
Gibt den Datensatz einer Kampagne anhand ihrer ID zurück. Erforderliche Berechtigungen: Read-Only Kampagnen, Read-Write Kampagnen |
| Kampagne planen |
Plant remote eine Batchkampagne für die Ausführung zu einem bestimmten Zeitpunkt. Meine lokalen Token im übergeordneten Programm der Kampagne können für die Ausführung überschrieben werden, um Inhalte anzupassen. Bei Verwendung des unten beschriebenen Parameters "cloneToProgramName" ist dieser Endpunkt auf 20 Aufrufe pro Tag beschränkt. Erforderliche Berechtigungen: Kampagne ausführen |
| Kampagnen abrufen |
Gibt eine Liste von Kampagnendatensätzen zurück. Erforderliche Berechtigungen: Read-Only Kampagnen, Read-Write Kampagnen |
| Klonen des Programms |
Klont das Zielprogramm. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Lead by Id abrufen |
Ruft einen einzelnen Leaddatensatz über seine Marketo-ID ab. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Leadfeld aktualisieren |
Aktualisieren sie Metadaten für ein Leadfeld in der Zielinstanz. Hier finden Sie Aktualisierungsregeln. Erforderliche Berechtigungen: Read-Write Schemastandardfeld, Read-Write benutzerdefiniertes Schemafeld |
| Leadfeld nach Name abrufen |
Ruft Metadaten für ein einzelnes Leadfeld ab. Erforderliche Berechtigungen: Read-Write Schemastandardfeld, Read-Write benutzerdefiniertes Schemafeld |
| Leads importieren |
Importiert eine Datei, die Datensätze enthält, in die Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead |
| Leads löschen |
Löschen sie eine Liste von Leads aus der Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead |
| Leads nach Filtertyp abrufen |
Gibt eine Liste von bis zu 300 Leads basierend auf einer Liste von Werten in einem bestimmten Feld zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Leads nach Listen-ID abrufen |
Ruft Personendatensätze ab, die Mitglieder der angegebenen statischen Liste sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Leads nach Listen-ID abrufen |
Ruft Personendatensätze ab, die Mitglieder der angegebenen statischen Liste sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Leads nach Programm-ID abrufen |
Ruft eine Liste von Leads ab, die Mitglieder des angegebenen Programms sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Leads synchronisieren |
Synchronisiert eine Liste von Leads mit der Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead |
| Liste nach ID abrufen |
Gibt einen Listendatensatz anhand seiner ID zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Listen abrufen |
Gibt einen Satz statischer Listendatensätze basierend auf bestimmten Filterparametern zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Mitglied der Liste |
Überprüft, ob Leads Mitglieder einer bestimmten statischen Liste sind. Erforderliche Berechtigungen: Read-Write Lead |
| Nicht genehmigtes Programm |
Hebt die Genehmigung des Zielprogramms auf. Nur gültig für genehmigte E-Mail-Programme. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Ordner abrufen |
Ruft untergeordnete Ordner aus einem bestimmten Stammordner ab. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Ordner erstellen |
Erstellt einen neuen Ordner. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Ordner löschen |
Löscht den angegebenen Ordner. Das Löschen schlägt fehl, wenn der Ordner Inhalte enthält. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Ordner nach ID abrufen |
Gibt den Ordnerdatensatz mit der angegebenen ID zurück. Erforderliche Berechtigungen: Read-Only Assets, Read-Write Assets |
| Ordner nach Name abrufen |
Gibt einen Ordnerdatensatz für den angegebenen Namen zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Ordnerinhalte abrufen |
Gibt Datensätze für den Inhalt eines bestimmten Ordners zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Ordnermetadaten aktualisieren |
Aktualisiert die Metadaten für einen bestimmten Ordner. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Programm erstellen |
Erstellt ein neues Programm. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Programm genehmigen |
Genehmigt das Zielprogramm. Nur gültig für nicht genehmigte E-Mail-Programme. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Programm löschen |
Löscht das Zielprogramm. Das Programm darf keine Ressourcen enthalten, die außerhalb des Programms verwendet werden. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Programm nach ID abrufen |
Ruft den Programmdatensatz für die angegebene ID ab. Erforderliche Berechtigungen: Read-Only Assets, Read-Write Assets |
| Programm nach Name abrufen |
Ruft den Programmdatensatz für den angegebenen Namen ab. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Programme abrufen |
Ruft die Liste der barrierefreien Programme aus der Zielinstanz ab. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Programme nach Tag abrufen |
Ruft eine Liste der Programme ab, die dem angegebenen Tagtyp und den angegebenen Tagwerten entsprechen. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen |
| Programmmetadaten aktualisieren |
Aktualisiert die Metadaten des Zielprogramms. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Programmmitglied beschreiben |
Gibt Metadaten zu Programmmitgliedsobjekten in der Zielinstanz zurück, einschließlich einer Liste aller Felder, die für die Interaktion über die APIs verfügbar sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Programmmitglied beschreiben |
Gibt Metadaten zu Programmmitgliedsobjekten in der Zielinstanz zurück, einschließlich einer Liste aller Felder, die für die Interaktion über die APIs verfügbar sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Programmmitglieder abrufen |
Gibt eine Liste von bis zu 300 Programmmitgliedern in einer Liste von Werten in einem bestimmten Feld zurück. Wenn Sie einen filterType angeben, der ein benutzerdefiniertes Feld ist, muss der Datentyp des benutzerdefinierten Felds entweder "string" oder "integer" sein. Wenn Sie einen anderen filterType als "leadId" angeben, können maximal 100.000 Programmmitgliedsdatensätze von der Anforderung verarbeitet werden. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead |
| Programmmitglieder löschen |
Löschen einer Liste von Mitgliedern aus der Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead |
| Programmmitgliedsdaten synchronisieren |
Ändert die Programmmitgliedsdaten einer Liste von Leads in einem Zielprogramm. Nur vorhandene Mitglieder des Programms können ihre Daten mit dieser API geändert haben. Erforderliche Berechtigungen: Read-Write Lead |
| Programmmitgliedsfeld nach Name abrufen |
Ruft Metadaten für ein einzelnes Programmmitgliedsfeld ab. Erforderliche Berechtigungen: Read-Write Schemastandardfeld, Read-Write benutzerdefiniertes Schemafeld |
| Programmtag aktualisieren |
Programmtag aktualisieren. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Programmtag löschen |
Löschen Sie nicht erforderliches Programmtag. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Push Lead zu Marketo |
Upserts einen Lead und generiert einen Push-Lead zu Marketo-Aktivitäten. Erforderliche Berechtigungen: Read-Write Lead |
| Statische Liste erstellen |
Erstellt eine neue statische Liste. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Statische Liste löschen |
Löscht die festgelegte statische Liste. Erforderliche Berechtigungen: Read-Write Ressource |
| Statische Liste nach ID abrufen |
Ruft einen statischen Listendatensatz anhand seiner ID ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource |
| Statische Liste nach Name abrufen |
Ruft einen statischen Listendatensatz anhand seines Namens ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource |
| Statische Listen abrufen |
Ruft eine Liste statischer Listeneinträge ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource |
| Statische Listenmetadaten aktualisieren |
Aktualisiert die Metadaten eines statischen Listenobjekts. Erforderliche Berechtigungen: Read-Write Ressourcen |
| Status des Exportprogramms-Mitgliedsauftrags abrufen |
Gibt den Status eines Exportauftrags zurück. Der Auftragsstatus ist 30 Tage nach Dem Erreichen des Status "Abgeschlossen" oder "Fehlgeschlagen" verfügbar. Erforderliche Berechtigungen: Read-Only Lead |
| Status des Synchronisierungsprogrammmitglieds |
Ändert den Status des Programmmitglieds einer Liste von Leads in einem Zielprogramm. Wenn Mitglied nicht Teil des Programms ist, wird das Mitglied dem Programm hinzugefügt. Erforderliche Berechtigungen: Read-Write Lead |
| Zur Liste hinzufügen |
Fügt einer statischen Zielliste eine bestimmte Gruppe von Personendatensätzen hinzu. Es gibt eine Beschränkung von 300 Lead-IDs pro Anforderung. Erforderliche Berechtigungen: Read-Write Lead |
Abrufen von Dateien
Gibt die Dateien aus dem angegebenen Ordner zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
id
|
id | True | integer |
ID des Ordners |
|
type
|
type | True | string |
Ordnertyp |
|
max-Rendite
|
maxReturn | integer |
Maximale Anzahl von Kanälen, die zurückgegeben werden sollen. Max 200, Standard 20 |
|
|
offset
|
offset | integer |
Ganzzahliger Offset für Paging |
|
|
Der Ordner, in dem die Datei abgelegt werden soll
|
folder | string |
JSON-Darstellung des übergeordneten Ordners mit Mitgliedern "ID" und "Typ", die "Folder" oder "Program" sein können |
Gibt zurück
Abrufen von Export-Leadaufträgen
Gibt eine Liste der Exportaufträge zurück, die in den letzten 7 Tagen erstellt wurden. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Durch Trennzeichen getrennte Liste der status, nach der gefiltert werden soll.
|
status | array |
Durch Trennzeichen getrennte Liste der status, nach der gefiltert werden soll. |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Das token der nächsten Seite
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
Abrufen von Exportprogramm-Mitgliedsaufträgen
Gibt eine Liste der Exportaufträge zurück, die in den letzten 7 Tagen erstellt wurden. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Durch Trennzeichen getrennte Liste der status, nach der gefiltert werden soll.
|
status | array |
Durch Trennzeichen getrennte Liste der status, nach der gefiltert werden soll. |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
Abrufen von Import-Leadfehlern
Gibt die Liste der Fehler für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Importbatchauftrags.
|
batchId | True | integer |
ID des Importbatchauftrags. |
Gibt zurück
- response
- object
Abrufen von Importvorführungswarnungen
Gibt die Liste der Warnungen für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Importbatchauftrags.
|
batchId | True | integer |
ID des Importbatchauftrags. |
Gibt zurück
- response
- object
Abrufen von Warnungen zu Importprogrammmitglieden
Gibt die Liste der Warnungen für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Importbatchauftrags.
|
batchId | True | integer |
ID des Importbatchauftrags. |
Gibt zurück
- response
- object
Anforderungskampagne
Übergibt eine Reihe von Leads an eine Triggerkampagne, um den Fluss der Kampagne zu durchlaufen. Die angegebene Kampagne muss über eine Kampagne verfügen: Webdienst-API-Trigger und muss aktiv sein. Meine lokalen Token im übergeordneten Programm der Kampagne können für die Ausführung überschrieben werden, um Inhalte anzupassen. Pro Anruf sind maximal 100 Leads zulässig. Erforderliche Berechtigungen: Kampagne ausführen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID der auszulösende Kampagne
|
campaignId | True | integer |
Die ID der auszulösende Kampagne |
|
id
|
id | True | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
name
|
name | True | string |
Name des Tokens. Sollte als "{{my.name}}" formatiert werden. |
|
value
|
value | True | string |
Wert des Tokens |
Gibt zurück
- Body
- ResponseOfCampaign
Aus Liste entfernen
Entfernt eine bestimmte Gruppe von Personendatensätzen aus einer statischen Zielliste. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der statischen Liste zum Entfernen von Leads aus
|
listId | True | integer |
ID der statischen Liste zum Entfernen von Leads aus |
|
id
|
id | True | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
id
|
id | True | array |
id |
Gibt zurück
Beschreiben von Lead
Gibt Metadaten zu Leadobjekten in der Zielinstanz zurück, einschließlich einer Liste aller Felder, die über die APIs für die Interaktion verfügbar sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Hinweis: Dieser Endpunkt wurde abgelöst. Verwenden Sie stattdessen Den Lead2-Endpunkt beschreiben .
Gibt zurück
Beschreiben von Lead2
Gibt eine Liste der durchsuchbaren Felder für Leadobjekte in der Zielinstanz zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Gibt zurück
Datei erstellen
Erstellt eine neue Datei aus der enthaltenen Nutzlast. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Beschreibung
|
description | string |
Beschreibung der Ressource |
|
|
file
|
file | True | string |
Mehrteilige Datei. Inhalt der Datei. |
|
id
|
id | True | integer |
ID des Ordners |
|
type
|
type | True | string |
Ordnertyp |
|
insertOnly
|
insertOnly | boolean |
Gibt an, ob die Aufrufe fehlschlagen, wenn bereits eine Datei mit demselben Namen vorhanden ist. |
|
|
name
|
name | True | string |
Name der Datei |
Gibt zurück
Datei nach ID abrufen
Gibt den Dateidatensatz für die angegebene ID zurück. Erforderliche Berechtigungen: Read-Only Assets, Read-Write Assets
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID der Datei
|
id | True | integer |
ID für Datei in der Datenbank |
Gibt zurück
Datei nach Name abrufen
Gibt Dateien Datensätze für den angegebenen Namen zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der Name der Datei
|
name | True | string |
Name der Datei |
Gibt zurück
Dateiinhalt aktualisieren
Ersetzt den aktuellen Inhalt der Datei durch die enthaltene Nutzlast. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID der Datei
|
id | True | integer |
ID für Datei in der Datenbank |
|
file
|
file | True | string |
Mehrteilige Datei. Inhalt der Datei. |
|
id
|
id | True | integer |
ID der Datei |
Gibt zurück
Enqueue Export Lead Job
Exportauftrag Enqueue. Dadurch wird der Exportauftrag in der Warteschlange platziert und der Auftrag gestartet, wenn Computerressourcen verfügbar werden. Der Exportauftrag muss sich im Zustand "Erstellt" befinden. Verwenden Sie den Endpunkt "Export lead job status" zum Abrufen des Status des Exportauftrags. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Exportbatchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
Gibt zurück
Enqueue Export Program Mitglied Job
Exportauftrag Enqueue. Dadurch wird der Exportauftrag in der Warteschlange platziert und der Auftrag gestartet, wenn Computerressourcen verfügbar werden. Der Exportauftrag muss sich im Zustand "Erstellt" befinden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Batchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
Gibt zurück
Export-Leadauftrag erstellen
Erstellen Sie den Exportauftrag für Suchkriterien, die über den Parameter "filter" definiert sind. Die Anforderung gibt die "exportId" zurück, die als Parameter in nachfolgenden Aufrufen von Leads-Endpunkten für Massenexporte übergeben wird. Verwenden Sie den Enqueue Export Lead Job-Endpunkt, um den Exportauftrag für die Verarbeitung in die Warteschlange zu stellen. Verwenden Sie den Endpunkt "Export lead job status" zum Abrufen des Status des Exportauftrags. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
name
|
name | True | string |
REST-API-Name für Kopfzeilenfeld |
|
value
|
value | True | string |
Wert für Kopfzeilenfeld |
|
fields
|
fields | True | array of string |
Durch Trennzeichen getrennte Liste der Felder, die in die Datei eingeschlossen werden sollen |
|
endAt
|
endAt | string |
End of date range filter (ISO 8601-format) |
|
|
startAt
|
startAt | string |
Start des Datumsbereichsfilters (ISO-8601-Format) |
|
|
smartListId
|
smartListId | True | integer |
ID der intelligenten Liste zum Abrufen von Leads aus |
|
smartListName
|
smartListName | True | string |
Name der intelligenten Liste zum Abrufen von Leads aus |
|
staticListId
|
staticListId | True | integer |
ID der statischen Liste zum Abrufen von Leads aus |
|
staticListName
|
staticListName | True | string |
Name der statischen Liste zum Abrufen von Leads aus |
|
format
|
format | string |
Dateiformat zum Erstellen("CSV", "TSV", "SSV"). Der Standardwert ist "CSV" |
Gibt zurück
Export Leadauftragsstatus abrufen
Gibt den Status eines Exportauftrags zurück. Der Auftragsstatus ist 30 Tage nach Dem Erreichen des Status "Abgeschlossen" oder "Fehlgeschlagen" verfügbar. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Exportbatchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
Gibt zurück
Export-Leaddatei abrufen
Gibt den Dateiinhalt eines Exportauftrags zurück. Der Exportauftrag muss sich im Status "Abgeschlossen" befinden. Verwenden Sie den Endpunkt "Export lead job status" zum Abrufen des Status des Exportauftrags. Erforderliche Berechtigungen: Read-Only Lead
Das Dateiformat wird durch Aufrufen des Endpunkts "Leadauftrag erstellen" angegeben. Nachfolgend sehen Sie ein Beispiel für das Standarddateiformat ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Exportbatchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
|
So unterstützen Sie den teilweisen Abruf extrahierter Daten
|
Range | string |
Zur Unterstützung des teilweisen Abrufs extrahierter Daten kann der HTTP-Header "Range" vom Typ "Bytes" angegeben werden. Weitere Informationen finden Sie unter RFC 2616 "Range Retrieval Requests". Wenn die Kopfzeile nicht festgelegt ist, wird der gesamte Inhalt zurückgegeben. |
Gibt zurück
- response
- object
Exportprogrammmitgliedsauftrag abbrechen
Exportauftrag abbrechen. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Exportbatchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
Gibt zurück
Exportprogrammmitgliedsauftrag erstellen
Erstellen Sie den Exportauftrag für Suchkriterien, die über den Parameter "filter" definiert sind. Die Anforderung gibt die "exportId" zurück, die als Parameter in nachfolgenden Aufrufen an Endpunkte des Massenexportprogramms übergeben wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
name
|
name | True | string |
REST-API-Name für Kopfzeilenfeld |
|
value
|
value | True | string |
Wert für Kopfzeilenfeld |
|
fields
|
fields | True | array of string |
Durch Trennzeichen getrennte Liste der Felder, die in die Datei eingeschlossen werden sollen |
|
programId
|
programId | True | integer |
ID des Programms, aus dem Mitglieder abgerufen werden sollen. Kann nicht in Kombination mit dem Filter "programIds" verwendet werden. |
|
programIds
|
programIds | True | array of integer |
Array von Programm-IDs zum Abrufen von Mitgliedern aus. Kann nicht in Kombination mit dem Filter "programId" verwendet werden. |
|
isExhausted
|
isExhausted | boolean |
Filtern von Programmmitgliedschaftsdatensätzen für Personen mit erschöpften Inhalten |
|
|
nurtureCadence
|
nurtureCadence | string |
Filtern von Programmmitgliedschaftsdatensätzen für einen bestimmten Berücksichtigungsrhythmen |
|
|
statusNames
|
statusNames | array of string |
Array von Programmmitgliedsstatusnamen. Kann Standard und/oder benutzerdefiniert sein. Mehrere Statusnamen werden zusammengelassen. |
|
|
endAt
|
endAt | string |
End of date range filter (ISO 8601-format) |
|
|
startAt
|
startAt | string |
Start des Datumsbereichsfilters (ISO-8601-Format) |
|
|
format
|
format | string |
Dateiformat zum Erstellen("CSV", "TSV", "SSV"). Der Standardwert ist "CSV" |
Gibt zurück
Exportprogrammmitgliedsdatei abrufen
Gibt den Dateiinhalt eines Exportauftrags zurück. Der Exportauftrag muss sich im Status "Abgeschlossen" befinden. Verwenden Sie den Endpunkt "Export Program Member Job Status", um den Status des Exportauftrags abzurufen. Erforderliche Berechtigungen: Read-Only Lead
Das Dateiformat wird durch Aufrufen des Endpunkts "Programmmitgliedsauftrag erstellen" angegeben. Nachfolgend sehen Sie ein Beispiel für das Standarddateiformat ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Exportbatchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
|
Zur Unterstützung des teilweisen Abrufs extrahierter Daten.
|
Range | string |
Zur Unterstützung des teilweisen Abrufs extrahierter Daten kann der HTTP-Header "Range" vom Typ "Bytes" angegeben werden. Weitere Informationen finden Sie unter RFC 2616 "Range Retrieval Requests". Wenn die Kopfzeile nicht festgelegt ist, wird der gesamte Inhalt zurückgegeben. |
Gibt zurück
- response
- object
Exportvorstellung abbrechen
Exportauftrag abbrechen. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Exportbatchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
Gibt zurück
Fehler des Importprogramms abrufen
Gibt die Liste der Fehler für den Importbatchauftrag zurück. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Importbatchauftrags.
|
batchId | True | integer |
ID des Importbatchauftrags. |
Gibt zurück
- response
- object
Identität
Rufen Sie ein Zugriffstoken von Marketo ab. Aufrufe an diesen Endpunkt werden nicht auf das API-Aufruflimit gezählt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ClientID für die Marketo REST-API
|
client_id | True | string |
Client-ID aus dem Startpunktmenü "Administratorintegration >> ". |
|
Der geheime Clientschlüssel für die Marketo REST-API
|
client_secret | True | string |
Geheimer Clientschlüssel aus dem Startpunktmenü "Administratorintegration >> ". |
|
Der Typ der Erteilung. Unsere Kundenanmeldeinformationen für Den Fall
|
grant_type | True | string |
Fördertyp. |
Gibt zurück
- Body
- ResponseOfIdentity
Identität
Rufen Sie ein Zugriffstoken von Marketo ab. Aufrufe an diesen Endpunkt werden nicht auf das API-Aufruflimit gezählt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ClientID für die Marketo REST-API
|
client_id | True | string |
Client-ID aus dem Startpunktmenü "Administratorintegration >> ". |
|
Der geheime Clientschlüssel für die Marketo REST-API
|
client_secret | True | string |
Geheimer Clientschlüssel aus dem Startpunktmenü "Administratorintegration >> ". |
|
Der Typ der Erteilung. Unsere Kundenanmeldeinformationen für Den Fall
|
grant_type | True | string |
Fördertyp. |
Gibt zurück
- Body
- ResponseOfIdentity
Import-Leadstatus abrufen
Gibt den Status eines Importbatchauftrags zurück. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Importbatchauftrags.
|
batchId | True | integer |
ID des Importbatchauftrags. |
Gibt zurück
Importprogrammmitglieder
Importiert eine Datei, die Datensätze enthält, in die Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Programms, dem Mitglieder hinzugefügt werden sollen.
|
programId | True | string |
ID des Programms, dem Mitglieder hinzugefügt werden sollen. |
|
Programmmitgliedsstatus für Mitglieder, die hinzugefügt werden.
|
programMemberStatus | True | string |
Programmmitgliedsstatus für Mitglieder, die hinzugefügt werden. |
|
Importieren Sie das Dateiformat.
|
format | True | string |
Importieren Sie das Dateiformat. |
|
Datei, die die zu importierenden Datensätze enthält.
|
file | True | file |
Datei, die die zu importierenden Datensätze enthält. |
Gibt zurück
Importprogrammmitgliedsstatus abrufen
Gibt den Status eines Importbatchauftrags zurück. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Importbatchauftrags.
|
batchId | True | integer |
ID des Importbatchauftrags. |
Gibt zurück
Intelligente Liste klonen
Klont die festgelegte Smart List. Erforderliche Berechtigungen: Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der zu klonenden Intelligenten Liste
|
id | True | integer |
ID der zu klonenden Intelligenten Liste |
|
name
|
name | True | string |
Name für die geklonte intelligente Liste |
|
id
|
id | True | integer |
ID des Ordners |
|
type
|
type | True | string |
Ordnertyp |
|
Beschreibung
|
description | string |
Beschreibung der geklonten Intelligenten Liste |
Gibt zurück
Intelligente Liste löschen
Löscht die festgelegte Smart List. Erforderliche Berechtigungen: Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der zu löschenden Intelligenten Liste
|
id | True | integer |
ID der zu löschenden Intelligenten Liste |
Gibt zurück
- Body
- ResponseOfIdResponse
Intelligente Liste nach ID abrufen
Ruft einen Smart List-Eintrag anhand seiner ID ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der abzurufenden Intelligenten Liste
|
id | True | integer |
ID der abzurufenden Intelligenten Liste |
|
Legen Sie "true" fest, um Intelligente Listenregeln aufzufüllen. Standard false
|
includeRules | boolean |
Legen Sie "true" fest, um Intelligente Listenregeln aufzufüllen. Standard false |
Gibt zurück
Intelligente Liste nach Name abrufen
Ruft einen Smart List-Eintrag anhand seines Namens ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name der abzurufenden intelligenten Liste
|
name | True | string |
Name der abzurufenden intelligenten Liste |
Gibt zurück
Intelligente Liste nach Programm-ID abrufen
Ruft einen Smart List-Eintrag anhand seiner E-Mail-Programm-ID ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID für das E-Mail-Programm, das intelligente Liste zum Abrufen enthält
|
programId | True | integer |
ID für das E-Mail-Programm, das intelligente Liste zum Abrufen enthält |
|
Legen Sie "true" fest, um Intelligente Listenregeln aufzufüllen. Standard false
|
includeRules | boolean |
Legen Sie "true" fest, um Intelligente Listenregeln aufzufüllen. Standard false |
Gibt zurück
Intelligente Listen abrufen
Ruft eine Liste der vom Benutzer erstellten Smart List-Datensätze ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
JSON-Darstellung des übergeordneten Ordners
|
folder | string |
JSON-Darstellung des übergeordneten Ordners mit Mitgliedern "ID" und "Typ", die "Folder" oder "Program" sein können |
|
|
Ganzzahliger Offset für Paging
|
offset | integer |
Ganzzahliger Offset für Paging |
|
|
Maximale Anzahl von smarten Listen, die zurückgegeben werden sollen. Max 200, Standard 20.
|
maxReturn | integer |
Maximale Anzahl von smarten Listen, die zurückgegeben werden sollen. Max 200, Standard 20. |
|
|
Intelligente Listen vor diesem Datum ausschließen. Siehe Beschreibung des Datetime-Feldtyps.
|
earliestUpdatedAt | string |
Intelligente Listen vor diesem Datum ausschließen. Muss eine gültige ISO-8601-Zeichenfolge sein. Siehe Beschreibung des Datetime-Feldtyps . |
|
|
Intelligente Listen nach diesem Datum ausschließen. Siehe Beschreibung des Datetime-Feldtyps.
|
latestUpdatedAt | string |
Intelligente Listen nach diesem Datum ausschließen. Muss eine gültige ISO-8601-Zeichenfolge sein. Siehe Beschreibung des Datetime-Feldtyps . |
Gibt zurück
Kampagne nach ID abrufen
Gibt den Datensatz einer Kampagne anhand ihrer ID zurück. Erforderliche Berechtigungen: Read-Only Kampagnen, Read-Write Kampagnen
Hinweis: Dieser Endpunkt wurde abgelöst. Verwenden Sie stattdessen "Intelligente Kampagne nach ID-Endpunkt abrufen ".
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
campaignId
|
campaignId | True | integer |
campaignId |
Gibt zurück
- Body
- ResponseOfCampaign
Kampagne planen
Plant remote eine Batchkampagne für die Ausführung zu einem bestimmten Zeitpunkt. Meine lokalen Token im übergeordneten Programm der Kampagne können für die Ausführung überschrieben werden, um Inhalte anzupassen. Bei Verwendung des unten beschriebenen Parameters "cloneToProgramName" ist dieser Endpunkt auf 20 Aufrufe pro Tag beschränkt. Erforderliche Berechtigungen: Kampagne ausführen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der zu planenden Batchkampagne.
|
campaignId | True | integer |
ID der zu planenden Batchkampagne. |
|
cloneToProgramName
|
cloneToProgramName | string |
Name des resultierenden Programms. Wenn dieses Attribut festgelegt ist, wird das Kampagnen-, übergeordnete Programm und alle zugehörigen Ressourcen mit dem resultierenden neuen Namen erstellt. Das übergeordnete Programm wird geklont, und die neu erstellte Kampagne wird geplant. Das resultierende Programm wird unterhalb des übergeordneten Elements erstellt. Programme mit Codeausschnitten, Pushbenachrichtigungen, In-App-Nachrichten, statischen Listen, Berichten und sozialen Ressourcen werden auf diese Weise möglicherweise nicht geklont. |
|
|
runAt
|
runAt | date-time |
Datetime zum Ausführen der Kampagne unter. Wenn dies nicht festgelegt ist, wird die Kampagne fünf Minuten nach dem Tätigen des Anrufs ausgeführt. |
|
|
name
|
name | True | string |
Name des Tokens. Sollte als "{{my.name}}" formatiert werden. |
|
value
|
value | True | string |
Wert des Tokens |
Gibt zurück
- Body
- ResponseOfCampaign
Kampagnen abrufen
Gibt eine Liste von Kampagnendatensätzen zurück. Erforderliche Berechtigungen: Read-Only Kampagnen, Read-Write Kampagnen
Hinweis: Dieser Endpunkt wurde abgelöst. Verwenden Sie stattdessen den Endpunkt "Intelligente Kampagnen abrufen ".
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Durch Trennzeichen getrennte Liste der Kampagnen-IDs zum Zurückgeben von Datensätzen für
|
id | array |
Durch Trennzeichen getrennte Liste der Kampagnen-IDs zum Zurückgeben von Datensätzen für |
|
|
Durch Trennzeichen getrennte Liste von Namen, nach der gefiltert werden soll
|
name | array |
Durch Trennzeichen getrennte Liste von Namen, nach der gefiltert werden soll |
|
|
Durch Trennzeichen getrennte Liste der Programmnamen, nach der gefiltert werden soll.
|
programName | array |
Durch Trennzeichen getrennte Liste der Programmnamen, nach der gefiltert werden soll. Bei Festlegung werden nur Kampagnen gefiltert, die untergeordnete Elemente der angegebenen Programme sind. |
|
|
Durch Trennzeichen getrennte Liste der Arbeitsbereichsnamen, nach der gefiltert werden soll.
|
workspaceName | array |
Durch Trennzeichen getrennte Liste der Arbeitsbereichsnamen, nach der gefiltert werden soll. Wenn dieser Wert festgelegt ist, werden nur Kampagnen in den angegebenen Arbeitsbereichen zurückgegeben. |
|
|
Maximale Anzahl der zurückzugebenden Datensätze. Maximal und Standardwert ist 300.
|
batchSize | integer |
Maximale Anzahl der zurückzugebenden Datensätze. Maximal und Standardwert ist 300. |
|
|
Ein Token wird von diesem Endpunkt zurückgegeben. Weitere Informationen finden Sie unter Paging Tokens.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
|
|
if is Requested trigger and source is Web Service API
|
isTriggerable | boolean |
Auf "true" festgelegt, um aktive Kampagnen zurückzugeben, für die ein Kampagnenauslöser angefordert wurde und die Quelle die Webdienst-API ist. |
Gibt zurück
- Body
- ResponseOfCampaign
Klonen des Programms
Klont das Zielprogramm. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
|
Beschreibung
|
description | string | ||
|
id
|
id | True | integer |
ID des Ordners |
|
type
|
type | True | string |
Ordnertyp |
|
name
|
name | True | string |
Name des Programms. Max. 255 Zeichen |
Gibt zurück
Lead by Id abrufen
Ruft einen einzelnen Leaddatensatz über seine Marketo-ID ab. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die Marketo-Lead-ID
|
leadId | True | integer |
Die Marketo-Lead-ID |
|
Kommagetrennte Liste von Feldnamen.
|
fields | array |
Kommagetrennte Liste von Feldnamen. Wenn dies nicht angegeben wird, werden die folgenden Standardfelder zurückgegeben: E-Mail, updatedAt, createdAt, LastName, FirstName und ID. |
Gibt zurück
- Body
- ResponseOfLead
Leadfeld aktualisieren
Aktualisieren sie Metadaten für ein Leadfeld in der Zielinstanz. Hier finden Sie Aktualisierungsregeln. Erforderliche Berechtigungen: Read-Write Schemastandardfeld, Read-Write benutzerdefiniertes Schemafeld
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der API-Name des Leadfelds
|
fieldApiName | True | string |
Der API-Name des Leadfelds |
|
Anzeigename
|
displayName | string |
Anzeigename der Benutzeroberfläche des Felds |
|
|
Beschreibung
|
description | string |
Beschreibung des Felds |
|
|
isHidden
|
isHidden | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Feld ausgeblendet. Die Standardeinstellung ist „false“. |
|
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Feld als HTML in einer E-Mail codiert. Der Standardwert ist true |
|
|
isSensitive
|
isSensitive | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Feld als vertraulich markiert. Die Standardeinstellung ist „false“. |
Gibt zurück
Leadfeld nach Name abrufen
Ruft Metadaten für ein einzelnes Leadfeld ab. Erforderliche Berechtigungen: Read-Write Schemastandardfeld, Read-Write benutzerdefiniertes Schemafeld
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der API-Name des Leadfelds
|
fieldApiName | True | string |
Der API-Name des Leadfelds |
Gibt zurück
- Body
- ResponseOfLeadField
Leads importieren
Importiert eine Datei, die Datensätze enthält, in die Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Importieren Sie das Dateiformat.
|
format | True | string |
Importieren Sie das Dateiformat. |
|
Feld, das für die Deduplizierung verwendet werden soll. Benutzerdefinierte Felder (Zeichenfolge, E-Mail, ganze Zahl)
|
lookupField | string |
Feld, das für die Deduplizierung verwendet werden soll. Benutzerdefinierte Felder (Zeichenfolge, E-Mail, ganze Zahl) und die folgenden Feldtypen werden unterstützt: ID, Cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Der Standardwert ist E-Mail. |
|
|
Name der Leadpartition, in die importiert werden soll.
|
partitionName | string |
Name der Leadpartition, in die importiert werden soll. |
|
|
ID der zu importierenden statischen Liste.
|
listId | integer |
ID der zu importierenden statischen Liste. |
|
|
Datei, die die zu importierenden Datensätze enthält.
|
file | True | file |
Datei, die die zu importierenden Datensätze enthält. |
Gibt zurück
Leads löschen
Löschen sie eine Liste von Leads aus der Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
id
|
id | True | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
Der Parameter kann angegeben werden, wenn der Anforderungstext leer ist.
|
id | array |
Der Parameter kann angegeben werden, wenn der Anforderungstext leer ist. Es können mehrere Lead-IDs angegeben werden. z. B. id=1,2,3,2342 |
Gibt zurück
- Body
- ResponseOfLead
Leads nach Filtertyp abrufen
Gibt eine Liste von bis zu 300 Leads basierend auf einer Liste von Werten in einem bestimmten Feld zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Das Leadfeld, nach dem gefiltert werden soll.
|
filterType | True | string |
Das Leadfeld, nach dem gefiltert werden soll. Jedes benutzerdefinierte Feld (nur Zeichenfolgen-, E-Mail- oder ganzzahlige Typen) und eines der folgenden Felder werden unterstützt: Cookies, email, facebookId, id, leadPartitionId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId. |
|
Eine durch Trennzeichen getrennte Liste von Werten, nach denen in den angegebenen Feldern gefiltert werden soll.
|
filterValues | True | array |
Eine durch Trennzeichen getrennte Liste von Werten, nach denen in den angegebenen Feldern gefiltert werden soll. |
|
Eine durch Trennzeichen getrennte Liste von Leadfeldern, die für jeden Datensatz zurückgegeben werden sollen
|
fields | array |
Eine durch Trennzeichen getrennte Liste von Leadfeldern, die für jeden Datensatz zurückgegeben werden sollen |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Ein Token wird von diesem Endpunkt zurückgegeben. Weitere Informationen finden Sie unter Paging Tokens.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
- Body
- ResponseOfLead
Leads nach Listen-ID abrufen
Ruft Personendatensätze ab, die Mitglieder der angegebenen statischen Liste sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der statischen Liste zum Abrufen von Datensätzen aus
|
listId | True | integer |
ID der statischen Liste zum Abrufen von Datensätzen aus |
|
Durch Trennzeichen getrennte Liste der Leadfelder, die für jeden Datensatz zurückgegeben werden sollen.
|
fields | array |
Durch Trennzeichen getrennte Liste der Leadfelder, die für jeden Datensatz zurückgegeben werden sollen. Wenn nicht festgelegt e-Mails zurückgegeben werden, updatedAt, createdAt, lastName, firstName und id |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Ein Token wird von diesem Endpunkt zurückgegeben. Weitere Informationen finden Sie unter Paging Tokens.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
- Body
- ResponseOfLead
Leads nach Listen-ID abrufen
Ruft Personendatensätze ab, die Mitglieder der angegebenen statischen Liste sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der statischen Liste zum Abrufen von Datensätzen aus
|
listId | True | integer |
ID der statischen Liste zum Abrufen von Datensätzen aus |
|
Durch Trennzeichen getrennte Liste der Leadfelder, die für jeden Datensatz zurückgegeben werden sollen.
|
fields | array |
Durch Trennzeichen getrennte Liste der Leadfelder, die für jeden Datensatz zurückgegeben werden sollen. Wenn nicht festgelegt e-Mails zurückgegeben werden, updatedAt, createdAt, lastName, firstName und id |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Ein Token wird von diesem Endpunkt zurückgegeben. Weitere Informationen finden Sie unter Paging Tokens.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
Leads nach Programm-ID abrufen
Ruft eine Liste von Leads ab, die Mitglieder des angegebenen Programms sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID des abzurufenden Programms
|
programId | True | integer |
Die ID des abzurufenden Programms |
|
Eine durch Trennzeichen getrennte Liste von Feldern, die für jeden Datensatz zurückgegeben werden sollen
|
fields | array |
Eine durch Trennzeichen getrennte Liste von Feldern, die für jeden Datensatz zurückgegeben werden sollen |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Ein Token wird von diesem Endpunkt zurückgegeben. Weitere Informationen finden Sie unter Paging Tokens.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
- Body
- ResponseOfLead
Leads synchronisieren
Synchronisiert eine Liste von Leads mit der Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Handlung
|
action | string |
Typ des auszuführenden Synchronisierungsvorgangs. Standardmäßig wird "createOrUpdate" verwendet, wenn dies nicht festgelegt ist. |
|
|
asyncProcessing
|
asyncProcessing | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird der Anruf sofort zurückgegeben. |
|
|
id
|
id | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
|
acquiredBy
|
acquiredBy | boolean |
Ob der Lead vom Übergeordneten Programm erworben wurde |
|
|
isExhausted
|
isExhausted | boolean |
Gibt an, ob der Lead derzeit im Datenstrom erschöpft ist, falls zutreffend |
|
|
membershipDate
|
membershipDate | True | string |
Datum, an dem der Lead zuerst Mitglied des Programms wurde |
|
nurtureCadence
|
nurtureCadence | string |
Abweichung des übergeordneten Datenstroms, falls zutreffend |
|
|
progressionStatus
|
progressionStatus | True | string |
Programmstatus des Leads im übergeordneten Programm |
|
reachedSuccess
|
reachedSuccess | boolean |
Ob sich der Lead in einem Erfolgsstatus im übergeordneten Programm befindet |
|
|
Datenstrom
|
stream | string |
Stream, bei dem der Lead Mitglied ist, wenn das übergeordnete Programm ein Engagement-Programm ist |
|
|
Code
|
code | True | string |
Ganzzahliger Code des Grundes |
|
message
|
message | True | string |
Meldung, die den Grund für den Status des Vorgangs beschreibt |
|
status
|
status | string |
Status des Vorgangs, der für den Datensatz ausgeführt wurde |
|
|
LookupField
|
lookupField | string |
Feld, das dedupliziert werden soll. Das Feld muss in jedem Leaddatensatz der Eingabe vorhanden sein. Standardeinstellung für E-Mails, wenn dies nicht festgelegt ist |
|
|
partitionName
|
partitionName | string |
Name der Partition, die ausgeführt werden soll, falls zutreffend. Sollte bei der Interaktion mit einer Instanz festgelegt werden, in der Partitionen aktiviert sind. |
Gibt zurück
- Body
- ResponseOfLead
Liste nach ID abrufen
Gibt einen Listendatensatz anhand seiner ID zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der statischen Liste zum Abrufen von Datensätzen aus
|
listId | True | integer |
ID der statischen Liste zum Abrufen von Datensätzen aus |
Gibt zurück
- Body
- ResponseOfStaticList
Listen abrufen
Gibt einen Satz statischer Listendatensätze basierend auf bestimmten Filterparametern zurück. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Durch Trennzeichen getrennte Liste mit statischen Listen-IDs, die zurückgegeben werden sollen
|
id | array |
Durch Trennzeichen getrennte Liste mit statischen Listen-IDs, die zurückgegeben werden sollen |
|
|
Durch Trennzeichen getrennte Liste mit statischen Listennamen, die zurückgegeben werden sollen
|
name | array |
Durch Trennzeichen getrennte Liste mit statischen Listennamen, die zurückgegeben werden sollen |
|
|
Durch Trennzeichen getrennte Liste der Programmnamen.
|
programName | array |
Durch Trennzeichen getrennte Liste der Programmnamen. Wenn festgelegt wird, werden alle statischen Listen zurückgegeben, die untergeordnete Elemente der angegebenen Programme sind. |
|
|
Durch Trennzeichen getrennte Liste der Arbeitsbereichsnamen.
|
workspaceName | array |
Durch Trennzeichen getrennte Liste der Arbeitsbereichsnamen. Wenn festgelegt wird, werden alle statischen Listen zurückgegeben, die untergeordnete Elemente der angegebenen Arbeitsbereiche sind. |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Ein Token wird von diesem Endpunkt zurückgegeben. Weitere Informationen finden Sie unter Paging Tokens.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
- Body
- ResponseOfStaticList
Mitglied der Liste
Überprüft, ob Leads Mitglieder einer bestimmten statischen Liste sind. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der statischen Liste, auf die überprüft werden soll
|
listId | True | integer |
ID der statischen Liste, auf die überprüft werden soll |
|
id
|
id | True | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
Durch Trennzeichen getrennte Liste der zu überprüfenden Lead-IDs
|
id | array |
Durch Trennzeichen getrennte Liste der zu überprüfenden Lead-IDs |
Gibt zurück
Nicht genehmigtes Programm
Hebt die Genehmigung des Zielprogramms auf. Nur gültig für genehmigte E-Mail-Programme. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
Gibt zurück
- Body
- ResponseOfIdResponse
Ordner abrufen
Ruft untergeordnete Ordner aus einem bestimmten Stammordner ab. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Referenz zu übergeordneten Ordnern
|
root | string |
Referenz zu übergeordneten Ordnern |
|
|
Maximale Ordnertiefe zum Durchlaufen, Standard 2
|
maxDepth | integer |
Maximale Ordnertiefe zum Durchlaufen, Standard 2 |
|
|
Maximale Anzahl der zurückzugebenden Ordner. Standard 20, maximal 200
|
maxReturn | integer |
Maximale Anzahl der zurückzugebenden Ordner. Standard 20, maximal 200 |
|
|
Ganzzahliger Offset für paging. Standard 0
|
offset | integer |
Ganzzahliger Offset für paging. Standard 0 |
|
|
Name des Arbeitsbereichs
|
workSpace | string |
Name des Arbeitsbereichs |
Gibt zurück
Ordner erstellen
Erstellt einen neuen Ordner. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Beschreibung
|
description | string |
Beschreibung der Ressource |
|
|
name
|
name | True | string |
Name des Ordners |
|
id
|
id | True | integer |
ID des Ordners |
|
type
|
type | True | string |
Ordnertyp |
Gibt zurück
Ordner löschen
Löscht den angegebenen Ordner. Das Löschen schlägt fehl, wenn der Ordner Inhalte enthält. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des zu löschenden Ordners
|
id | True | integer |
ID des zu löschenden Ordners |
|
Ordnertyp
|
type | True | string |
type |
Gibt zurück
- Body
- ResponseOfIdResponse
Ordner nach ID abrufen
Gibt den Ordnerdatensatz mit der angegebenen ID zurück. Erforderliche Berechtigungen: Read-Only Assets, Read-Write Assets
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID des abzurufenden Ordners
|
id | True | integer |
ID des abzurufenden Ordners |
|
Der Typ des Ordners (Programm oder Ordner)
|
type | True | string |
Ordnertyp. "Ordner" oder "Programm" |
Gibt zurück
Ordner nach Name abrufen
Gibt einen Ordnerdatensatz für den angegebenen Namen zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der Name des Ordners
|
name | True | string |
Der Name des Ordners. Nicht anwendbar für Programme |
|
Der Typ des Ordners (Programm oder Ordner)
|
type | string |
Ordnertyp. "Ordner" oder "Programm" |
|
|
Der übergeordnete Ordnerverweis
|
root | string |
Referenz zu übergeordneten Ordnern |
|
|
Der Name des Arbeitsbereichs
|
workSpace | string |
Name des Arbeitsbereichs |
Gibt zurück
Ordnerinhalte abrufen
Gibt Datensätze für den Inhalt eines bestimmten Ordners zurück. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des abzurufenden Ordners
|
id | True | integer |
ID des abzurufenden Ordners |
|
Maximale Anzahl von Kanälen, die zurückgegeben werden sollen. Max 200, Standard 20
|
maxReturn | integer |
Maximale Anzahl von Kanälen, die zurückgegeben werden sollen. Max 200, Standard 20 |
|
|
Ganzzahliger Offset für Paging
|
offset | integer |
Ganzzahliger Offset für Paging |
|
|
Ordnertyp. 'Folder' oder 'Program'. Der Standardwert ist "Ordner"
|
type | True | string |
Ordnertyp. 'Folder' oder 'Program'. Der Standardwert ist "Ordner" |
Gibt zurück
Ordnermetadaten aktualisieren
Aktualisiert die Metadaten für einen bestimmten Ordner. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID des zu aktualisierenden Ordners
|
id | True | integer |
ID des zu aktualisierenden Ordners |
|
Beschreibung
|
description | string |
Beschreibung der Ressource |
|
|
isArchive
|
isArchive | boolean |
Gibt an, ob der Ordner archiviert wird. Durch Umschalten dieses Werts wird der Archivierungsstatus des Ordners geändert. |
|
|
name
|
name | string |
Name des Ordners |
|
|
type
|
type | True | string |
Ordnertyp. "Ordner" oder "Programm" |
Gibt zurück
Programm erstellen
Erstellt ein neues Programm. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kanal
|
channel | True | string |
Kanal des Programms |
|
kosten
|
cost | True | integer |
Höhe der Kosten |
|
Anmerkung
|
note | string |
Hinweise zu den Kosten |
|
|
startDate
|
startDate | True | date-time |
Startdatum der Kosten für den Zeitraum |
|
Beschreibung
|
description | string | ||
|
id
|
id | True | integer |
ID des Ordners |
|
type
|
type | True | string |
Ordnertyp |
|
name
|
name | True | string |
Name des Programms |
|
tagType
|
tagType | string |
Typ des Programmtags |
|
|
tag-Wert
|
tagValue | string |
Wert des Tags |
|
|
type
|
type | True | string |
Typ des Programms |
Gibt zurück
Programm genehmigen
Genehmigt das Zielprogramm. Nur gültig für nicht genehmigte E-Mail-Programme. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
Gibt zurück
- Body
- ResponseOfIdResponse
Programm löschen
Löscht das Zielprogramm. Das Programm darf keine Ressourcen enthalten, die außerhalb des Programms verwendet werden. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
Gibt zurück
- Body
- ResponseOfIdResponse
Programm nach ID abrufen
Ruft den Programmdatensatz für die angegebene ID ab. Erforderliche Berechtigungen: Read-Only Assets, Read-Write Assets
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
Gibt zurück
Programm nach Name abrufen
Ruft den Programmdatensatz für den angegebenen Namen ab. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name des Programms
|
name | True | string |
Name des Programms |
|
True festlegen, um Programmtags aufzufüllen
|
includeTags | boolean |
True festlegen, um Programmtags aufzufüllen |
|
|
Festlegen von "true", um Programmkosten aufzufüllen
|
includeCosts | boolean |
Festlegen von "true", um Programmkosten aufzufüllen |
Gibt zurück
Programme abrufen
Ruft die Liste der barrierefreien Programme aus der Zielinstanz ab. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Maximale Anzahl von Kanälen, die zurückgegeben werden sollen. Max 200, Standard 20
|
maxReturn | integer |
Maximale Anzahl von Kanälen, die zurückgegeben werden sollen. Max 200, Standard 20 |
|
|
Ganzzahliger Offset für Paging
|
offset | integer |
Ganzzahliger Offset für Paging |
|
|
Optionaler Filter. Erfordert filterValues
|
filterType | string |
Optionaler Filter. Erfordert filterValues |
|
|
Programme vor diesem Datum ausschließen. Siehe Beschreibung des Datetime-Feldtyps.
|
earliestUpdatedAt | string |
Programme vor diesem Datum ausschließen. Muss eine gültige ISO-8601-Zeichenfolge sein. Siehe Beschreibung des Datetime-Feldtyps . |
|
|
Programme nach diesem Datum ausschließen. Siehe Beschreibung des Datetime-Feldtyps.
|
latestUpdatedAt | string |
Programme nach diesem Datum ausschließen. Muss eine gültige ISO-8601-Zeichenfolge sein. Siehe Beschreibung des Datetime-Feldtyps . |
Gibt zurück
Programme nach Tag abrufen
Ruft eine Liste der Programme ab, die dem angegebenen Tagtyp und den angegebenen Tagwerten entsprechen. Erforderliche Berechtigungen: Read-Only Ressourcen, Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Typ des Programmtags
|
tagType | True | string |
Typ des Programmtags |
|
Wert des Tags
|
tagValue | True | string |
Wert des Tags |
|
Maximale Anzahl von Kanälen, die zurückgegeben werden sollen. Max 200, Standard 20
|
maxReturn | integer |
Maximale Anzahl von Kanälen, die zurückgegeben werden sollen. Max 200, Standard 20 |
|
|
Ganzzahliger Offset für Paging
|
offset | integer |
Ganzzahliger Offset für Paging |
Gibt zurück
Programmmetadaten aktualisieren
Aktualisiert die Metadaten des Zielprogramms. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
|
kosten
|
cost | True | integer |
Höhe der Kosten |
|
Anmerkung
|
note | string |
Hinweise zu den Kosten |
|
|
startDate
|
startDate | True | date-time |
Startdatum der Kosten für den Zeitraum |
|
costsDestructiveUpdate
|
costsDestructiveUpdate | boolean |
Legen Sie "true" fest, um vorhandene Kosten zu zerstören und durch die angegebenen Kosten zu ersetzen. |
|
|
Beschreibung
|
description | string |
Aktualisierte Beschreibung für das Programm |
|
|
Enddatum
|
endDate | string |
Enddatum des Programms. Anwendbar auf Ereignis-, E-Mail- und Webinartypprogramme |
|
|
name
|
name | string |
Name des Programms |
|
|
startDate
|
startDate | string |
Startdatum des Programms. Anwendbar auf Ereignis-, E-Mail- und Webinar-Typprogramme |
|
|
tagType
|
tagType | string |
Typ des Programmtags |
|
|
tag-Wert
|
tagValue | string |
Wert des Tags |
Gibt zurück
Programmmitglied beschreiben
Gibt Metadaten zu Programmmitgliedsobjekten in der Zielinstanz zurück, einschließlich einer Liste aller Felder, die für die Interaktion über die APIs verfügbar sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Hinweis: Dieser Endpunkt wurde abgelöst. Verwenden Sie stattdessen den Endpunkt "Programmmitglied beschreiben ".
Gibt zurück
Programmmitglied beschreiben
Gibt Metadaten zu Programmmitgliedsobjekten in der Zielinstanz zurück, einschließlich einer Liste aller Felder, die für die Interaktion über die APIs verfügbar sind. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Gibt zurück
Programmmitglieder abrufen
Gibt eine Liste von bis zu 300 Programmmitgliedern in einer Liste von Werten in einem bestimmten Feld zurück. Wenn Sie einen filterType angeben, der ein benutzerdefiniertes Feld ist, muss der Datentyp des benutzerdefinierten Felds entweder "string" oder "integer" sein. Wenn Sie einen anderen filterType als "leadId" angeben, können maximal 100.000 Programmmitgliedsdatensätze von der Anforderung verarbeitet werden. Erforderliche Berechtigungen: Read-Only Lead, Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID des Zielprogramms.
|
programId | True | integer |
Die ID des Zielprogramms. |
|
Das zu filternde Programmelementfeld.
|
filterType | True | string |
Das Programmmitgliedsfeld, nach dem gefiltert werden soll. Jedes benutzerdefinierte Feld (nur Zeichenfolgen- oder Ganzzahltypen), "updatedAt" oder ein durchsuchbares Feld. Durchsuchbare Felder können über den Endpunkt "Programm beschreiben" abgerufen werden. |
|
Eine durch Trennzeichen getrennte Liste von Werten, nach denen in den angegebenen Feldern gefiltert werden soll.
|
filterValues | True | array |
Eine durch Trennzeichen getrennte Liste von Werten, nach denen in den angegebenen Feldern gefiltert werden soll. |
|
Bei Verwendung von filterType=updatedAt, der Start des Datumsbereichsfilters
|
startAt | string |
Bei Verwendung von filterType=updatedAt wird der Start des Datumsbereichsfilters (ISO 8601-Format) |
|
|
Bei Verwendung von "filterType=updatedAt" wird der Datumsbereichsfilter am Ende des Datumsbereichs gefiltert.
|
endAt | string |
Bei Verwendung von filterType=updatedAt wird der Datumsbereichsfilter (ISO 8601-Format) |
|
|
Eine durch Trennzeichen getrennte Liste von Leadfeldern, die für jeden Datensatz zurückgegeben werden sollen.
|
fields | array |
Eine durch Trennzeichen getrennte Liste von Leadfeldern, die für jeden Datensatz zurückgegeben werden sollen. |
|
|
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300.
|
batchSize | integer |
Die zurückzugebende Batchgröße. Der Maximal- und Standardwert ist 300. |
|
|
Ein Token wird zurückgegeben, wenn das Resultset größer als die Batchgröße ist.
|
nextPageToken | string |
Ein Token wird von diesem Endpunkt zurückgegeben, wenn das Resultset größer als die Batchgröße ist und in einem nachfolgenden Aufruf über diesen Parameter übergeben werden kann. Weitere Informationen finden Sie unter Paging Tokens. |
Gibt zurück
Programmmitglieder löschen
Löschen einer Liste von Mitgliedern aus der Zielinstanz. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID des Zielprogramms.
|
programId | True | integer |
Die ID des Zielprogramms. |
|
leadId
|
leadId | True | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
Gibt zurück
Programmmitgliedsdaten synchronisieren
Ändert die Programmmitgliedsdaten einer Liste von Leads in einem Zielprogramm. Nur vorhandene Mitglieder des Programms können ihre Daten mit dieser API geändert haben. Erforderliche Berechtigungen: Read-Write Lead
Parameter
Gibt zurück
Programmmitgliedsfeld nach Name abrufen
Ruft Metadaten für ein einzelnes Programmmitgliedsfeld ab. Erforderliche Berechtigungen: Read-Write Schemastandardfeld, Read-Write benutzerdefiniertes Schemafeld
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Der API-Name des Programmmitgliedsfelds
|
fieldApiName | True | string |
Der API-Name des Programmmitgliedsfelds |
Gibt zurück
- Body
- ResponseOfLeadField
Programmtag aktualisieren
Programmtag aktualisieren. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
|
Typ des Programmtags
|
tagType | True | string |
Typ des Programmtags |
|
Wert des Programmtags
|
tagValue | True | string |
Wert des Programmtags |
Gibt zurück
- Body
- ResponseOfIdResponse
Programmtag löschen
Löschen Sie nicht erforderliches Programmtag. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Programm-ID
|
id | True | integer |
id |
|
Typ des Programmtags
|
tagType | True | string |
Typ des Programmtags |
Gibt zurück
- Body
- ResponseOfIdResponse
Push Lead zu Marketo
Upserts einen Lead und generiert einen Push-Lead zu Marketo-Aktivitäten. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
id
|
id | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
|
Code
|
code | True | string |
Ganzzahliger Code des Grundes |
|
message
|
message | True | string |
Meldung, die den Grund für den Status des Vorgangs beschreibt |
|
status
|
status | string |
Status des Vorgangs, der für den Datensatz ausgeführt wurde |
|
|
LookupField
|
lookupField | string | ||
|
partitionName
|
partitionName | string | ||
|
programName
|
programName | string | ||
|
programStatus
|
programStatus | string | ||
|
Grund
|
reason | string | ||
|
source
|
source | string |
Gibt zurück
Statische Liste erstellen
Erstellt eine neue statische Liste. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Beschreibung
|
description | string |
Beschreibung der statischen Liste |
|
|
name
|
name | True | string |
Name der statischen Liste |
|
id
|
id | True | integer |
ID des Ordners |
|
type
|
type | True | string |
Ordnertyp |
Gibt zurück
Statische Liste löschen
Löscht die festgelegte statische Liste. Erforderliche Berechtigungen: Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der zu löschenden statischen Liste
|
id | True | integer |
ID der zu löschenden statischen Liste |
Gibt zurück
- Body
- ResponseOfIdResponse
Statische Liste nach ID abrufen
Ruft einen statischen Listendatensatz anhand seiner ID ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der abzurufenden statischen Liste
|
id | True | integer |
ID der abzurufenden statischen Liste |
Gibt zurück
Statische Liste nach Name abrufen
Ruft einen statischen Listendatensatz anhand seines Namens ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name der abzurufenden statischen Liste
|
name | True | string |
Name der abzurufenden statischen Liste |
Gibt zurück
Statische Listen abrufen
Ruft eine Liste statischer Listeneinträge ab. Erforderliche Berechtigungen: Read-Asset oder Read-Write Ressource
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
JSON-Darstellung des übergeordneten Ordners
|
folder | string |
JSON-Darstellung des übergeordneten Ordners mit Mitgliedern "ID" und "Typ", die "Folder" oder "Program" sein können |
|
|
Ganzzahliger Offset für Paging
|
offset | integer |
Ganzzahliger Offset für Paging |
|
|
Maximale Anzahl statischer Listen, die zurückgegeben werden sollen. Max 200, Standard 20.
|
maxReturn | integer |
Maximale Anzahl statischer Listen, die zurückgegeben werden sollen. Max 200, Standard 20. |
|
|
Schließen Sie statische Listen vor diesem Datum aus. Siehe Beschreibung des Datetime-Feldtyps.
|
earliestUpdatedAt | string |
Schließen Sie statische Listen vor diesem Datum aus. Muss eine gültige ISO-8601-Zeichenfolge sein. Siehe Beschreibung des Datetime-Feldtyps . |
|
|
Schließen Sie statische Listen nach diesem Datum aus. Siehe Beschreibung des Datetime-Feldtyps.
|
latestUpdatedAt | string |
Schließen Sie statische Listen nach diesem Datum aus. Muss eine gültige ISO-8601-Zeichenfolge sein. Siehe Beschreibung des Datetime-Feldtyps . |
Gibt zurück
Statische Listenmetadaten aktualisieren
Aktualisiert die Metadaten eines statischen Listenobjekts. Erforderliche Berechtigungen: Read-Write Ressourcen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der zu aktualisierenden statischen Liste
|
id | True | integer |
ID der zu aktualisierenden statischen Liste |
|
Beschreibung
|
description | string |
Beschreibung der statischen Liste |
|
|
name
|
name | string |
Name der statischen Liste |
Gibt zurück
Status des Exportprogramms-Mitgliedsauftrags abrufen
Gibt den Status eines Exportauftrags zurück. Der Auftragsstatus ist 30 Tage nach Dem Erreichen des Status "Abgeschlossen" oder "Fehlgeschlagen" verfügbar. Erforderliche Berechtigungen: Read-Only Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID des Exportbatchauftrags.
|
exportId | True | string |
ID des Exportbatchauftrags. |
Gibt zurück
Status des Synchronisierungsprogrammmitglieds
Ändert den Status des Programmmitglieds einer Liste von Leads in einem Zielprogramm. Wenn Mitglied nicht Teil des Programms ist, wird das Mitglied dem Programm hinzugefügt. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Die ID des Zielprogramms.
|
programId | True | integer |
Die ID des Zielprogramms. |
|
statusName
|
statusName | True | string |
Programmmitgliedsstatus |
|
leadId
|
leadId | True | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
Gibt zurück
Zur Liste hinzufügen
Fügt einer statischen Zielliste eine bestimmte Gruppe von Personendatensätzen hinzu. Es gibt eine Beschränkung von 300 Lead-IDs pro Anforderung. Erforderliche Berechtigungen: Read-Write Lead
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
ID der Zielliste
|
listId | True | integer |
ID der Zielliste |
|
id
|
id | True | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
Durch Trennzeichen getrennte Liste der Lead-IDs, die der Liste hinzugefügt werden sollen
|
id | array |
Durch Trennzeichen getrennte Liste der Lead-IDs, die der Liste hinzugefügt werden sollen |
Gibt zurück
Definitionen
ResponseOfIdentity
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
access_token
|
access_token | string |
Das Token, das Sie mit nachfolgenden Aufrufen zur Authentifizierung bei der Zielinstanz übergeben. |
|
scope
|
scope | string |
Der besitzerbasierte API-Benutzer des benutzerdefinierten Diensts, der für die Authentifizierung verwendet wurde |
|
expires_in
|
expires_in | integer |
Verbleibende Lebensdauer des aktuellen Tokens in Sekunden |
|
token_type
|
token_type | string |
Die OAuth-Authentifizierungsmethode |
ResponseOfStaticList
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of StaticList |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
Blei
Leaddatensatz. Enthält immer die ID, kann aber je nach den in der Zielinstanz verfügbaren Feldern eine beliebige Anzahl anderer Felder enthalten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
Mitgliedschaft
|
membership | ProgramMembership | |
|
Grund
|
reason | Reason | |
|
status
|
status | string |
Status des Vorgangs, der für den Datensatz ausgeführt wurde |
LeadField
Leadfelddatensatz
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzeigename
|
displayName | string |
Anzeigename der Benutzeroberfläche des Felds |
|
name
|
name | string |
API-Name des Felds |
|
Beschreibung
|
description | string |
Beschreibung des Felds |
|
Datentyp
|
dataType | string |
Datentyp des Felds |
|
length
|
length | integer |
Maximale Länge des Felds. Gilt nur für Text, Zeichenfolge und Textbereich. |
|
isHidden
|
isHidden | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Feld ausgeblendet. |
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Feld als HTML in E-Mail codiert. |
|
isSensitive
|
isSensitive | boolean |
Bei Festlegung auf "true" wird das Feld als vertraulich markiert. |
|
isCustom
|
isCustom | boolean |
Wenn dieser Wert auf "true" festgelegt ist, ist das Feld benutzerdefiniert. |
|
isApiCreated
|
isApiCreated | boolean |
Bei Festlegung auf "true" wurde das Feld mithilfe der REST-API erstellt. |
LeadFieldStatus
Leadfeldaktualisierungsstatus
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
API-Name des Felds |
|
status
|
status | string |
Status des Vorgangs, der für den Datensatz ausgeführt wurde |
ListOperationOutputData
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
Begründungen
|
reasons | array of Reason |
Liste der Gründe, warum ein Vorgang nicht erfolgreich war. Gründe sind nur in API-Antworten vorhanden und sollten nicht übermittelt werden |
|
status
|
status | string |
Status des Vorgangs, der für den Datensatz ausgeführt wurde |
LeadAttribute
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Datentyp
|
dataType | string |
Datentyp des Felds |
|
Anzeigename
|
displayName | string |
Anzeigename der Benutzeroberfläche des Felds |
|
id
|
id | integer |
Eindeutige ganzzahlige ID des Felds |
|
length
|
length | integer |
Maximale Länge des Felds. Gilt nur für Text, Zeichenfolge und Textbereich. |
|
Ruhepause
|
rest | LeadMapAttribute | |
|
Seife
|
soap | LeadMapAttribute |
LeadAttribute2
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
"API-Lead" |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Liste der durchsuchbaren Felder |
|
fields
|
fields | array of LeadAttribute2Fields |
Beschreibung der durchsuchbaren Felder |
LeadAttribute2SearchableFields
Liste der durchsuchbaren Felder
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
string |
Durchsuchbares Feld |
LeadAttribute2Fields
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
REST-API-Name des Felds |
|
Anzeigename
|
displayName | string |
Anzeigename des Felds (Anzeigename) |
|
Datentyp
|
dataType | string |
Datentyp des Felds |
|
length
|
length | integer |
Länge des Felds |
|
updateable
|
updateable | boolean |
Ist feld aktualisierbar |
|
crmManaged
|
crmManaged | boolean |
Wird von CRM verwaltetes Feld |
LeadAttribute2Fields2
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
REST-API-Name des Felds |
|
Anzeigename
|
displayName | string |
Anzeigename des Felds (Anzeigename) |
|
Datentyp
|
dataType | string |
Datentyp des Felds |
|
length
|
length | integer |
Länge des Felds |
|
updateable
|
updateable | boolean |
Ist feld aktualisierbar |
|
crmManaged
|
crmManaged | boolean |
Wird von CRM verwaltetes Feld |
ProgramMemberAttribute
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
"API-Programmmitglied" |
|
fields
|
fields | array of LeadAttribute2Fields |
Beschreibung der durchsuchbaren Felder |
ProgramMemberAttribute2
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
"API-Programmmitglied" |
|
Beschreibung
|
description | string |
"API-Programmmitgliedszuordnung" |
|
ErstelltAm
|
createdAt | string |
Datum/ Uhrzeit der Erstellung |
|
updatedAt
|
updatedAt | string |
Datetime aktualisiert |
|
dedupeFields
|
dedupeFields | array of string |
Liste der Dedupe-Felder |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Liste der durchsuchbaren Felder |
|
fields
|
fields | array of LeadAttribute2Fields2 |
Beschreibung der durchsuchbaren Felder |
ResponseOfImportLeadResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ImportLeadResponse |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ImportProgramMemberResponse
Antwort mit Importstatusinformationen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
batchId
|
batchId | integer |
Eindeutige ganzzahlige ID des Importauftrags |
|
importId
|
importId | string |
Eindeutige ganzzahlige ID des Importauftrags |
|
status
|
status | string |
Status des Importauftrags |
ResponseOfImportProgramMemberResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ImportProgramMemberResponse |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfCampaign
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of Campaign |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfListOperationOutputData
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ListOperationOutputData |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
Kampagne
Datensatz einer Marketo Smart Campaign
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
active
|
active | boolean |
Gibt an, ob die Kampagne aktiv ist. Gilt nur für Triggerkampagnen |
|
ErstelltAm
|
createdAt | string |
Datum und Uhrzeit der Erstellung der Kampagne |
|
Beschreibung
|
description | string |
Beschreibung der intelligenten Kampagne |
|
id
|
id | integer |
Eindeutige ganzzahlige ID der Smart Campaign |
|
name
|
name | string |
Name der intelligenten Kampagne |
|
programId
|
programId | integer |
ID des übergeordneten Programms, falls zutreffend |
|
programName
|
programName | string |
Name des übergeordneten Programms, falls zutreffend |
|
type
|
type | string |
Typ der intelligenten Kampagne |
|
updatedAt
|
updatedAt | string |
Datum, zu dem die Kampagne zuletzt aktualisiert wurde |
|
Name des Arbeitsbereichs
|
workspaceName | string |
Name des übergeordneten Arbeitsbereichs, falls zutreffend |
ResponseOfLead
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of Lead |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfLeadByListId
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of Lead |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfLeadField
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of LeadField |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfUpdateLeadField
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of LeadFieldStatus |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfPushLeadToMarketo
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of Lead |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfLeadAttribute
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of LeadAttribute |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfLeadAttribute2
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of LeadAttribute2 |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfProgramMemberAttributes
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ProgramMemberAttribute |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfProgramMemberAttributes2
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ProgramMemberAttribute2 |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
Warnung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
code | integer |
Ganzzahliger Code der Warnung |
|
message
|
message | string |
Meldung zur Beschreibung der Warnung |
ResponseOfExportResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ExportResponse |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfExportResponseWithToken
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ExportResponse |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfProgramMember
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ProgramMember |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ProgramMember
Programmmitgliedsdatensatz. Enthält immer Lead-ID, kann aber je nach den in der Zielinstanz verfügbaren Feldern beliebig viele andere Felder enthalten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seq
|
seq | integer |
Ganze Zahl, die die Abfolge des Datensatzes als Antwort angibt. Dieser Wert wird mit der Reihenfolge der Datensätze korreliert, die in der Anforderungseingabe enthalten sind. Seq sollte nur Teil der Antworten sein und sollte nicht übermittelt werden. |
|
leadId
|
leadId | integer |
Eindeutige ganzzahlige ID eines Leaddatensatzes |
|
reachedSuccess
|
reachedSuccess | boolean |
Boolescher Wert, der angibt, ob das Programmmitglied Erfolgskriterien für das Programm erreicht hat |
|
programId
|
programId | integer |
Eindeutige ganzzahlige ID eines Programms |
|
acquiredBy
|
acquiredBy | boolean |
Boolescher Wert, der angibt, ob Programmmitglied durch das Programm erworben wurde |
|
membershipDate
|
membershipDate | string |
Datum, an dem der Lead zuerst Mitglied des Programms wurde |
ResponseOfProgramMemberStatus
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ProgramMemberStatusResponse |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfProgramMemberData
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ProgramMemberStatusResponse |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ResponseOfProgramMemberDelete
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error |
Array von Fehlern, die aufgetreten sind, wenn die Anforderung nicht erfolgreich war |
|
moreResult
|
moreResult | boolean |
Boolescher Wert, der angibt, ob weitere Ergebnisse auf nachfolgenden Seiten vorhanden sind |
|
nextPageToken
|
nextPageToken | string |
Auslagerungstoken, wenn das Resultset die zulässige Batchgröße überschritten hat |
|
requestId
|
requestId | string |
ID der gestellten Anforderung |
|
Ergebnis
|
result | array of ProgramMemberDeleteResponse |
Array von Ergebnissen für einzelne Datensätze im Vorgang kann leer sein |
|
Erfolgreich
|
success | boolean |
Ob die Anforderung erfolgreich war |
|
Warnungen
|
warnings | array of Warning |
Array von Warnungen, die für den Vorgang angegeben werden |
ImportLeadResponse
Antwort mit Importstatusinformationen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
batchId
|
batchId | integer |
Eindeutige ganzzahlige ID des Importbatches |
|
importId
|
importId | string | |
|
message
|
message | string | |
|
numOfLeadsProcessed
|
numOfLeadsProcessed | integer |
Anzahl der bisher verarbeiteten Zeilen |
|
numOfRowsFailed
|
numOfRowsFailed | integer |
Anzahl der bisher fehlgeschlagenen Zeilen |
|
numOfRowsWithWarning
|
numOfRowsWithWarning | integer |
Anzahl der Zeilen mit einer Warnung bisher |
|
status
|
status | string |
Status des Batches |
ProgramMembership
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
acquiredBy
|
acquiredBy | boolean |
Ob der Lead vom Übergeordneten Programm erworben wurde |
|
isExhausted
|
isExhausted | boolean |
Gibt an, ob der Lead derzeit im Datenstrom erschöpft ist, falls zutreffend |
|
membershipDate
|
membershipDate | string |
Datum, an dem der Lead zuerst Mitglied des Programms wurde |
|
nurtureCadence
|
nurtureCadence | string |
Abweichung des übergeordneten Datenstroms, falls zutreffend |
|
progressionStatus
|
progressionStatus | string |
Programmstatus des Leads im übergeordneten Programm |
|
reachedSuccess
|
reachedSuccess | boolean |
Ob sich der Lead in einem Erfolgsstatus im übergeordneten Programm befindet |
|
Datenstrom
|
stream | string |
Stream, bei dem der Lead Mitglied ist, wenn das übergeordnete Programm ein Engagement-Programm ist |
ExportResponse
Antwort mit Exportauftragsstatusinformationen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ErstelltAm
|
createdAt | date-time |
Datum, an dem die Exportanforderung erstellt wurde |
|
errorMsg
|
errorMsg | string |
Fehlermeldung im Fall des Status "Fehlgeschlagen" |
|
exportId
|
exportId | string |
Eindeutige ID des Exportauftrags |
|
Dateigröße
|
fileSize | integer |
Größe der exportierten Datei in Byte. Dies hat nur dann einen Wert, wenn der Status "Abgeschlossen" ist, andernfalls null |
|
fileChecksum
|
fileChecksum | string |
SHA-256-Hash der exportierten Datei. Dies hat nur dann einen Wert, wenn der Status "Abgeschlossen" ist, andernfalls null |
|
finishedAt
|
finishedAt | date-time |
Endzeit des Exportauftrags. Dieser Wert wird nur angezeigt, wenn der Status "Abgeschlossen" oder "Fehlgeschlagen" ist, andernfalls NULL |
|
format
|
format | string |
Format der Datei gemäß angabe in der Anforderung ("CSV", "TSV", "SSV") |
|
numberOfRecords
|
numberOfRecords | integer |
Anzahl der Datensätze in der Exportdatei. Dieser Wert ist nur dann vorhanden, wenn der Status "Abgeschlossen" ist, andernfalls null |
|
queuedAt
|
queuedAt | date-time |
Warteschlangenzeit des Exportauftrags. Dieser Wert hat den Wert, wenn der Status "In der Warteschlange" erreicht ist, bevor null |
|
startedAt
|
startedAt | date-time |
Startzeit des Exportauftrags. Dieser Wert hat den Wert, wenn der Status "Verarbeitung" erreicht ist, bevor dieser Nullwert ist. |
|
status
|
status | string |
Status des Exportauftrags ("Erstellt";"Warteschlange";"Verarbeitung";"Abgebrochen";"Abgeschlossen";"Fehlgeschlagen") |
Ursache
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
code | string |
Ganzzahliger Code des Grundes |
|
message
|
message | string |
Meldung, die den Grund für den Status des Vorgangs beschreibt |
LeadMapAttribute
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
Name des Attributs |
|
readOnly
|
readOnly | boolean |
Gibt an, ob das Attribut schreibgeschützt ist. |
Fehler
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
code | string |
Fehlercode des Fehlers. Eine vollständige Liste der Fehlercodes finden Sie hier |
|
message
|
message | string |
Meldung, die die Ursache des Fehlers beschreibt |
ProgramMemberStatusResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
status
|
status | string |
Status des Vorgangs, der für den Datensatz ausgeführt wurde |
|
Begründungen
|
reasons | array of Reason |
Liste der Gründe, warum ein Vorgang nicht erfolgreich war. Gründe sind nur in API-Antworten vorhanden und sollten nicht übermittelt werden |
|
leadId
|
leadId | integer |
ID des dem Programmmitglied zugeordneten Leads |
|
Seq
|
seq | integer |
Ganze Zahl, die die Abfolge des Datensatzes als Antwort angibt. Dieser Wert wird mit der Reihenfolge der Datensätze korreliert, die in der Anforderungseingabe enthalten sind. Seq sollte nur Teil der Antworten sein und sollte nicht übermittelt werden. |
ProgramMemberDeleteResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
status
|
status | string |
Status des Vorgangs, der für den Datensatz ausgeführt wurde |
|
Begründungen
|
reasons | array of Reason |
Liste der Gründe, warum ein Vorgang nicht erfolgreich war. Gründe sind nur in API-Antworten vorhanden und sollten nicht übermittelt werden |
|
leadId
|
leadId | integer |
ID des dem Programmmitglied zugeordneten Leads |
|
Seq
|
seq | integer |
Ganze Zahl, die die Abfolge des Datensatzes als Antwort angibt. Dieser Wert wird mit der Reihenfolge der Datensätze korreliert, die in der Anforderungseingabe enthalten sind. Seq sollte nur Teil der Antworten sein und sollte nicht übermittelt werden. |
StaticList
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ErstelltAm
|
createdAt | string |
Datum und Uhrzeit der Erstellung der Liste |
|
Beschreibung
|
description | string |
Beschreibung der statischen Liste |
|
id
|
id | integer |
Eindeutige ganzzahlige ID der statischen Liste |
|
name
|
name | string |
Name der statischen Liste |
|
programName
|
programName | string |
Name des Programms |
|
updatedAt
|
updatedAt | string |
Datum, zu dem die Liste zuletzt aktualisiert wurde |
|
Name des Arbeitsbereichs
|
workspaceName | string |
Name des übergeordneten Arbeitsbereichs, falls zutreffend |
BrowseAllPrograms
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kanal
|
channel | string |
Kanal des Programms |
|
ErstelltAm
|
createdAt | date-time |
Datum und Uhrzeit der Erstellung der Ressource |
|
Beschreibung
|
description | string |
Beschreibung der Ressource |
|
Ordner
|
folder | Folder |
JSON-Darstellung eines Ordners |
|
id
|
id | integer |
ID der Ressource |
|
name
|
name | string |
Name der Ressource |
|
sfdcId
|
sfdcId | string |
SFDC-ID des Programms, wenn mit einer SFDC-Kampagne verknüpft ist |
|
sfdcName
|
sfdcName | string |
Name der verknüpften SFDC-Kampagne, falls zutreffend |
|
status
|
status | string |
Status des Programms. Nur gültig für E-Mail- und Engagement-Programmtypen. |
|
type
|
type | string |
Typ des Programms |
|
updatedAt
|
updatedAt | date-time |
Datum und Uhrzeit der letzten Aktualisierung der Ressource |
|
URL
|
url | string |
URL der Ressource in der Marketo-Benutzeroberfläche |
|
Arbeitsbereich
|
workspace | string |
Name des Arbeitsbereichs |
FolderContentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
type
|
type | string |
FileFolder
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer | |
|
name
|
name | string | |
|
type
|
type | string |
ResponseOfProgramResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of ProgramResponse | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
ResponseOfSmartListResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of SmartListResponse | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
ResponseOfSmartListResponseWithRules
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of SmartListResponseWithRules | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
SmartListResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
ID der Intelligenten Liste |
|
name
|
name | string |
Name der intelligenten Liste |
|
Beschreibung
|
description | string |
Beschreibung der intelligenten Liste |
|
ErstelltAm
|
createdAt | date-time |
Datum und Uhrzeit der Erstellung der intelligenten Liste |
|
updatedAt
|
updatedAt | date-time |
Datum und Uhrzeit der letzten Aktualisierung der intelligenten Liste |
|
URL
|
url | string |
URL der intelligenten Liste in der Marketo-Benutzeroberfläche |
|
Ordner
|
folder | Folder |
JSON-Darstellung eines Ordners |
|
Arbeitsbereich
|
workspace | string |
Name des Arbeitsbereichs |
SmartListResponseWithRules
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
ID der Intelligenten Liste |
|
name
|
name | string |
Name der intelligenten Liste |
|
Beschreibung
|
description | string |
Beschreibung der intelligenten Liste |
|
ErstelltAm
|
createdAt | date-time |
Datum und Uhrzeit der Erstellung der intelligenten Liste |
|
updatedAt
|
updatedAt | date-time |
Datum und Uhrzeit der letzten Aktualisierung der intelligenten Liste |
|
URL
|
url | string |
URL der intelligenten Liste in der Marketo-Benutzeroberfläche |
|
Ordner
|
folder | Folder |
JSON-Darstellung eines Ordners |
|
Arbeitsbereich
|
workspace | string |
Name des Arbeitsbereichs |
|
Regeln
|
rules | SmartListRules |
JSON-Darstellung intelligenter Listenregeln |
ResponseOfStaticListResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of StaticListResponse | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
StaticListResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
ID der statischen Liste |
|
name
|
name | string |
Name der statischen Liste |
|
Beschreibung
|
description | string |
Beschreibung der statischen Liste |
|
ErstelltAm
|
createdAt | date-time |
Datum und Uhrzeit der Erstellung der statischen Liste |
|
updatedAt
|
updatedAt | date-time |
Datum und Uhrzeit der letzten Aktualisierung der statischen Liste |
|
URL
|
url | string |
URL der statischen Liste in der Marketo-Benutzeroberfläche |
|
Ordner
|
folder | Folder |
JSON-Darstellung eines Ordners |
|
Arbeitsbereich
|
workspace | string |
Name des Arbeitsbereichs |
|
computedUrl
|
computedUrl | string |
ProgramResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Kanal
|
channel | string |
Kanal des Programms |
|
costs
|
costs | array of Costs |
Listen der zugehörigen Periodenkosten |
|
ErstelltAm
|
createdAt | date-time |
Datum und Uhrzeit der Erstellung der Ressource |
|
Beschreibung
|
description | string |
Beschreibung der Ressource |
|
Enddatum
|
endDate | date-time |
Enddatum des Programms. Anwendbar auf Ereignis-, E-Mail- und Webinartypprogramme |
|
Ordner
|
folder | ProgramFolder | |
|
id
|
id | integer |
ID der Ressource |
|
name
|
name | string |
Name der Ressource |
|
sfdcId
|
sfdcId | string |
SFDC-ID des Programms, wenn mit einer SFDC-Kampagne verknüpft ist |
|
sfdcName
|
sfdcName | string |
Name der verknüpften SFDC-Kampagne, falls zutreffend |
|
startDate
|
startDate | date-time |
Startdatum des Programms. Anwendbar auf Ereignis-, E-Mail- und Webinar-Typprogramme |
|
status
|
status | string |
Status des Programms. Nur gültig für E-Mail- und Engagement-Programmtypen. |
|
tags
|
tags | array of Tags |
Liste der zugehörigen Programmtags |
|
type
|
type | string |
Typ des Programms |
|
updatedAt
|
updatedAt | date-time |
Datum und Uhrzeit der letzten Aktualisierung der Ressource |
|
URL
|
url | string |
URL der Ressource in der Marketo-Benutzeroberfläche |
|
Arbeitsbereich
|
workspace | string |
Name des Arbeitsbereichs |
|
marketingProgramProgressionId
|
marketingProgramProgressionId | integer | |
|
headStart
|
headStart | boolean |
Gibt an, ob die Funktion "Head Start" für das Programm aktiviert ist. |
FileResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ErstelltAm
|
createdAt | date-time |
Datum und Uhrzeit der Erstellung der Datei |
|
Beschreibung
|
description | string |
Beschreibung der Datei |
|
Ordner
|
folder | FileFolder | |
|
id
|
id | integer |
ID der Datei |
|
mimeType
|
mimeType | string |
MIME-Typ der Datei |
|
name
|
name | string |
Name der Datei |
|
size
|
size | integer |
Größe der Datei in Byte |
|
updatedAt
|
updatedAt | date-time |
Datum/ Uhrzeit, zu der die Datei zuletzt aktualisiert wurde |
|
URL
|
url | string |
Öffentlich zugängliche URL der Datei |
ResponseOfFileResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of FileResponse | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
FolderResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
accessZoneId
|
accessZoneId | integer | |
|
ErstelltAm
|
createdAt | date-time |
Datum und Uhrzeit der Erstellung des Ordners |
|
Beschreibung
|
description | string |
Beschreibung des Ordners |
|
folderId
|
folderId | Folder |
JSON-Darstellung eines Ordners |
|
folderType
|
folderType | string |
Ordnertyp |
|
id
|
id | integer |
ID des Ordners |
|
isArchive
|
isArchive | boolean |
Archivierungsstatus des Ordners |
|
isSystem
|
isSystem | boolean |
Gibt an, ob der Ordner vom System verwaltet wird. |
|
name
|
name | string |
Der Name des Ordners. Nicht anwendbar für Programme |
|
parent
|
parent | Folder |
JSON-Darstellung eines Ordners |
|
Pfad
|
path | string |
Pfad des Ordners |
|
updatedAt
|
updatedAt | date-time |
Datum und Uhrzeit der letzten Aktualisierung des Ordners |
|
URL
|
url | string |
URL des Ordners |
|
Arbeitsbereich
|
workspace | string |
Name des Arbeitsbereichs |
ResponseOfIdResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of IdResponse | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
Stichwörter
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
tagType
|
tagType | string |
Name des Tags |
|
tag-Wert
|
tagValue | string |
Wert des Tags |
ResponseOfBrowseAllPrograms
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of BrowseAllPrograms | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
ResponseOfFolderResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of FolderResponse | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
ResponseOfFolderContentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Irrtümer
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
Ergebnis
|
result | array of FolderContentResponse | |
|
Erfolgreich
|
success | boolean | |
|
Warnungen
|
warnings | array of string |
IdResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
ID der Ressource |
Kosten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
kosten
|
cost | integer |
Höhe der Kosten |
|
Anmerkung
|
note | string |
Hinweise zu den Kosten |
|
startDate
|
startDate | date-time |
Startdatum der Kosten für den Zeitraum |
ProgramFolder
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
type
|
type | string |
Der Typ des Programmordners |
|
value
|
value | integer |
Die ID des Programmordners |
|
folderName
|
folderName | string |
Der Name des Programmordners |
Ordner
JSON-Darstellung eines Ordners
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
ID des Ordners |
|
type
|
type | string |
Ordnertyp |
SmartListRules
JSON-Darstellung intelligenter Listenregeln
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
filterMatchType
|
filterMatchType | string |
Intelligente Listenfilter-Übereinstimmungstyp (Regellogik) |
|
Trigger
|
triggers | array of string |
Liste der Smart List-Trigger |
|
filters
|
filters | array of SmartListFilters |
Liste der intelligenten Listenfilter |
SmartListFilters
JSON-Darstellung intelligenter Listenfilter
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
ID des Filters |
|
name
|
name | string |
Name des Filters |
|
ruleTypeId
|
ruleTypeId | integer |
ID des Regeltyps |
|
ruleType
|
ruleType | string |
Name des Regeltyps |
|
operator
|
operator | string |
Name des Operators |
|
Bedingungen
|
conditions | array of SmartListConditions |
Liste der Intelligenten Listenbedingungen |
SmartListConditions
JSON-Darstellung intelligenter Listenbedingungen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
activityAttributeId
|
activityAttributeId | integer |
ID des Aktivitätsattributs |
|
activityAttributeName
|
activityAttributeName | string |
Name des Aktivitätsattributs |
|
operator
|
operator | string |
Wert des Operators |
|
values
|
values | array of string |
Liste der Werte |
|
isPrimär
|
isPrimary | boolean |
Gibt an, ob die Bedingung primär ist oder nicht (erste Bedingung der smarten Liste) |
Objekt
Dies ist der Typ „Objekt“.