Marketo MA (deprecato) [DEPRECATO]
Marketo Marketing Automation. Questa API consente l'accesso a oggetti Marketo, ad esempio Campagne, Programmi, Lead, Elenchi (statici e intelligenti), nonché asset del file system, ad esempio file e cartelle.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Normale | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Normale | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Normale | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Marketo Developer Relations |
| URL | http://developers.marketo.com |
| developerfeedback@marketo.com |
| Metadati del connettore | |
|---|---|
| Editore | Microsoft Inc. |
| Sito web | https://www.marketo.com/ |
| Informativa sulla privacy | https://documents.marketo.com/legal/privacy/ |
| Condizioni per l'utilizzo del servizio | https://go.microsoft.com/fwlink/?linkid=2237005 |
| Categorie | Marketing; Vendite e CRM |
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| Predefinita | Parametri per la creazione della connessione. | Tutte le aree geografiche | Non condivisibile |
Predefinito
Applicabile: tutte le aree
Parametri per la creazione della connessione.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| MunchkinID | corda | Marketo MunchkinID (vedere la pagina Admin) | Vero |
| ID cliente | corda | ID cliente | Vero |
| Segreto del cliente | securestring | Segreto del cliente | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiorna campo lead (deprecato) [DEPRECATO] |
Aggiornare i metadati per un campo lead nell'istanza di destinazione. (deprecato) Vedere le regole di aggiornamento qui. Autorizzazioni necessarie: campo standard dello schema Read-Write Read-Write campo personalizzato schema |
| Aggiornare i metadati del programma (deprecati) [DEPRECATO] |
Aggiorna i metadati del programma di destinazione. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Aggiornare i metadati dell'elenco statico (deprecato) [DEPRECATO] |
Aggiorna i metadati di un asset elenco statico. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Aggiornare i metadati delle cartelle (deprecati) [DEPRECATO] |
Aggiorna i metadati per una determinata cartella. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Aggiornare il contenuto del file (deprecato) [DEPRECATO] |
Sostituisce il contenuto corrente del file con il payload incluso. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Aggiungi all'elenco (deprecato) [DEPRECATO] |
Aggiunge un determinato set di record di persone a un elenco statico di destinazione. (deprecato) Esiste un limite di 300 ID lead per ogni richiesta. Autorizzazioni necessarie: Read-Write lead |
| Annulla processo lead di esportazione (deprecato) [DEPRECATO] |
Annullare il processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato) |
| Annulla processo membro programma di esportazione (deprecato) [DEPRECATO] |
Annullare il processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato) |
| Approva programma (deprecato) [DEPRECATO] |
Approva il programma di destinazione. Valido solo per i programmi di posta elettronica non approvati. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Campagna di richiesta (deprecata) [DEPRECATO] |
Passa un set di lead a una campagna trigger da eseguire attraverso il flusso della campagna. (deprecato) La campagna designata deve avere una campagna è richiesta: trigger API del servizio Web e deve essere attiva. I token locali del programma padre della campagna possono essere sottoposti a override per l'esecuzione per personalizzare il contenuto. Per ogni chiamata sono consentiti un massimo di 100 lead. Autorizzazioni necessarie: Esegui campagna |
| Clonare smart list (deprecato) [DEPRECATO] |
Clona l'elenco intelligente designato. Autorizzazioni necessarie: asset Read-Write (deprecato) |
| Crea cartella (deprecata) [DEPRECATO] |
Crea una nuova cartella. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Crea elenco statico (deprecato) [DEPRECATO] |
Crea un nuovo elenco statico. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Crea file (deprecato) [DEPRECATO] |
Crea un nuovo file dal payload incluso. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Crea processo membro programma di esportazione (deprecato) [DEPRECATO] |
Creare un processo di esportazione per i criteri di ricerca definiti tramite il parametro "filter". Request restituisce l'elemento "exportId" passato come parametro nelle chiamate successive agli endpoint membri del programma di esportazione bulk. (deprecated) |
| Crea programma (deprecato) [DEPRECATO] |
Crea un nuovo programma. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Creare un processo lead di esportazione (deprecato) [DEPRECATO] |
Creare un processo di esportazione per i criteri di ricerca definiti tramite il parametro "filter". Request restituisce l'elemento "exportId" passato come parametro nelle chiamate successive agli endpoint lead di esportazione bulk. Usare l'endpoint processo di esportazione accodamento per accodare il processo di esportazione per l'elaborazione. Usare l'endpoint Get Export Lead Job Status per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato) |
| Describe Program Member (deprecato) [DEPRECATO] |
Restituisce i metadati sugli oggetti membro del programma nell'istanza di destinazione, incluso un elenco di tutti i campi disponibili per l'interazione tramite le API. Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Describe Program Member (deprecato) [DEPRECATO] |
Restituisce i metadati sugli oggetti membro del programma nell'istanza di destinazione, incluso un elenco di tutti i campi disponibili per l'interazione tramite le API. Autorizzazioni necessarie: Read-Only lead, Read-Write lead (deprecato) |
| Descrivere il lead (deprecato) [DEPRECATO] |
Restituisce i metadati relativi agli oggetti lead nell'istanza di destinazione, incluso un elenco di tutti i campi disponibili per l'interazione tramite le API. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Descrivere Lead2 (deprecato) [DEPRECATO] |
Restituisce un elenco di campi ricercabili sugli oggetti lead nell'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Elimina cartella (deprecata) [DEPRECATO] |
Elimina la cartella designata. L'eliminazione avrà esito negativo se la cartella contiene contenuto. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Elimina elenco intelligente (deprecato) [DEPRECATO] |
Elimina l'elenco intelligente designato. Autorizzazioni necessarie: asset Read-Write (deprecato) |
| Elimina elenco statico (deprecato) [DEPRECATO] |
Elimina l'elenco statico designato. Autorizzazioni necessarie: asset Read-Write (deprecato) |
| Elimina lead (deprecati) [DEPRECATO] |
Eliminare un elenco di lead dall'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Elimina membri del programma (deprecati) [DEPRECATO] |
Eliminare un elenco di membri dall'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Elimina programma (deprecato) [DEPRECATO] |
Elimina il programma di destinazione. Il programma non può contenere asset in uso all'esterno del programma. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Elimina tag programma (deprecato) [DEPRECATO] |
Eliminare il tag di programma non obbligatorio. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Get Campaign By Id (deprecato) [DEPRECATO] |
Restituisce il record di una campagna in base al relativo ID. (deprecato) Autorizzazioni necessarie: campagne Read-Only, campagne Read-Write |
| Get Campaigns (deprecato) [DEPRECATO] |
Restituisce un elenco di record delle campagne. (deprecato) Autorizzazioni necessarie: campagne di Read-Only, campagne Read-Write |
| Get Export Lead File (deprecato) [DEPRECATO] |
Restituisce il contenuto del file di un processo di esportazione. (deprecato) Il processo di esportazione deve essere nello stato "Completato". Usare l'endpoint Get Export Lead Job Status per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead |
| Get Export Lead Job Status (deprecato) [DEPRECATO] |
Restituisce lo stato di un processo di esportazione. (deprecato) Lo stato del processo è disponibile per 30 giorni dopo il raggiungimento dello stato Completato o Non riuscito. Autorizzazioni necessarie: Read-Only lead |
| Get Export Lead Jobs (deprecato) [DEPRECATO] |
Restituisce un elenco di processi di esportazione creati negli ultimi 7 giorni. Autorizzazioni necessarie: Read-Only lead (deprecato) |
| Get Export Program Member File (deprecato) [DEPRECATO] |
Restituisce il contenuto del file di un processo di esportazione. (deprecato) Il processo di esportazione deve essere nello stato "Completato". Usare l'endpoint Get Export Program Job Status (Ottieni stato processo membro programma di esportazione) per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead |
| Get Export Program Member Job Status (deprecato) [DEPRECATO] |
Restituisce lo stato di un processo di esportazione. Lo stato del processo è disponibile per 30 giorni dopo il raggiungimento dello stato Completato o Non riuscito. Autorizzazioni necessarie: Read-Only lead (deprecato) |
| Get Export Program Member Jobs (deprecato) [DEPRECATO] |
Restituisce un elenco di processi di esportazione creati negli ultimi 7 giorni. Autorizzazioni necessarie: Read-Only lead (deprecato) |
| Get Folder by Name (deprecato) [DEPRECATO] |
Restituisce un record di cartella per il nome specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Get Folders (deprecato) [DEPRECATO] |
Recupera le cartelle figlio dall'interno di una determinata cartella radice. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Get Import Lead Warnings (deprecato) [DEPRECATO] |
Restituisce l'elenco di avvisi per il processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato) |
| Get Import Program Member Failures (deprecato) [DEPRECATO] |
Restituisce l'elenco degli errori per il processo batch di importazione. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Get Import Program Member Status (deprecato) [DEPRECATO] |
Restituisce lo stato di un processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato) |
| Get Import Program Member Warnings (deprecato) [DEPRECATO] |
Restituisce l'elenco di avvisi per il processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato) |
| Get Lead Field by Name (deprecato) [DEPRECATO] |
Recupera i metadati per un singolo campo lead. (deprecato) Autorizzazioni necessarie: campo standard dello schema Read-Write Read-Write campo personalizzato schema |
| Get Lists (deprecato) [DEPRECATO] |
Restituisce un set di record elenco statici in base ai parametri di filtro specificati. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Get Program by Id (deprecato) [DEPRECATO] |
Recupera il record del programma per l'ID specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecato) |
| Get Program by Name (deprecato) [DEPRECATO] |
Recupera il record del programma per il nome specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Get Program Member Field by Name (deprecato) [DEPRECATO] |
Recupera i metadati per il singolo campo membro del programma. (deprecato) Autorizzazioni necessarie: campo standard dello schema Read-Write Read-Write campo personalizzato schema |
| Get Program Members (deprecato) [DEPRECATO] |
Restituisce un elenco di un massimo di 300 membri del programma in un elenco di valori in un determinato campo. Se si specifica un filterType che è un campo personalizzato, il tipo di dati del campo personalizzato deve essere "string" o "integer". Se si specifica un filterType diverso da "leadId", è possibile elaborare dalla richiesta un massimo di 100.000 record membro del programma. Autorizzazioni necessarie: Read-Only lead, Read-Write lead (deprecato) |
| Get Programs (deprecato) [DEPRECATO] |
Recupera l'elenco di programmi accessibili dall'istanza di destinazione. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Get Static Lists (deprecato) [DEPRECATO] |
Recupera un elenco di record elenco statici. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato) |
| Identità (deprecata) [DEPRECATO] |
Recuperare un token di accesso da Marketo. Le chiamate a questo endpoint non vengono conteggiate per il limite di chiamate API (deprecato). |
| Identità (deprecata) [DEPRECATO] |
Recuperare un token di accesso da Marketo. Le chiamate a questo endpoint non vengono conteggiate per il limite di chiamate API (deprecato). |
| Importare i membri del programma (deprecato) [DEPRECATO] |
Importa un file contenente record di dati nell'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Lead di importazione (deprecati) [DEPRECATO] |
Importa un file contenente record di dati nell'istanza di destinazione. Autorizzazioni necessarie: Read-Write lead (deprecato) |
| Lead di sincronizzazione (deprecati) [DEPRECATO] |
Sincronizza un elenco di lead nell'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Membro dell'elenco (deprecato) [DEPRECATO] |
Controlla se i lead sono membri di un determinato elenco statico. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Ottenere elenchi intelligenti (deprecati) [DEPRECATO] |
Recupera un elenco di record smart list creati dall'utente. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato) |
| Ottenere gli errori dei lead di importazione (deprecato) [DEPRECATO] |
Restituisce l'elenco degli errori per il processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato) |
| Ottenere l'elenco intelligente per nome (deprecato) [DEPRECATO] |
Recupera un record Smart List in base al nome. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato) |
| Ottenere l'elenco per ID (deprecato) [DEPRECATO] |
Restituisce un record di elenco in base al relativo ID. (deprecato) Autorizzazioni necessarie: Read-Only lead, Read-Write lead |
| Ottenere l'elenco statico per ID (deprecato) [DEPRECATO] |
Recupera un record elenco statico in base al relativo ID. Autorizzazioni necessarie: Read-Asset o Read-Write asset (deprecato) |
| Ottenere l'elenco statico per nome (deprecato) [DEPRECATO] |
Recupera un record elenco statico in base al nome. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato) |
| Ottenere lead per ID (deprecato) [DEPRECATO] |
Recupera un singolo record lead tramite l'ID Marketo. (deprecato) Autorizzazioni necessarie: Read-Only Lead, Read-Write Lead |
| Ottenere lead per ID elenco (deprecato) [DEPRECATO] |
Recupera i record delle persone che sono membri dell'elenco statico specificato. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Ottenere lead per ID elenco (deprecato) [DEPRECATO] |
Recupera i record delle persone che sono membri dell'elenco statico specificato. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Ottenere lead per ID programma (deprecato) [DEPRECATO] |
Recupera un elenco di lead che sono membri del programma designato. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Ottenere lead per tipo di filtro (deprecato) [DEPRECATO] |
Restituisce un elenco di un massimo di 300 lead in base a un elenco di valori in un determinato campo. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead |
| Ottenere lo stato del lead di importazione (deprecato) [DEPRECATO] |
Restituisce lo stato di un processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato) |
| Ottenere programmi per tag (deprecato) [DEPRECATO] |
Recupera un elenco di programmi corrispondenti al tipo di tag e ai valori di tag specificati. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Ottenere smart list per ID (deprecato) [DEPRECATO] |
Recupera un record smart list in base al relativo ID. Autorizzazioni necessarie: Read-Asset o asset di Read-Write (deprecato) |
| Ottenere smart list per ID programma (deprecato) [DEPRECATO] |
Recupera un record smart list in base all'ID programma di posta elettronica. Autorizzazioni necessarie: Read-Asset o Read-Write Asset (deprecato) |
| Pianificazione campagna (deprecata) [DEPRECATO] |
Pianifica in remoto l'esecuzione di una campagna batch in un determinato momento. (deprecato) I token locali del programma padre della campagna possono essere sottoposti a override per l'esecuzione per personalizzare il contenuto. Quando si usa il parametro "cloneToProgramName" descritto di seguito, questo endpoint è limitato a 20 chiamate al giorno. Autorizzazioni necessarie: Esegui campagna |
| Processo lead di esportazione accodamento (deprecato) [DEPRECATO] |
Processo di esportazione accodamento. In questo modo verrà inserito il processo di esportazione in coda e verrà avviato quando le risorse di calcolo diventano disponibili. Il processo di esportazione deve essere in stato "Creato". Usare l'endpoint Get Export Lead Job Status per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato) |
| Processo membro del programma di esportazione accodamento (deprecato) [DEPRECATO] |
Processo di esportazione accodamento. In questo modo verrà inserito il processo di esportazione in coda e verrà avviato quando le risorse di calcolo diventano disponibili. Il processo di esportazione deve essere in stato "Creato". (deprecated) |
| Programma clone (deprecato) [DEPRECATO] |
Clona il programma di destinazione. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Programma non approvato (deprecato) [DEPRECATO] |
Annulla l'applicazione del programma di destinazione. Valido solo per i programmi di posta elettronica approvati. Autorizzazioni necessarie: Read-Write asset (deprecato) |
| Push Lead to Marketo (deprecato) [DEPRECATO] |
Upserts un lead e genera un'attività Push Lead to Marketo. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Recupera cartella per ID (deprecato) [DEPRECATO] |
Restituisce il record della cartella con l'ID specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecato) |
| Recupera contenuto cartella (deprecato) [DEPRECATO] |
Restituisce i record per il contenuto di una determinata cartella. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Recupera file (deprecato) [DEPRECATO] |
Restituisce i file dalla cartella specificata. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Recupera file per ID (deprecato) [DEPRECATO] |
Restituisce il record di file per l'ID specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecato) |
| Recupera file per nome (deprecato) [DEPRECATO] |
Restituisce i record di file per il nome specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati) |
| Rimuovi da elenco (deprecato) [DEPRECATO] |
Rimuove un determinato set di record di persone da un elenco statico di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead |
| Sincronizzare i dati dei membri del programma (deprecato) [DEPRECATO] |
Modifica i dati dei membri del programma di un elenco di lead in un programma di destinazione. (deprecato) Solo i membri esistenti del programma possono cambiare i dati con questa API. Autorizzazioni necessarie: Read-Write lead |
| Stato membro del programma di sincronizzazione (deprecato) [DEPRECATO] |
Modifica lo stato del membro del programma di un elenco di lead in un programma di destinazione. (deprecato) Se il membro non fa parte del programma, il membro viene aggiunto al programma. Autorizzazioni necessarie: Read-Write lead |
| Update Program Tag (deprecato) [DEPRECATO] |
Aggiornare il tag del programma. Autorizzazioni necessarie: Read-Write asset (deprecato) |
Aggiorna campo lead (deprecato) [DEPRECATO]
Aggiornare i metadati per un campo lead nell'istanza di destinazione. (deprecato) Vedere le regole di aggiornamento qui. Autorizzazioni necessarie: campo standard dello schema Read-Write Read-Write campo personalizzato schema
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome API del campo lead
|
fieldApiName | True | string |
Nome API del campo lead |
|
nome visualizzato
|
displayName | string |
Nome visualizzato dell'interfaccia utente del campo |
|
|
descrizione
|
description | string |
Descrizione del campo |
|
|
isHidden
|
isHidden | boolean |
Se è impostato su true, il campo è nascosto. Il valore predefinito è false. |
|
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Se impostato su true, il campo viene codificato come HTML nel messaggio di posta elettronica. Il valore predefinito è true |
|
|
isSensitive
|
isSensitive | boolean |
Se impostato su true, il campo viene contrassegnato come sensibile. Il valore predefinito è false. |
Valori restituiti
Aggiornare i metadati del programma (deprecati) [DEPRECATO]
Aggiorna i metadati del programma di destinazione. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
|
costo
|
cost | True | integer |
Importo del costo |
|
nota
|
note | string |
Note sul costo |
|
|
startDate
|
startDate | True | date-time |
Data di inizio del costo del periodo |
|
costsDestructiveUpdate
|
costsDestructiveUpdate | boolean |
Impostare true per eliminare i costi esistenti e sostituirli con i costi specificati |
|
|
descrizione
|
description | string |
Descrizione aggiornata per il programma |
|
|
Data di fine
|
endDate | string |
Data di fine del programma. Applicabile ai programmi di tipo evento, posta elettronica e webinar |
|
|
nome
|
name | string |
Nome del programma |
|
|
startDate
|
startDate | string |
Data di inizio del programma. Applicabile ai programmi di tipo evento, posta elettronica e webinar |
|
|
tagType
|
tagType | string |
Tipo di tag di programma |
|
|
tagValue
|
tagValue | string |
Valore del tag |
Valori restituiti
Aggiornare i metadati dell'elenco statico (deprecato) [DEPRECATO]
Aggiorna i metadati di un asset elenco statico. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da aggiornare
|
id | True | integer |
ID dell'elenco statico da aggiornare |
|
descrizione
|
description | string |
Descrizione dell'elenco statico |
|
|
nome
|
name | string |
Nome dell'elenco statico |
Valori restituiti
Aggiornare i metadati delle cartelle (deprecati) [DEPRECATO]
Aggiorna i metadati per una determinata cartella. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID della cartella da aggiornare
|
id | True | integer |
ID della cartella da aggiornare |
|
descrizione
|
description | string |
Descrizione dell'asset |
|
|
isArchive
|
isArchive | boolean |
Indica se la cartella è archiviata o meno. Se si attiva o disattiva questo valore, lo stato di archiviazione della cartella verrà modificato |
|
|
nome
|
name | string |
Nome della cartella |
|
|
type
|
type | True | string |
Tipo di cartella. 'Folder' o 'Program' |
Valori restituiti
- Corpo
- ResponseOfFolderResponse
Aggiornare il contenuto del file (deprecato) [DEPRECATO]
Sostituisce il contenuto corrente del file con il payload incluso. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del file
|
id | True | integer |
ID per il file nel database |
|
documento
|
file | True | string |
File multipart. Contenuto del file. |
|
id
|
id | True | integer |
ID del file |
Valori restituiti
- Corpo
- ResponseOfFileResponse
Aggiungi all'elenco (deprecato) [DEPRECATO]
Aggiunge un determinato set di record di persone a un elenco statico di destinazione. (deprecato) Esiste un limite di 300 ID lead per ogni richiesta. Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco di destinazione
|
listId | True | integer |
ID dell'elenco di destinazione |
|
id
|
id | True | integer |
ID intero univoco di un record lead |
|
Elenco delimitato da virgole di ID lead da aggiungere all'elenco
|
id | array |
Elenco delimitato da virgole di ID lead da aggiungere all'elenco |
Valori restituiti
Annulla processo lead di esportazione (deprecato) [DEPRECATO]
Annullare il processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di esportazione.
|
exportId | True | string |
ID del processo batch di esportazione. |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Annulla processo membro programma di esportazione (deprecato) [DEPRECATO]
Annullare il processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di esportazione.
|
exportId | True | string |
ID del processo batch di esportazione. |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Approva programma (deprecato) [DEPRECATO]
Approva il programma di destinazione. Valido solo per i programmi di posta elettronica non approvati. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Campagna di richiesta (deprecata) [DEPRECATO]
Passa un set di lead a una campagna trigger da eseguire attraverso il flusso della campagna. (deprecato) La campagna designata deve avere una campagna è richiesta: trigger API del servizio Web e deve essere attiva. I token locali del programma padre della campagna possono essere sottoposti a override per l'esecuzione per personalizzare il contenuto. Per ogni chiamata sono consentiti un massimo di 100 lead. Autorizzazioni necessarie: Esegui campagna
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID della campagna da attivare
|
campaignId | True | integer |
ID della campagna da attivare |
|
id
|
id | True | integer |
ID intero univoco di un record lead |
|
nome
|
name | True | string |
Nome del token. Deve essere formattato come "{{my.name}}" |
|
value
|
value | True | string |
Valore del token |
Valori restituiti
- Corpo
- ResponseOfCampaign
Clonare smart list (deprecato) [DEPRECATO]
Clona l'elenco intelligente designato. Autorizzazioni necessarie: asset Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco intelligente da clonare
|
id | True | integer |
ID dell'elenco intelligente da clonare |
|
nome
|
name | True | string |
Nome dell'elenco intelligente clonato |
|
id
|
id | True | integer |
ID della cartella |
|
type
|
type | True | string |
Tipo di cartella |
|
descrizione
|
description | string |
Descrizione dell'elenco intelligente clonato |
Valori restituiti
Crea cartella (deprecata) [DEPRECATO]
Crea una nuova cartella. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
descrizione
|
description | string |
Descrizione dell'asset |
|
|
nome
|
name | True | string |
Nome della cartella |
|
id
|
id | True | integer |
ID della cartella |
|
type
|
type | True | string |
Tipo di cartella |
Valori restituiti
- Corpo
- ResponseOfFolderResponse
Crea elenco statico (deprecato) [DEPRECATO]
Crea un nuovo elenco statico. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
descrizione
|
description | string |
Descrizione dell'elenco statico |
|
|
nome
|
name | True | string |
Nome dell'elenco statico |
|
id
|
id | True | integer |
ID della cartella |
|
type
|
type | True | string |
Tipo di cartella |
Valori restituiti
Crea file (deprecato) [DEPRECATO]
Crea un nuovo file dal payload incluso. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
descrizione
|
description | string |
Descrizione dell'asset |
|
|
documento
|
file | True | string |
File multipart. Contenuto del file. |
|
id
|
id | True | integer |
ID della cartella |
|
type
|
type | True | string |
Tipo di cartella |
|
insertOnly
|
insertOnly | boolean |
Indica se le chiamate hanno esito negativo se esiste già un file esistente con lo stesso nome |
|
|
nome
|
name | True | string |
Nome del file |
Valori restituiti
- Corpo
- ResponseOfFileResponse
Crea processo membro programma di esportazione (deprecato) [DEPRECATO]
Creare un processo di esportazione per i criteri di ricerca definiti tramite il parametro "filter". Request restituisce l'elemento "exportId" passato come parametro nelle chiamate successive agli endpoint membri del programma di esportazione bulk. (deprecated)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
nome
|
name | True | string |
Nome DELL'API REST per il campo intestazione |
|
value
|
value | True | string |
Valore per il campo intestazione |
|
fields
|
fields | True | array of string |
Elenco delimitato da virgole di campi da includere nel file |
|
programId
|
programId | True | integer |
ID del programma da cui recuperare i membri. Impossibile usare in combinazione con il filtro "programIds" |
|
programIds
|
programIds | True | array of integer |
Matrice di ID programma da cui recuperare i membri. Impossibile usare in combinazione con il filtro "programId" |
|
isExhausted
|
isExhausted | boolean |
Filtrare i record di appartenenza al programma per le persone che hanno esaurito il contenuto |
|
|
nutrirsiCadence
|
nurtureCadence | string |
Filtrare i record di appartenenza al programma per una determinata cadenza di crescita |
|
|
statusNames
|
statusNames | array of string |
Matrice di nomi di stato dei membri del programma. Può essere predefinito e/o definito dall'utente. Più nomi di stato sono ORed insieme. |
|
|
endAt
|
endAt | string |
Filtro intervallo di date di fine (formato ISO 8601) |
|
|
startAt
|
startAt | string |
Inizio del filtro dell'intervallo di date (formato ISO-8601) |
|
|
format
|
format | string |
Formato di file da creare("CSV", "TSV", "SSV"). Il valore predefinito è "CSV" |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Crea programma (deprecato) [DEPRECATO]
Crea un nuovo programma. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
canale
|
channel | True | string |
Canale del programma |
|
costo
|
cost | True | integer |
Importo del costo |
|
nota
|
note | string |
Note sul costo |
|
|
startDate
|
startDate | True | date-time |
Data di inizio del costo del periodo |
|
descrizione
|
description | string | ||
|
id
|
id | True | integer |
ID della cartella |
|
type
|
type | True | string |
Tipo di cartella |
|
nome
|
name | True | string |
Nome del programma |
|
tagType
|
tagType | string |
Tipo di tag di programma |
|
|
tagValue
|
tagValue | string |
Valore del tag |
|
|
type
|
type | True | string |
Tipo di programma |
Valori restituiti
Creare un processo lead di esportazione (deprecato) [DEPRECATO]
Creare un processo di esportazione per i criteri di ricerca definiti tramite il parametro "filter". Request restituisce l'elemento "exportId" passato come parametro nelle chiamate successive agli endpoint lead di esportazione bulk. Usare l'endpoint processo di esportazione accodamento per accodare il processo di esportazione per l'elaborazione. Usare l'endpoint Get Export Lead Job Status per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
nome
|
name | True | string |
Nome DELL'API REST per il campo intestazione |
|
value
|
value | True | string |
Valore per il campo intestazione |
|
fields
|
fields | True | array of string |
Elenco delimitato da virgole di campi da includere nel file |
|
endAt
|
endAt | string |
Filtro intervallo di date di fine (formato ISO 8601) |
|
|
startAt
|
startAt | string |
Inizio del filtro dell'intervallo di date (formato ISO-8601) |
|
|
smartListId
|
smartListId | True | integer |
ID dell'elenco intelligente da cui recuperare i lead |
|
smartListName
|
smartListName | True | string |
Nome dell'elenco intelligente da cui recuperare i lead |
|
staticListId
|
staticListId | True | integer |
ID dell'elenco statico da cui recuperare i lead |
|
staticListName
|
staticListName | True | string |
Nome dell'elenco statico da cui recuperare i lead |
|
format
|
format | string |
Formato di file da creare("CSV", "TSV", "SSV"). Il valore predefinito è "CSV" |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Describe Program Member (deprecato) [DEPRECATO]
Restituisce i metadati sugli oggetti membro del programma nell'istanza di destinazione, incluso un elenco di tutti i campi disponibili per l'interazione tramite le API. Autorizzazioni necessarie: Read-Only lead Read-Write lead
Nota: questo endpoint è stato sostituito. Usare invece Describe Program Member endpoint (Descrivere l'endpoint membro del programma ). (deprecated)
Valori restituiti
Describe Program Member (deprecato) [DEPRECATO]
Restituisce i metadati sugli oggetti membro del programma nell'istanza di destinazione, incluso un elenco di tutti i campi disponibili per l'interazione tramite le API. Autorizzazioni necessarie: Read-Only lead, Read-Write lead (deprecato)
Valori restituiti
Descrivere il lead (deprecato) [DEPRECATO]
Restituisce i metadati relativi agli oggetti lead nell'istanza di destinazione, incluso un elenco di tutti i campi disponibili per l'interazione tramite le API. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead
Nota: questo endpoint è stato sostituito. Usare invece Describe Lead2 endpoint (Descrivere l'endpoint Lead2 ).
Valori restituiti
- Corpo
- ResponseOfLeadAttribute
Descrivere Lead2 (deprecato) [DEPRECATO]
Restituisce un elenco di campi ricercabili sugli oggetti lead nell'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead
Valori restituiti
- Corpo
- ResponseOfLeadAttribute2
Elimina cartella (deprecata) [DEPRECATO]
Elimina la cartella designata. L'eliminazione avrà esito negativo se la cartella contiene contenuto. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID della cartella da eliminare
|
id | True | integer |
ID della cartella da eliminare |
|
tipo di cartella
|
type | True | string |
type |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Elimina elenco intelligente (deprecato) [DEPRECATO]
Elimina l'elenco intelligente designato. Autorizzazioni necessarie: asset Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco intelligente da eliminare
|
id | True | integer |
ID dell'elenco intelligente da eliminare |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Elimina elenco statico (deprecato) [DEPRECATO]
Elimina l'elenco statico designato. Autorizzazioni necessarie: asset Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da eliminare
|
id | True | integer |
ID dell'elenco statico da eliminare |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Elimina lead (deprecati) [DEPRECATO]
Eliminare un elenco di lead dall'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
id
|
id | True | integer |
ID intero univoco di un record lead |
|
Il parametro può essere specificato se il corpo della richiesta è vuoto.
|
id | array |
Il parametro può essere specificato se il corpo della richiesta è vuoto. È possibile specificare più ID lead. ad esempio id=1,2,3,2342 |
Valori restituiti
- Corpo
- ResponseOfLead
Elimina membri del programma (deprecati) [DEPRECATO]
Eliminare un elenco di membri dall'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del programma di destinazione.
|
programId | True | integer |
ID del programma di destinazione. |
|
leadId
|
leadId | True | integer |
ID intero univoco di un record lead |
Valori restituiti
Elimina programma (deprecato) [DEPRECATO]
Elimina il programma di destinazione. Il programma non può contenere asset in uso all'esterno del programma. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Elimina tag programma (deprecato) [DEPRECATO]
Eliminare il tag di programma non obbligatorio. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
|
Tipo di tag di programma
|
tagType | True | string |
Tipo di tag di programma |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Get Campaign By Id (deprecato) [DEPRECATO]
Restituisce il record di una campagna in base al relativo ID. (deprecato) Autorizzazioni necessarie: campagne Read-Only, campagne Read-Write
Nota: questo endpoint è stato sostituito. Usare invece Get Smart Campaign by Id endpoint (Ottieni campagna intelligente per id ).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
campaignId
|
campaignId | True | integer |
campaignId |
Valori restituiti
- Corpo
- ResponseOfCampaign
Get Campaigns (deprecato) [DEPRECATO]
Restituisce un elenco di record delle campagne. (deprecato) Autorizzazioni necessarie: campagne di Read-Only, campagne Read-Write
Nota: questo endpoint è stato sostituito. Usare invece l'endpoint Ottieni campagne intelligenti .
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Elenco delimitato da virgole di ID campagna per cui restituire i record
|
id | array |
Elenco delimitato da virgole di ID campagna per cui restituire i record |
|
|
Elenco delimitato da virgole di nomi da filtrare
|
name | array |
Elenco delimitato da virgole di nomi da filtrare |
|
|
Elenco delimitato da virgole di nomi di programma da filtrare.
|
programName | array |
Elenco delimitato da virgole di nomi di programma da filtrare. Se impostato, filtra solo le campagne che sono figli dei programmi designati. |
|
|
Elenco delimitato da virgole di nomi di aree di lavoro da filtrare.
|
workspaceName | array |
Elenco delimitato da virgole di nomi di aree di lavoro da filtrare. Se impostato, restituirà solo campagne nelle aree di lavoro indicate. |
|
|
Numero massimo di record da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Numero massimo di record da restituire. Il valore massimo e predefinito è 300. |
|
|
Un token verrà restituito da questo endpoint. Per altre informazioni, vedi Paging token.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
|
|
se è il trigger richiesto e l'origine è l'API del servizio Web
|
isTriggerable | boolean |
Impostare su true per restituire campagne attive con un trigger di campagna richiesto e l'origine è l'API del servizio Web |
Valori restituiti
- Corpo
- ResponseOfCampaign
Get Export Lead File (deprecato) [DEPRECATO]
Restituisce il contenuto del file di un processo di esportazione. (deprecato) Il processo di esportazione deve essere nello stato "Completato". Usare l'endpoint Get Export Lead Job Status per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead
Il formato di file viene specificato chiamando l'endpoint Crea processo di esportazione lead. Di seguito è riportato un esempio del formato di file predefinito ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di esportazione.
|
exportId | True | string |
ID del processo batch di esportazione. |
|
Per supportare il recupero parziale dei dati estratti
|
Range | string |
Per supportare il recupero parziale dei dati estratti, è possibile specificare l'intestazione HTTP "Range" di tipo "bytes". Per altre informazioni, vedere RFC 2616 "Richieste di recupero intervalli". Se l'intestazione non è impostata, verrà restituito l'intero contenuto. |
Valori restituiti
- response
- object
Get Export Lead Job Status (deprecato) [DEPRECATO]
Restituisce lo stato di un processo di esportazione. (deprecato) Lo stato del processo è disponibile per 30 giorni dopo il raggiungimento dello stato Completato o Non riuscito. Autorizzazioni necessarie: Read-Only lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di esportazione.
|
exportId | True | string |
ID del processo batch di esportazione. |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Get Export Lead Jobs (deprecato) [DEPRECATO]
Restituisce un elenco di processi di esportazione creati negli ultimi 7 giorni. Autorizzazioni necessarie: Read-Only lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Elenco delimitato da virgole di stati da filtrare.
|
status | array |
Elenco delimitato da virgole di stati da filtrare. |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Token della pagina successiva
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
Get Export Program Member File (deprecato) [DEPRECATO]
Restituisce il contenuto del file di un processo di esportazione. (deprecato) Il processo di esportazione deve essere nello stato "Completato". Usare l'endpoint Get Export Program Job Status (Ottieni stato processo membro programma di esportazione) per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead
Il formato di file viene specificato chiamando l'endpoint Crea processo membro del programma di esportazione. Di seguito è riportato un esempio del formato di file predefinito ("CSV").firstName,lastName,emailMarvin,Gaye,marvin.gaye@motown.com
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di esportazione.
|
exportId | True | string |
ID del processo batch di esportazione. |
|
Per supportare il recupero parziale dei dati estratti.
|
Range | string |
Per supportare il recupero parziale dei dati estratti, è possibile specificare l'intestazione HTTP "Range" di tipo "bytes". Per altre informazioni, vedere RFC 2616 "Richieste di recupero intervalli". Se l'intestazione non è impostata, verrà restituito l'intero contenuto. |
Valori restituiti
- response
- object
Get Export Program Member Job Status (deprecato) [DEPRECATO]
Restituisce lo stato di un processo di esportazione. Lo stato del processo è disponibile per 30 giorni dopo il raggiungimento dello stato Completato o Non riuscito. Autorizzazioni necessarie: Read-Only lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di esportazione.
|
exportId | True | string |
ID del processo batch di esportazione. |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Get Export Program Member Jobs (deprecato) [DEPRECATO]
Restituisce un elenco di processi di esportazione creati negli ultimi 7 giorni. Autorizzazioni necessarie: Read-Only lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Elenco delimitato da virgole di stati da filtrare.
|
status | array |
Elenco delimitato da virgole di stati da filtrare. |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
Get Folder by Name (deprecato) [DEPRECATO]
Restituisce un record di cartella per il nome specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome della cartella
|
name | True | string |
Nome della cartella. Non applicabile per i programmi |
|
Tipo della cartella (Programma o Cartella)
|
type | string |
Tipo di cartella. 'Folder' o 'Program' |
|
|
Informazioni di riferimento sulla cartella padre
|
root | string |
Informazioni di riferimento sulla cartella padre |
|
|
Il nome dell'area di lavoro
|
workSpace | string |
Nome dell'area di lavoro |
Valori restituiti
- Corpo
- ResponseOfFolderResponse
Get Folders (deprecato) [DEPRECATO]
Recupera le cartelle figlio dall'interno di una determinata cartella radice. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Informazioni di riferimento sulla cartella padre
|
root | string |
Informazioni di riferimento sulla cartella padre |
|
|
Profondità massima cartella da attraversare, valore predefinito 2
|
maxDepth | integer |
Profondità massima cartella da attraversare, valore predefinito 2 |
|
|
Numero massimo di cartelle da restituire. Valore predefinito 20, massimo 200
|
maxReturn | integer |
Numero massimo di cartelle da restituire. Valore predefinito 20, massimo 200 |
|
|
Offset intero per il paging. Valore predefinito 0
|
offset | integer |
Offset intero per il paging. Valore predefinito 0 |
|
|
Nome dell'area di lavoro
|
workSpace | string |
Nome dell'area di lavoro |
Valori restituiti
- Corpo
- ResponseOfFolderResponse
Get Import Lead Warnings (deprecato) [DEPRECATO]
Restituisce l'elenco di avvisi per il processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di importazione.
|
batchId | True | integer |
ID del processo batch di importazione. |
Valori restituiti
- response
- object
Get Import Program Member Failures (deprecato) [DEPRECATO]
Restituisce l'elenco degli errori per il processo batch di importazione. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di importazione.
|
batchId | True | integer |
ID del processo batch di importazione. |
Valori restituiti
- response
- object
Get Import Program Member Status (deprecato) [DEPRECATO]
Restituisce lo stato di un processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di importazione.
|
batchId | True | integer |
ID del processo batch di importazione. |
Valori restituiti
Get Import Program Member Warnings (deprecato) [DEPRECATO]
Restituisce l'elenco di avvisi per il processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di importazione.
|
batchId | True | integer |
ID del processo batch di importazione. |
Valori restituiti
- response
- object
Get Lead Field by Name (deprecato) [DEPRECATO]
Recupera i metadati per un singolo campo lead. (deprecato) Autorizzazioni necessarie: campo standard dello schema Read-Write Read-Write campo personalizzato schema
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome API del campo lead
|
fieldApiName | True | string |
Nome API del campo lead |
Valori restituiti
- Corpo
- ResponseOfLeadField
Get Lists (deprecato) [DEPRECATO]
Restituisce un set di record elenco statici in base ai parametri di filtro specificati. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Elenco delimitato da virgole di ID elenco statici da restituire
|
id | array |
Elenco delimitato da virgole di ID elenco statici da restituire |
|
|
Elenco delimitato da virgole di nomi di elenco statici da restituire
|
name | array |
Elenco delimitato da virgole di nomi di elenco statici da restituire |
|
|
Elenco delimitato da virgole di nomi di programma.
|
programName | array |
Elenco delimitato da virgole di nomi di programma. Se set restituirà tutti gli elenchi statici figlio dei programmi specificati |
|
|
Elenco delimitato da virgole dei nomi delle aree di lavoro.
|
workspaceName | array |
Elenco delimitato da virgole dei nomi delle aree di lavoro. Se set restituirà tutti gli elenchi statici figlio delle aree di lavoro indicate |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Un token verrà restituito da questo endpoint. Per altre informazioni, vedi Paging token.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
- Corpo
- ResponseOfStaticList
Get Program by Id (deprecato) [DEPRECATO]
Recupera il record del programma per l'ID specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
Valori restituiti
Get Program by Name (deprecato) [DEPRECATO]
Recupera il record del programma per il nome specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome del programma
|
name | True | string |
Nome del programma |
|
Impostare true per popolare i tag del programma
|
includeTags | boolean |
Impostare true per popolare i tag del programma |
|
|
Impostare true per popolare i costi del programma
|
includeCosts | boolean |
Impostare true per popolare i costi del programma |
Valori restituiti
Get Program Member Field by Name (deprecato) [DEPRECATO]
Recupera i metadati per il singolo campo membro del programma. (deprecato) Autorizzazioni necessarie: campo standard dello schema Read-Write Read-Write campo personalizzato schema
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome API del campo membro del programma
|
fieldApiName | True | string |
Nome API del campo membro del programma |
Valori restituiti
- Corpo
- ResponseOfLeadField
Get Program Members (deprecato) [DEPRECATO]
Restituisce un elenco di un massimo di 300 membri del programma in un elenco di valori in un determinato campo. Se si specifica un filterType che è un campo personalizzato, il tipo di dati del campo personalizzato deve essere "string" o "integer". Se si specifica un filterType diverso da "leadId", è possibile elaborare dalla richiesta un massimo di 100.000 record membro del programma. Autorizzazioni necessarie: Read-Only lead, Read-Write lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del programma di destinazione.
|
programId | True | integer |
ID del programma di destinazione. |
|
Campo membro del programma da filtrare.
|
filterType | True | string |
Campo membro del programma da filtrare. Qualsiasi campo personalizzato (solo tipi stringa o integer), "updatedAt" o qualsiasi campo ricercabile. I campi ricercabili possono essere ottenuti tramite l'endpoint Del membro del programma di descrizione . |
|
Elenco delimitato da virgole di valori da filtrare nei campi specificati.
|
filterValues | True | array |
Elenco delimitato da virgole di valori da filtrare nei campi specificati. |
|
Quando si usa filterType=updatedAt, l'inizio del filtro dell'intervallo di date
|
startAt | string |
Quando si usa filterType=updatedAt, l'inizio del filtro dell'intervallo di date (ISO 8601-format) |
|
|
Quando si usa filterType=updatedAt, il filtro di fine dell'intervallo di date
|
endAt | string |
Quando si usa filterType=updatedAt, il filtro dell'intervallo di date (ISO 8601-format) |
|
|
Elenco delimitato da virgole di campi lead da restituire per ogni record.
|
fields | array |
Elenco delimitato da virgole di campi lead da restituire per ogni record. |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Se il set di risultati è maggiore delle dimensioni del batch, verrà restituito un token.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
- Corpo
- ResponseOfProgramMember
Get Programs (deprecato) [DEPRECATO]
Recupera l'elenco di programmi accessibili dall'istanza di destinazione. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Numero massimo di canali da restituire. Massimo 200, valore predefinito 20
|
maxReturn | integer |
Numero massimo di canali da restituire. Massimo 200, valore predefinito 20 |
|
|
Offset integer per il paging
|
offset | integer |
Offset integer per il paging |
|
|
Filtro facoltativo. Richiede filterValues
|
filterType | string |
Filtro facoltativo. Richiede filterValues |
|
|
Escludere i programmi prima di questa data. Vedere Descrizione del tipo di campo Datetime.
|
earliestUpdatedAt | string |
Escludere i programmi prima di questa data. Deve essere una stringa ISO-8601 valida. Vedere Descrizione del tipo di campo Datetime . |
|
|
Escludere i programmi dopo questa data. Vedere Descrizione del tipo di campo Datetime.
|
latestUpdatedAt | string |
Escludere i programmi dopo questa data. Deve essere una stringa ISO-8601 valida. Vedere Descrizione del tipo di campo Datetime . |
Valori restituiti
Get Static Lists (deprecato) [DEPRECATO]
Recupera un elenco di record elenco statici. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Rappresentazione JSON della cartella padre
|
folder | string |
Rappresentazione JSON della cartella padre, con membri 'id' e 'type' che possono essere 'Folder' o 'Program' |
|
|
Offset integer per il paging
|
offset | integer |
Offset integer per il paging |
|
|
Numero massimo di elenchi statici da restituire. Massimo 200, valore predefinito 20.
|
maxReturn | integer |
Numero massimo di elenchi statici da restituire. Massimo 200, valore predefinito 20. |
|
|
Escludere elenchi statici prima di questa data. Vedere Descrizione del tipo di campo Datetime.
|
earliestUpdatedAt | string |
Escludere elenchi statici prima di questa data. Deve essere una stringa ISO-8601 valida. Vedere Descrizione del tipo di campo Datetime . |
|
|
Escludere elenchi statici dopo questa data. Vedere Descrizione del tipo di campo Datetime.
|
latestUpdatedAt | string |
Escludere elenchi statici dopo questa data. Deve essere una stringa ISO-8601 valida. Vedere Descrizione del tipo di campo Datetime . |
Valori restituiti
Identità (deprecata) [DEPRECATO]
Recuperare un token di accesso da Marketo. Le chiamate a questo endpoint non vengono conteggiate per il limite di chiamate API (deprecato).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
CLIENTID per l'API REST marketo
|
client_id | True | string |
ID client dal menu Launchpoint di integrazione > amministratore>. |
|
Segreto client per l'API REST marketo
|
client_secret | True | string |
Segreto client dal menu Launchpoint di integrazione > amministratore>. |
|
Tipo di concessione. Credenziali client del caso
|
grant_type | True | string |
Tipo di concessione. |
Valori restituiti
- Corpo
- ResponseOfIdentity
Identità (deprecata) [DEPRECATO]
Recuperare un token di accesso da Marketo. Le chiamate a questo endpoint non vengono conteggiate per il limite di chiamate API (deprecato).
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
CLIENTID per l'API REST marketo
|
client_id | True | string |
ID client dal menu Launchpoint di integrazione > amministratore>. |
|
Segreto client per l'API REST marketo
|
client_secret | True | string |
Segreto client dal menu Launchpoint di integrazione > amministratore>. |
|
Tipo di concessione. Credenziali client del caso
|
grant_type | True | string |
Tipo di concessione. |
Valori restituiti
- Corpo
- ResponseOfIdentity
Importare i membri del programma (deprecato) [DEPRECATO]
Importa un file contenente record di dati nell'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del programma a cui aggiungere membri.
|
programId | True | string |
ID del programma a cui aggiungere membri. |
|
Stato membro programma per i membri aggiunti.
|
programMemberStatus | True | string |
Stato membro programma per i membri aggiunti. |
|
Importare il formato di file.
|
format | True | string |
Importare il formato di file. |
|
File contenente i record di dati da importare.
|
file | True | file |
File contenente i record di dati da importare. |
Valori restituiti
Lead di importazione (deprecati) [DEPRECATO]
Importa un file contenente record di dati nell'istanza di destinazione. Autorizzazioni necessarie: Read-Write lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Importare il formato di file.
|
format | True | string |
Importare il formato di file. |
|
Campo da utilizzare per la deduplicazione. Campi personalizzati (string, email, integer)
|
lookupField | string |
Campo da utilizzare per la deduplicazione. Sono supportati campi personalizzati (string, email, integer) e i tipi di campo seguenti: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Il valore predefinito è email. |
|
|
Nome della partizione lead in cui eseguire l'importazione.
|
partitionName | string |
Nome della partizione lead in cui eseguire l'importazione. |
|
|
ID dell'elenco statico in cui eseguire l'importazione.
|
listId | integer |
ID dell'elenco statico in cui eseguire l'importazione. |
|
|
File contenente i record di dati da importare.
|
file | True | file |
File contenente i record di dati da importare. |
Valori restituiti
Lead di sincronizzazione (deprecati) [DEPRECATO]
Sincronizza un elenco di lead nell'istanza di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
azione
|
action | string |
Tipo di operazione di sincronizzazione da eseguire. Per impostazione predefinita, createOrUpdate se non è stato impostato |
|
|
asyncProcessing
|
asyncProcessing | boolean |
Se impostato su true, la chiamata restituirà immediatamente |
|
|
id
|
id | integer |
ID intero univoco di un record lead |
|
|
acquiredBy
|
acquiredBy | boolean |
Indica se il lead è stato acquisito dal programma padre |
|
|
isExhausted
|
isExhausted | boolean |
Indica se il lead è attualmente esaurito nel flusso, se applicabile |
|
|
membershipDate
|
membershipDate | True | string |
Data in cui il responsabile è diventato un membro del programma |
|
nutrirsiCadence
|
nurtureCadence | string |
Frequenza del flusso padre, se applicabile |
|
|
progressionStatus
|
progressionStatus | True | string |
Stato del programma principale nel programma padre |
|
reachedSuccess
|
reachedSuccess | boolean |
Indica se il lead si trova in uno stato di esito positivo nel programma padre |
|
|
torrente
|
stream | string |
Flusso di cui il lead è membro, se il programma padre è un programma di engagement |
|
|
codice
|
code | True | string |
Codice intero del motivo |
|
message
|
message | True | string |
Messaggio che descrive il motivo dello stato dell'operazione |
|
status
|
status | string |
Stato dell'operazione eseguita sul record |
|
|
lookupField
|
lookupField | string |
Campo su cui deduplicare. Il campo deve essere presente in ogni record lead dell'input. L'impostazione predefinita è la posta elettronica se non è stato impostato |
|
|
partitionName
|
partitionName | string |
Nome della partizione su cui operare, se applicabile. Deve essere impostato quando possibile, quando si interagisce con un'istanza in cui sono abilitate le partizioni. |
Valori restituiti
- Corpo
- ResponseOfLead
Membro dell'elenco (deprecato) [DEPRECATO]
Controlla se i lead sono membri di un determinato elenco statico. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da verificare
|
listId | True | integer |
ID dell'elenco statico da verificare |
|
id
|
id | True | integer |
ID intero univoco di un record lead |
|
Elenco delimitato da virgole di ID lead da controllare
|
id | array |
Elenco delimitato da virgole di ID lead da controllare |
Valori restituiti
Ottenere elenchi intelligenti (deprecati) [DEPRECATO]
Recupera un elenco di record smart list creati dall'utente. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Rappresentazione JSON della cartella padre
|
folder | string |
Rappresentazione JSON della cartella padre, con membri 'id' e 'type' che possono essere 'Folder' o 'Program' |
|
|
Offset integer per il paging
|
offset | integer |
Offset integer per il paging |
|
|
Numero massimo di elenchi intelligenti da restituire. Massimo 200, valore predefinito 20.
|
maxReturn | integer |
Numero massimo di elenchi intelligenti da restituire. Massimo 200, valore predefinito 20. |
|
|
Escludere gli elenchi intelligenti prima di questa data. Vedere Descrizione del tipo di campo Datetime.
|
earliestUpdatedAt | string |
Escludere gli elenchi intelligenti prima di questa data. Deve essere una stringa ISO-8601 valida. Vedere Descrizione del tipo di campo Datetime . |
|
|
Escludere gli elenchi intelligenti dopo questa data. Vedere Descrizione del tipo di campo Datetime.
|
latestUpdatedAt | string |
Escludere gli elenchi intelligenti dopo questa data. Deve essere una stringa ISO-8601 valida. Vedere Descrizione del tipo di campo Datetime . |
Valori restituiti
Ottenere gli errori dei lead di importazione (deprecato) [DEPRECATO]
Restituisce l'elenco degli errori per il processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di importazione.
|
batchId | True | integer |
ID del processo batch di importazione. |
Valori restituiti
- response
- object
Ottenere l'elenco intelligente per nome (deprecato) [DEPRECATO]
Recupera un record Smart List in base al nome. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'elenco intelligente da recuperare
|
name | True | string |
Nome dell'elenco intelligente da recuperare |
Valori restituiti
Ottenere l'elenco per ID (deprecato) [DEPRECATO]
Restituisce un record di elenco in base al relativo ID. (deprecato) Autorizzazioni necessarie: Read-Only lead, Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da cui recuperare i record
|
listId | True | integer |
ID dell'elenco statico da cui recuperare i record |
Valori restituiti
- Corpo
- ResponseOfStaticList
Ottenere l'elenco statico per ID (deprecato) [DEPRECATO]
Recupera un record elenco statico in base al relativo ID. Autorizzazioni necessarie: Read-Asset o Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da recuperare
|
id | True | integer |
ID dell'elenco statico da recuperare |
Valori restituiti
Ottenere l'elenco statico per nome (deprecato) [DEPRECATO]
Recupera un record elenco statico in base al nome. Autorizzazioni necessarie: asset Read-Asset o Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome dell'elenco statico da recuperare
|
name | True | string |
Nome dell'elenco statico da recuperare |
Valori restituiti
Ottenere lead per ID (deprecato) [DEPRECATO]
Recupera un singolo record lead tramite l'ID Marketo. (deprecato) Autorizzazioni necessarie: Read-Only Lead, Read-Write Lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID lead marketo
|
leadId | True | integer |
ID lead marketo |
|
Elenco delimitato da virgole di nomi di campo.
|
fields | array |
Elenco delimitato da virgole di nomi di campo. Se omesso, verranno restituiti i campi predefiniti seguenti: email, updatedAt, createdAt, lastName, firstName e ID. |
Valori restituiti
- Corpo
- ResponseOfLead
Ottenere lead per ID elenco (deprecato) [DEPRECATO]
Recupera i record delle persone che sono membri dell'elenco statico specificato. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da cui recuperare i record
|
listId | True | integer |
ID dell'elenco statico da cui recuperare i record |
|
Elenco delimitato da virgole di campi lead da restituire per ogni record.
|
fields | array |
Elenco delimitato da virgole di campi lead da restituire per ogni record. Se unset restituirà posta elettronica, updatedAt, createdAt, lastName, firstName e ID |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Un token verrà restituito da questo endpoint. Per altre informazioni, vedi Paging token.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
- Corpo
- ResponseOfLead
Ottenere lead per ID elenco (deprecato) [DEPRECATO]
Recupera i record delle persone che sono membri dell'elenco statico specificato. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da cui recuperare i record
|
listId | True | integer |
ID dell'elenco statico da cui recuperare i record |
|
Elenco delimitato da virgole di campi lead da restituire per ogni record.
|
fields | array |
Elenco delimitato da virgole di campi lead da restituire per ogni record. Se unset restituirà posta elettronica, updatedAt, createdAt, lastName, firstName e ID |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Un token verrà restituito da questo endpoint. Per altre informazioni, vedi Paging token.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
- Corpo
- ResponseOfLeadByListId
Ottenere lead per ID programma (deprecato) [DEPRECATO]
Recupera un elenco di lead che sono membri del programma designato. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del programma da cui recuperare
|
programId | True | integer |
ID del programma da cui recuperare |
|
Elenco delimitato da virgole di campi da restituire per ogni record
|
fields | array |
Elenco delimitato da virgole di campi da restituire per ogni record |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Un token verrà restituito da questo endpoint. Per altre informazioni, vedi Paging token.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
- Corpo
- ResponseOfLead
Ottenere lead per tipo di filtro (deprecato) [DEPRECATO]
Restituisce un elenco di un massimo di 300 lead in base a un elenco di valori in un determinato campo. (deprecato) Autorizzazioni necessarie: Read-Only lead Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Campo del lead in base al quale filtrare.
|
filterType | True | string |
Campo del lead in base al quale filtrare. Tutti i campi personalizzati (solo string, email o integer) e uno dei campi seguenti sono supportati: cookie, email, facebookId, id, leadPartitionId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId. |
|
Elenco delimitato da virgole di valori da filtrare nei campi specificati.
|
filterValues | True | array |
Elenco delimitato da virgole di valori da filtrare nei campi specificati. |
|
Elenco delimitato da virgole di campi lead da restituire per ogni record
|
fields | array |
Elenco delimitato da virgole di campi lead da restituire per ogni record |
|
|
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300.
|
batchSize | integer |
Dimensioni del batch da restituire. Il valore massimo e predefinito è 300. |
|
|
Un token verrà restituito da questo endpoint. Per altre informazioni, vedi Paging token.
|
nextPageToken | string |
Un token verrà restituito da questo endpoint se il set di risultati è maggiore delle dimensioni del batch e può essere passato in una chiamata successiva tramite questo parametro. Per altre informazioni, vedi Paging token. |
Valori restituiti
- Corpo
- ResponseOfLead
Ottenere lo stato del lead di importazione (deprecato) [DEPRECATO]
Restituisce lo stato di un processo batch di importazione. Autorizzazioni necessarie: Read-Write lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di importazione.
|
batchId | True | integer |
ID del processo batch di importazione. |
Valori restituiti
Ottenere programmi per tag (deprecato) [DEPRECATO]
Recupera un elenco di programmi corrispondenti al tipo di tag e ai valori di tag specificati. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Tipo di tag di programma
|
tagType | True | string |
Tipo di tag di programma |
|
Valore del tag
|
tagValue | True | string |
Valore del tag |
|
Numero massimo di canali da restituire. Massimo 200, valore predefinito 20
|
maxReturn | integer |
Numero massimo di canali da restituire. Massimo 200, valore predefinito 20 |
|
|
Offset integer per il paging
|
offset | integer |
Offset integer per il paging |
Valori restituiti
Ottenere smart list per ID (deprecato) [DEPRECATO]
Recupera un record smart list in base al relativo ID. Autorizzazioni necessarie: Read-Asset o asset di Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco intelligente da recuperare
|
id | True | integer |
ID dell'elenco intelligente da recuperare |
|
Impostare true per popolare le regole dell'elenco intelligente. Valore predefinito false
|
includeRules | boolean |
Impostare true per popolare le regole dell'elenco intelligente. Valore predefinito false |
Valori restituiti
Ottenere smart list per ID programma (deprecato) [DEPRECATO]
Recupera un record smart list in base all'ID programma di posta elettronica. Autorizzazioni necessarie: Read-Asset o Read-Write Asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID per il programma di posta elettronica contenente l'elenco intelligente da recuperare
|
programId | True | integer |
ID per il programma di posta elettronica contenente l'elenco intelligente da recuperare |
|
Impostare true per popolare le regole dell'elenco intelligente. Valore predefinito false
|
includeRules | boolean |
Impostare true per popolare le regole dell'elenco intelligente. Valore predefinito false |
Valori restituiti
Pianificazione campagna (deprecata) [DEPRECATO]
Pianifica in remoto l'esecuzione di una campagna batch in un determinato momento. (deprecato) I token locali del programma padre della campagna possono essere sottoposti a override per l'esecuzione per personalizzare il contenuto. Quando si usa il parametro "cloneToProgramName" descritto di seguito, questo endpoint è limitato a 20 chiamate al giorno. Autorizzazioni necessarie: Esegui campagna
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID della campagna batch da pianificare.
|
campaignId | True | integer |
ID della campagna batch da pianificare. |
|
cloneToProgramName
|
cloneToProgramName | string |
Nome del programma risultante. Se impostato, questo attributo causerà la creazione della campagna, del programma padre e di tutti i relativi asset con il nuovo nome risultante. Il programma padre verrà clonato e verrà pianificata la campagna appena creata. Il programma risultante viene creato sotto l'elemento padre. I programmi con frammenti di codice, notifiche push, messaggi in-app, elenchi statici, report e asset di social networking potrebbero non essere clonati in questo modo |
|
|
runAt
|
runAt | date-time |
Datetime per eseguire la campagna all'indirizzo. Se non è impostato, la campagna verrà eseguita cinque minuti dopo l'esecuzione della chiamata |
|
|
nome
|
name | True | string |
Nome del token. Deve essere formattato come "{{my.name}}" |
|
value
|
value | True | string |
Valore del token |
Valori restituiti
- Corpo
- ResponseOfCampaign
Processo lead di esportazione accodamento (deprecato) [DEPRECATO]
Processo di esportazione accodamento. In questo modo verrà inserito il processo di esportazione in coda e verrà avviato quando le risorse di calcolo diventano disponibili. Il processo di esportazione deve essere in stato "Creato". Usare l'endpoint Get Export Lead Job Status per recuperare lo stato del processo di esportazione. Autorizzazioni necessarie: Read-Only lead (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch di esportazione.
|
exportId | True | string |
ID del processo batch di esportazione. |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Processo membro del programma di esportazione accodamento (deprecato) [DEPRECATO]
Processo di esportazione accodamento. In questo modo verrà inserito il processo di esportazione in coda e verrà avviato quando le risorse di calcolo diventano disponibili. Il processo di esportazione deve essere in stato "Creato". (deprecated)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del processo batch.
|
exportId | True | string |
ID del processo batch di esportazione. |
Valori restituiti
- Corpo
- ResponseOfExportResponse
Programma clone (deprecato) [DEPRECATO]
Clona il programma di destinazione. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
|
descrizione
|
description | string | ||
|
id
|
id | True | integer |
ID della cartella |
|
type
|
type | True | string |
Tipo di cartella |
|
nome
|
name | True | string |
Nome del programma. Massimo 255 caratteri |
Valori restituiti
Programma non approvato (deprecato) [DEPRECATO]
Annulla l'applicazione del programma di destinazione. Valido solo per i programmi di posta elettronica approvati. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Push Lead to Marketo (deprecato) [DEPRECATO]
Upserts un lead e genera un'attività Push Lead to Marketo. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
id
|
id | integer |
ID intero univoco di un record lead |
|
|
codice
|
code | True | string |
Codice intero del motivo |
|
message
|
message | True | string |
Messaggio che descrive il motivo dello stato dell'operazione |
|
status
|
status | string |
Stato dell'operazione eseguita sul record |
|
|
lookupField
|
lookupField | string | ||
|
partitionName
|
partitionName | string | ||
|
programName
|
programName | string | ||
|
programStatus
|
programStatus | string | ||
|
reason
|
reason | string | ||
|
source
|
source | string |
Valori restituiti
Recupera cartella per ID (deprecato) [DEPRECATO]
Restituisce il record della cartella con l'ID specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID della cartella da recuperare
|
id | True | integer |
ID della cartella da recuperare |
|
Tipo della cartella (Programma o Cartella)
|
type | True | string |
Tipo di cartella. 'Folder' o 'Program' |
Valori restituiti
- Corpo
- ResponseOfFolderResponse
Recupera contenuto cartella (deprecato) [DEPRECATO]
Restituisce i record per il contenuto di una determinata cartella. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID della cartella da recuperare
|
id | True | integer |
ID della cartella da recuperare |
|
Numero massimo di canali da restituire. Massimo 200, valore predefinito 20
|
maxReturn | integer |
Numero massimo di canali da restituire. Massimo 200, valore predefinito 20 |
|
|
Offset integer per il paging
|
offset | integer |
Offset integer per il paging |
|
|
Tipo di cartella. 'Folder' o 'Program'. Il valore predefinito è 'Folder'
|
type | True | string |
Tipo di cartella. 'Folder' o 'Program'. Il valore predefinito è 'Folder' |
Valori restituiti
Recupera file (deprecato) [DEPRECATO]
Restituisce i file dalla cartella specificata. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
id
|
id | True | integer |
ID della cartella |
|
type
|
type | True | string |
Tipo di cartella |
|
maxRitorno
|
maxReturn | integer |
Numero massimo di canali da restituire. Massimo 200, valore predefinito 20 |
|
|
offset
|
offset | integer |
Offset integer per il paging |
|
|
Cartella in cui inserire il file
|
folder | string |
Rappresentazione JSON della cartella padre, con membri 'id' e 'type' che possono essere 'Folder' o 'Program' |
Valori restituiti
- Corpo
- ResponseOfFileResponse
Recupera file per ID (deprecato) [DEPRECATO]
Restituisce il record di file per l'ID specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del file
|
id | True | integer |
ID per il file nel database |
Valori restituiti
- Corpo
- ResponseOfFileResponse
Recupera file per nome (deprecato) [DEPRECATO]
Restituisce i record di file per il nome specificato. Autorizzazioni necessarie: asset Read-Only, asset Read-Write (deprecati)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Il nome del file
|
name | True | string |
Nome del file |
Valori restituiti
- Corpo
- ResponseOfFileResponse
Rimuovi da elenco (deprecato) [DEPRECATO]
Rimuove un determinato set di record di persone da un elenco statico di destinazione. (deprecato) Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dell'elenco statico da cui rimuovere i lead
|
listId | True | integer |
ID dell'elenco statico da cui rimuovere i lead |
|
id
|
id | True | integer |
ID intero univoco di un record lead |
|
id
|
id | True | array |
id |
Valori restituiti
Sincronizzare i dati dei membri del programma (deprecato) [DEPRECATO]
Modifica i dati dei membri del programma di un elenco di lead in un programma di destinazione. (deprecato) Solo i membri esistenti del programma possono cambiare i dati con questa API. Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del programma di destinazione.
|
programId | True | integer |
ID del programma di destinazione. |
|
leadId
|
leadId | True | integer |
ID intero univoco di un record lead |
|
{fieldApiName}
|
{fieldApiName} | True | string |
Nome API del campo da aggiornare. Deve essere aggiornabile come descritto in Descrivere l'endpoint membro del programma . |
|
{fieldApiName2}
|
{fieldApiName2} | string |
Nome API di un altro campo da aggiornare (e così via). Deve essere aggiornabile come descritto in Descrivere l'endpoint membro del programma . |
Valori restituiti
Stato membro del programma di sincronizzazione (deprecato) [DEPRECATO]
Modifica lo stato del membro del programma di un elenco di lead in un programma di destinazione. (deprecato) Se il membro non fa parte del programma, il membro viene aggiunto al programma. Autorizzazioni necessarie: Read-Write lead
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID del programma di destinazione.
|
programId | True | integer |
ID del programma di destinazione. |
|
statusName
|
statusName | True | string |
Stato membro programma |
|
leadId
|
leadId | True | integer |
ID intero univoco di un record lead |
Valori restituiti
Update Program Tag (deprecato) [DEPRECATO]
Aggiornare il tag del programma. Autorizzazioni necessarie: Read-Write asset (deprecato)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID programma
|
id | True | integer |
id |
|
Tipo di tag di programma
|
tagType | True | string |
Tipo di tag di programma |
|
Valore del tag di programma
|
tagValue | True | string |
Valore del tag di programma |
Valori restituiti
- Corpo
- ResponseOfIdResponse
Definizioni
ResponseOfIdentity
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
access_token
|
access_token | string |
Token passato con chiamate successive per l'autenticazione con l'istanza di destinazione |
|
scopo
|
scope | string |
Utente proprietario solo API del servizio personalizzato usato per l'autenticazione |
|
expires_in
|
expires_in | integer |
Durata rimanente del token corrente in secondi |
|
token_type
|
token_type | string |
Metodo di autenticazione OAuth |
ResponseOfStaticList
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of StaticList |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
Piombo
Record lead. Contiene sempre l'ID, ma può avere un numero qualsiasi di altri campi, a seconda dei campi disponibili nell'istanza di destinazione.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID intero univoco di un record lead |
|
Iscrizione
|
membership | ProgramMembership | |
|
reason
|
reason | Reason | |
|
status
|
status | string |
Stato dell'operazione eseguita sul record |
LeadField
Record di campo lead
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome visualizzato
|
displayName | string |
Nome visualizzato dell'interfaccia utente del campo |
|
nome
|
name | string |
Nome API del campo |
|
descrizione
|
description | string |
Descrizione del campo |
|
Tipo di dato
|
dataType | string |
Tipo di dati del campo |
|
length
|
length | integer |
Lunghezza massima del campo. Applicabile solo a testo, stringa e area di testo. |
|
isHidden
|
isHidden | boolean |
Se impostato su true, il campo è nascosto |
|
isHtmlEncodingInEmail
|
isHtmlEncodingInEmail | boolean |
Se impostato su true, il campo viene codificato come HTML nel messaggio di posta elettronica |
|
isSensitive
|
isSensitive | boolean |
Se impostato su true, il campo viene contrassegnato come sensibile |
|
isCustom
|
isCustom | boolean |
Se impostato su true, il campo è personalizzato |
|
isApiCreated
|
isApiCreated | boolean |
Se impostato su true, il campo è stato creato usando l'API REST |
LeadFieldStatus
Stato di aggiornamento del campo lead
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
Nome API del campo |
|
status
|
status | string |
Stato dell'operazione eseguita sul record |
ListOperationOutputData
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID intero univoco di un record lead |
|
Motivi
|
reasons | array of Reason |
Elenco dei motivi per cui un'operazione non è riuscita. I motivi sono presenti solo nelle risposte api e non devono essere inviati |
|
status
|
status | string |
Stato dell'operazione eseguita sul record |
LeadAttribute
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Tipo di dato
|
dataType | string |
Tipo di dati del campo |
|
nome visualizzato
|
displayName | string |
Nome visualizzato dell'interfaccia utente del campo |
|
id
|
id | integer |
ID intero univoco del campo |
|
length
|
length | integer |
Lunghezza massima del campo. Applicabile solo a testo, stringa e area di testo. |
|
riposo
|
rest | LeadMapAttribute | |
|
sapone
|
soap | LeadMapAttribute |
LeadAttribute2
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
"Lead API" |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Elenco di campi ricercabili |
|
fields
|
fields | array of LeadAttribute2Fields |
Descrizione dei campi ricercabili |
LeadAttribute2SearchableFields
Elenco di campi ricercabili
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Elementi
|
string |
Campo ricercabile |
LeadAttribute2Fields
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
Nome DELL'API REST del campo |
|
nome visualizzato
|
displayName | string |
Nome visualizzato del campo (nome descrittivo) |
|
Tipo di dato
|
dataType | string |
Tipo di dati del campo |
|
length
|
length | integer |
Lunghezza del campo |
|
updateable
|
updateable | boolean |
È aggiornabile sul campo |
|
crmManaged
|
crmManaged | boolean |
Il campo è gestito da CRM |
LeadAttribute2Fields2
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
Nome DELL'API REST del campo |
|
nome visualizzato
|
displayName | string |
Nome visualizzato del campo (nome descrittivo) |
|
Tipo di dato
|
dataType | string |
Tipo di dati del campo |
|
length
|
length | integer |
Lunghezza del campo |
|
updateable
|
updateable | boolean |
È aggiornabile sul campo |
|
crmManaged
|
crmManaged | boolean |
Il campo è gestito da CRM |
ProgramMemberAttribute
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
"Membro del programma API" |
|
fields
|
fields | array of LeadAttribute2Fields |
Descrizione dei campi ricercabili |
ProgramMemberAttribute2
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
"Membro del programma API" |
|
descrizione
|
description | string |
"Mappa dei membri del programma API" |
|
createdAt
|
createdAt | string |
Data/ora di creazione |
|
updatedAt
|
updatedAt | string |
Datetime aggiornato |
|
dedupeFields
|
dedupeFields | array of string |
Elenco dei campi deduplicati |
|
searchableFields
|
searchableFields | array of LeadAttribute2SearchableFields |
Elenco di campi ricercabili |
|
fields
|
fields | array of LeadAttribute2Fields2 |
Descrizione dei campi ricercabili |
ResponseOfImportLeadResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ImportLeadResponse |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ImportProgramMemberResponse
Risposta contenente informazioni sullo stato dell'importazione
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
batchId
|
batchId | integer |
ID intero univoco del processo di importazione |
|
importId
|
importId | string |
ID intero univoco del processo di importazione |
|
status
|
status | string |
Stato del processo di importazione |
ResponseOfImportProgramMemberResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ImportProgramMemberResponse |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfCampaign
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of Campaign |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfListOperationOutputData
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ListOperationOutputData |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
Campagna
Record di una campagna Smart Marketo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
attivo
|
active | boolean |
Indica se la campagna è attiva. Applicabile solo per attivare campagne |
|
createdAt
|
createdAt | string |
Data/ora di creazione della campagna |
|
descrizione
|
description | string |
Descrizione della campagna intelligente |
|
id
|
id | integer |
ID intero univoco della campagna intelligente |
|
nome
|
name | string |
Nome della campagna intelligente |
|
programId
|
programId | integer |
ID del programma padre, se applicabile |
|
programName
|
programName | string |
Nome del programma padre, se applicabile |
|
type
|
type | string |
Tipo di campagna intelligente |
|
updatedAt
|
updatedAt | string |
Datetime in cui la campagna è stata aggiornata più di recente |
|
Nome area di lavoro
|
workspaceName | string |
Nome dell'area di lavoro padre, se applicabile |
ResponseOfLead
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of Lead |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfLeadByListId
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of Lead |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfLeadField
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of LeadField |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfUpdateLeadField
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of LeadFieldStatus |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfPushLeadToMarketo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of Lead |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfLeadAttribute
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of LeadAttribute |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfLeadAttribute2
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of LeadAttribute2 |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfProgramMemberAttributes
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ProgramMemberAttribute |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfProgramMemberAttributes2
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ProgramMemberAttribute2 |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
Avvertimento
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
codice
|
code | integer |
Codice intero dell'avviso |
|
message
|
message | string |
Messaggio che descrive l'avviso |
ResponseOfExportResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ExportResponse |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfExportResponseWithToken
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ExportResponse |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfProgramMember
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ProgramMember |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ProgrammaMember
Record membro del programma. Contiene sempre l'ID lead, ma può avere un numero qualsiasi di altri campi, a seconda dei campi disponibili nell'istanza di destinazione.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Seq
|
seq | integer |
Intero che indica la sequenza del record in risposta. Questo valore è correlato all'ordine dei record inclusi nell'input della richiesta. Seq deve far parte solo delle risposte e non deve essere inviato. |
|
leadId
|
leadId | integer |
ID intero univoco di un record lead |
|
reachedSuccess
|
reachedSuccess | boolean |
Valore booleano che indica se il membro del programma ha raggiunto i criteri di successo per il programma |
|
programId
|
programId | integer |
ID intero univoco di un programma |
|
acquiredBy
|
acquiredBy | boolean |
Valore booleano che indica se il membro del programma è stato acquisito dal programma |
|
membershipDate
|
membershipDate | string |
Data in cui il responsabile è diventato un membro del programma |
ResponseOfProgramMemberStatus
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ProgramMemberStatusResponse |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfProgramMemberData
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ProgramMemberStatusResponse |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ResponseOfProgramMemberDelete
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error |
Matrice di errori che si sono verificati se la richiesta non è riuscita |
|
moreResult
|
moreResult | boolean |
Valore booleano che indica se sono presenti più risultati nelle pagine successive |
|
nextPageToken
|
nextPageToken | string |
Token di paging specificato se il set di risultati ha superato le dimensioni del batch consentite |
|
requestId
|
requestId | string |
ID della richiesta effettuata |
|
risultato
|
result | array of ProgramMemberDeleteResponse |
La matrice di risultati per i singoli record nell'operazione può essere vuota |
|
successo
|
success | boolean |
Indica se la richiesta è riuscita |
|
Avvertenze
|
warnings | array of Warning |
Matrice di avvisi specificati per l'operazione |
ImportLeadResponse
Risposta contenente informazioni sullo stato dell'importazione
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
batchId
|
batchId | integer |
ID intero univoco del batch di importazione |
|
importId
|
importId | string | |
|
message
|
message | string | |
|
numOfLeadsProcessed
|
numOfLeadsProcessed | integer |
Numero di righe elaborate finora |
|
numOfRowsFailed
|
numOfRowsFailed | integer |
Numero di righe non riuscite finora |
|
numOfRowsWithWarning
|
numOfRowsWithWarning | integer |
Numero di righe con un avviso finora |
|
status
|
status | string |
Stato del batch |
ProgramMembership
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
acquiredBy
|
acquiredBy | boolean |
Indica se il lead è stato acquisito dal programma padre |
|
isExhausted
|
isExhausted | boolean |
Indica se il lead è attualmente esaurito nel flusso, se applicabile |
|
membershipDate
|
membershipDate | string |
Data in cui il responsabile è diventato un membro del programma |
|
nutrirsiCadence
|
nurtureCadence | string |
Frequenza del flusso padre, se applicabile |
|
progressionStatus
|
progressionStatus | string |
Stato del programma principale nel programma padre |
|
reachedSuccess
|
reachedSuccess | boolean |
Indica se il lead si trova in uno stato di esito positivo nel programma padre |
|
torrente
|
stream | string |
Flusso di cui il lead è membro, se il programma padre è un programma di engagement |
ExportResponse
Risposta contenente informazioni sullo stato del processo di esportazione
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
Data di creazione della richiesta di esportazione |
|
errorMsg
|
errorMsg | string |
Messaggio di errore in caso di stato "Non riuscito" |
|
exportId
|
exportId | string |
ID univoco del processo di esportazione |
|
dimensione del file
|
fileSize | integer |
Dimensioni del file esportato in byte. Questo valore avrà un valore solo quando lo stato è "Completato", in caso contrario Null |
|
fileChecksum
|
fileChecksum | string |
Hash SHA-256 del file esportato. Questo valore avrà un valore solo quando lo stato è "Completato", in caso contrario Null |
|
finishedAt
|
finishedAt | date-time |
Ora di fine del processo di esportazione. Questo valore avrà valore solo quando lo stato è "Completato" o "Non riuscito", in caso contrario Null |
|
format
|
format | string |
Formato del file come indicato nella richiesta ("CSV", "TSV", "SSV") |
|
numberOfRecords
|
numberOfRecords | integer |
Numero di record nel file di esportazione. Questo valore avrà valore solo quando lo stato è "Completato", in caso contrario Null |
|
queuedAt
|
queuedAt | date-time |
Tempo di esportazione della coda. Questo valore avrà il valore quando viene raggiunto lo stato "In coda", prima di tale valore Null |
|
startedAt
|
startedAt | date-time |
Ora di inizio del processo di esportazione. Questo valore avrà il valore quando viene raggiunto lo stato "Elaborazione", prima di tale valore null |
|
status
|
status | string |
Stato del processo di esportazione ("Created","Queued","Processing","Canceled","Completed","Failed") |
Motivo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
codice
|
code | string |
Codice intero del motivo |
|
message
|
message | string |
Messaggio che descrive il motivo dello stato dell'operazione |
LeadMapAttribute
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
Nome dell'attributo |
|
sola lettura
|
readOnly | boolean |
Indica se l'attributo è di sola lettura |
Errore
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
codice
|
code | string |
Codice di errore dell'errore. Vedere l'elenco completo dei codici di errore qui |
|
message
|
message | string |
Messaggio che descrive la causa dell'errore |
ProgramMemberStatusResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
status
|
status | string |
Stato dell'operazione eseguita sul record |
|
Motivi
|
reasons | array of Reason |
Elenco dei motivi per cui un'operazione non è riuscita. I motivi sono presenti solo nelle risposte api e non devono essere inviati |
|
leadId
|
leadId | integer |
ID del lead associato al membro del programma |
|
Seq
|
seq | integer |
Intero che indica la sequenza del record in risposta. Questo valore è correlato all'ordine dei record inclusi nell'input della richiesta. Seq deve far parte solo delle risposte e non deve essere inviato. |
ProgramMemberDeleteResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
status
|
status | string |
Stato dell'operazione eseguita sul record |
|
Motivi
|
reasons | array of Reason |
Elenco dei motivi per cui un'operazione non è riuscita. I motivi sono presenti solo nelle risposte api e non devono essere inviati |
|
leadId
|
leadId | integer |
ID del lead associato al membro del programma |
|
Seq
|
seq | integer |
Intero che indica la sequenza del record in risposta. Questo valore è correlato all'ordine dei record inclusi nell'input della richiesta. Seq deve far parte solo delle risposte e non deve essere inviato. |
StaticList
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
createdAt
|
createdAt | string |
Data/ora di creazione dell'elenco |
|
descrizione
|
description | string |
Descrizione dell'elenco statico |
|
id
|
id | integer |
ID intero univoco dell'elenco statico |
|
nome
|
name | string |
Nome dell'elenco statico |
|
programName
|
programName | string |
Nome del programma |
|
updatedAt
|
updatedAt | string |
Datetime quando l'elenco è stato aggiornato più di recente |
|
Nome area di lavoro
|
workspaceName | string |
Nome dell'area di lavoro padre, se applicabile |
BrowseAllPrograms
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
canale
|
channel | string |
Canale del programma |
|
createdAt
|
createdAt | date-time |
Data/ora di creazione dell'asset |
|
descrizione
|
description | string |
Descrizione dell'asset |
|
folder
|
folder | Folder |
Rappresentazione JSON di una cartella |
|
id
|
id | integer |
ID dell'asset |
|
nome
|
name | string |
Nome dell'asset |
|
sfdcId
|
sfdcId | string |
ID SFDC del programma se collegato a una campagna SFDC |
|
sfdcName
|
sfdcName | string |
Nome della campagna SFDC collegata, se applicabile |
|
status
|
status | string |
Stato del programma. Valido solo per i tipi di programma email e engagement. |
|
type
|
type | string |
Tipo di programma |
|
updatedAt
|
updatedAt | date-time |
Datetime l'asset è stato aggiornato più di recente |
|
URL
|
url | string |
URL dell'asset nell'interfaccia utente di Marketo |
|
workspace
|
workspace | string |
Nome dell'area di lavoro |
FolderContentResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
type
|
type | string |
FileFolder
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer | |
|
nome
|
name | string | |
|
type
|
type | string |
ResponseOfProgramResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of ProgramResponse | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
ResponseOfSmartListResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of SmartListResponse | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
ResponseOfSmartListResponseWithRules
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of SmartListResponseWithRules | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
SmartListResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID dell'elenco intelligente |
|
nome
|
name | string |
Nome dell'elenco intelligente |
|
descrizione
|
description | string |
Descrizione dell'elenco intelligente |
|
createdAt
|
createdAt | date-time |
Datetime creazione dell'elenco intelligente |
|
updatedAt
|
updatedAt | date-time |
Datetime l'elenco intelligente è stato aggiornato più di recente |
|
URL
|
url | string |
URL dell'elenco intelligente nell'interfaccia utente di Marketo |
|
folder
|
folder | Folder |
Rappresentazione JSON di una cartella |
|
workspace
|
workspace | string |
Nome dell'area di lavoro |
SmartListResponseWithRules
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID dell'elenco intelligente |
|
nome
|
name | string |
Nome dell'elenco intelligente |
|
descrizione
|
description | string |
Descrizione dell'elenco intelligente |
|
createdAt
|
createdAt | date-time |
Datetime creazione dell'elenco intelligente |
|
updatedAt
|
updatedAt | date-time |
Datetime l'elenco intelligente è stato aggiornato più di recente |
|
URL
|
url | string |
URL dell'elenco intelligente nell'interfaccia utente di Marketo |
|
folder
|
folder | Folder |
Rappresentazione JSON di una cartella |
|
workspace
|
workspace | string |
Nome dell'area di lavoro |
|
regole
|
rules | SmartListRules |
Rappresentazione JSON delle regole dell'elenco intelligente |
ResponseOfStaticListResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of StaticListResponse | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
StaticListResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID dell'elenco statico |
|
nome
|
name | string |
Nome dell'elenco statico |
|
descrizione
|
description | string |
Descrizione dell'elenco statico |
|
createdAt
|
createdAt | date-time |
Datetime creazione dell'elenco statico |
|
updatedAt
|
updatedAt | date-time |
Datetime l'elenco statico è stato aggiornato più di recente |
|
URL
|
url | string |
URL dell'elenco statico nell'interfaccia utente di Marketo |
|
folder
|
folder | Folder |
Rappresentazione JSON di una cartella |
|
workspace
|
workspace | string |
Nome dell'area di lavoro |
|
computedUrl
|
computedUrl | string |
ProgramResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
canale
|
channel | string |
Canale del programma |
|
costs
|
costs | array of Costs |
Elenchi di costi di periodo associati |
|
createdAt
|
createdAt | date-time |
Data/ora di creazione dell'asset |
|
descrizione
|
description | string |
Descrizione dell'asset |
|
Data di fine
|
endDate | date-time |
Data di fine del programma. Applicabile ai programmi di tipo evento, posta elettronica e webinar |
|
folder
|
folder | ProgramFolder | |
|
id
|
id | integer |
ID dell'asset |
|
nome
|
name | string |
Nome dell'asset |
|
sfdcId
|
sfdcId | string |
ID SFDC del programma se collegato a una campagna SFDC |
|
sfdcName
|
sfdcName | string |
Nome della campagna SFDC collegata, se applicabile |
|
startDate
|
startDate | date-time |
Data di inizio del programma. Applicabile ai programmi di tipo evento, posta elettronica e webinar |
|
status
|
status | string |
Stato del programma. Valido solo per i tipi di programma email e engagement. |
|
tags
|
tags | array of Tags |
Elenco dei tag di programma associati |
|
type
|
type | string |
Tipo di programma |
|
updatedAt
|
updatedAt | date-time |
Datetime l'asset è stato aggiornato più di recente |
|
URL
|
url | string |
URL dell'asset nell'interfaccia utente di Marketo |
|
workspace
|
workspace | string |
Nome dell'area di lavoro |
|
marketingProgramProgressionId
|
marketingProgramProgressionId | integer | |
|
headStart
|
headStart | boolean |
Indica se la funzione 'Head Start' è abilitata per il programma |
FileResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
createdAt
|
createdAt | date-time |
Data/ora di creazione del file |
|
descrizione
|
description | string |
Descrizione del file |
|
folder
|
folder | FileFolder | |
|
id
|
id | integer |
ID del file |
|
tipo MIME
|
mimeType | string |
Tipo MIME del file |
|
nome
|
name | string |
Nome del file |
|
size
|
size | integer |
Dimensioni del file in byte |
|
updatedAt
|
updatedAt | date-time |
Datetime in cui il file è stato aggiornato più di recente |
|
URL
|
url | string |
URL accessibile pubblicamente del file |
ResponseOfFileResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of FileResponse | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
FolderResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
accessZoneId
|
accessZoneId | integer | |
|
createdAt
|
createdAt | date-time |
Datetime creazione della cartella |
|
descrizione
|
description | string |
Descrizione della cartella |
|
folderId
|
folderId | Folder |
Rappresentazione JSON di una cartella |
|
folderType
|
folderType | string |
Tipo di cartella |
|
id
|
id | integer |
ID della cartella |
|
isArchive
|
isArchive | boolean |
Stato di archiviazione della cartella |
|
isSystem
|
isSystem | boolean |
Indica se la cartella è gestita dal sistema |
|
nome
|
name | string |
Nome della cartella. Non applicabile per i programmi |
|
parent
|
parent | Folder |
Rappresentazione JSON di una cartella |
|
path
|
path | string |
Percorso della cartella |
|
updatedAt
|
updatedAt | date-time |
Datetime l'ultimo aggiornamento della cartella |
|
URL
|
url | string |
URL della cartella |
|
workspace
|
workspace | string |
Nome dell'area di lavoro |
ResponseOfIdResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of IdResponse | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
Etichette
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
tagType
|
tagType | string |
Nome del tag |
|
tagValue
|
tagValue | string |
Valore del tag |
ResponseOfBrowseAllPrograms
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of BrowseAllPrograms | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
ResponseOfFolderResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of FolderResponse | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
ResponseOfFolderContentResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
errori
|
errors | array of Error | |
|
requestId
|
requestId | string | |
|
risultato
|
result | array of FolderContentResponse | |
|
successo
|
success | boolean | |
|
Avvertenze
|
warnings | array of string |
IdResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID dell'asset |
Costi
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
costo
|
cost | integer |
Importo del costo |
|
nota
|
note | string |
Note sul costo |
|
startDate
|
startDate | date-time |
Data di inizio del costo del periodo |
ProgramFolder
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
type
|
type | string |
Tipo di cartella del programma |
|
value
|
value | integer |
ID della cartella del programma |
|
folderName
|
folderName | string |
Nome della cartella del programma |
Cartella
Rappresentazione JSON di una cartella
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID della cartella |
|
type
|
type | string |
Tipo di cartella |
SmartListRules
Rappresentazione JSON delle regole dell'elenco intelligente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
filterMatchType
|
filterMatchType | string |
Tipo di corrispondenza del filtro elenco intelligente (logica della regola) |
|
Trigger
|
triggers | array of string |
Elenco di trigger dell'elenco intelligente |
|
filters
|
filters | array of SmartListFilters |
Elenco di filtri per elenchi intelligenti |
SmartListFilters
Rappresentazione JSON dei filtri dell'elenco intelligente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID del filtro |
|
nome
|
name | string |
Nome del filtro |
|
ruleTypeId
|
ruleTypeId | integer |
ID del tipo di regola |
|
ruleType
|
ruleType | string |
Nome del tipo di regola |
|
operator
|
operator | string |
Nome dell'operatore |
|
conditions
|
conditions | array of SmartListConditions |
Elenco delle condizioni degli elenchi intelligenti |
SmartListConditions
Rappresentazione JSON delle condizioni dell'elenco intelligente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
activityAttributeId
|
activityAttributeId | integer |
ID dell'attributo dell'attività |
|
activityAttributeName
|
activityAttributeName | string |
Nome dell'attributo di attività |
|
operator
|
operator | string |
Valore dell'operatore |
|
values
|
values | array of string |
Elenco di valori |
|
isPrimary
|
isPrimary | boolean |
Indica se la condizione è primaria o meno (prima condizione dell'elenco intelligente) |
oggetto
Si tratta del tipo 'object'.