Marketo Connector.
Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
No |
Mule Version |
3.7.0 or higher |
Configs
Connector
<marketo:config>
Configuration
Processors
Program | Get Channels
<marketo:get-channels>
Paged Operation
Get Channels.
This function retrieves the following information about a channel set up in Marketo:
- Progression status(es)
- Step number of each progression status
- Whether a specific progression status has been defined as success
XML Sample
<marketo:get-channels config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Channel,MarketoConnector> |
The List of Channels. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-channels/
Program | Get Channel by Name
<marketo:get-channel-by-name>
Returns a channel by its name.
XML Sample
<marketo:get-channel-by-name config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
channelName |
The name of the channel to retrieve. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The requested Channel. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-channel-by-name/
Custom Objects | Describe Custom Objects
<marketo:describe-custom-objects>
DataSense enabled
Allows the caller to retrieve the metadata for a specified custom object.
XML Sample
<marketo:describe-custom-objects config-ref="Marketo" customObjectName="#[flowVars.customObjectName]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
customObjectName |
the name of the custom object |
x |
APIDoc Reference
http://developers.marketo.com/documentation/custom-api/describe-custom-object/
Custom Objects | Create or Update Custom Objects
<marketo:create-or-update-custom-objects>
DataSense enabled
Allows the caller to create, update, or upsert data for specified custom objects.
XML Sample
<marketo:create-or-update-custom-objects config-ref="Marketo" customObjectName="#[flowVars.customObjectName]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
customObjectName |
the name of the custom object |
x |
||
customObjects |
the custom object definitions |
#[payload] |
|
|
actions |
the storage operation. Default: createOrUpdate |
CREATE_OR_UPDATE |
|
|
dedupeBy |
the deduplication method. Only valid if actions is UpdateOnly. Default: dedupeFields |
DEDUPE_FIELDS |
|
Returns
| Return Java Type | Description |
|---|---|
a List of {org.mule.modules.marketo.model.customobject.CustomObject} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/custom-api/createupdateupsert-custom-objects/
Custom Objects | Get List of Custom Objects
<marketo:get-list-of-custom-objects>
Allows the called to retrieve a list of custom object definitions based on a specified search criteria
XML Sample
<marketo:get-list-of-custom-objects config-ref="Marketo">
<marketo:custom-object-names ref="#[flowVars.CustomObjectNamesRef]"/>
</marketo:get-list-of-custom-objects>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
customObjectNames |
list of custom object names. If not specified, then all custom objects are returned |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/custom-api/get-list-of-custom-objects/
Custom Objects | Delete Custom Objects
<marketo:delete-custom-objects>
DataSense enabled
Allows the caller to delete custom objects by dedupe fields or id field
XML Sample
<marketo:delete-custom-objects config-ref="Marketo" key="#[flowVars.key]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
key |
+++the MetaDataKey. Must have the following format: (customObjectName) |
(dedupeBy). DedupeBy can be dedupeFields or idField.+ |
||
x |
criteria |
deletion criteria |
Returns
| Return Java Type | Description |
|---|---|
a List of {org.mule.modules.marketo.model.customobject.CustomObject} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/custom-api/delete-custom-objects/
Custom Objects | Get Custom Objects
<marketo:get-custom-objects>
Paged Operation
DataSense enabled
Allows the caller to retrieve custom objects using specified input parameters
XML Sample
<marketo:get-custom-objects config-ref="Marketo" key="#[flowVars.key]" >
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-custom-objects>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
key |
+++the MetaDataKey. Must have the following format: (customObjectName) |
(filterType). FilterType can be be any of the searchableFields set that has a single field in it.+ |
||
x |
searchValues |
search values |
||
#[payload] |
|
fields |
list of fields to return. If not specified, then contains the following fields: marketoGuid, dedupeFields, updatedAt, createdAt and filterType |
|
|
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/custom-api/get-custom-objects/
Usage and Error Counts | Get Daily Usage
<marketo:get-daily-usage>
Allows the caller to retrieve total and user-level usage count for the day
XML Sample
<marketo:get-daily-usage config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-daily-usage
Usage and Error Counts | Get Last 7 Days Usage
<marketo:get-last7-days-usage>
Allows the caller to retrieve total and user-level usage count for last 7 days
XML Sample
<marketo:get-last7-days-usage config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-last-7-days-usage
Usage and Error Counts | Get Daily Errors
<marketo:get-daily-errors>
Allows the caller to retrieve error codes and their count for the day
XML Sample
<marketo:get-daily-errors config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-daily-errors
Usage and Error Counts | Get Last 7 Days Errors
<marketo:get-last7-days-errors>
Allows the caller to retrieve error codes and their count for the last 7 days
XML Sample
<marketo:get-last7-days-errors config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-last-7-days-errors
Activities | Get Paging Token
<marketo:get-paging-token>
Allows the caller to retrieve a token for a given date
XML Sample
<marketo:get-paging-token config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
sinceDateTime |
the timeframe for your request to the Get Lead Activities or Get Lead Changes APIs. Supported datetime format: "2014-10-06T13:22:17-08:00" "2014-10-06T13:22-07:00" "2014-10-06" |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-paging-token/
Activities | Get Activity Types
<marketo:get-activity-types>
Allows the caller to retrieve metadata about activity types
XML Sample
<marketo:get-activity-types config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-activity-types/
Activities | Get Deleted Leads
<marketo:get-deleted-leads>
Paged Operation
Allows the caller to retrieve a list of leads that were deleted
XML Sample
<marketo:get-deleted-leads config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
nextPageToken |
used to paginate through large result sets |
#[payload] |
|
|
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-deleted-leads/
Activities | Get Lead Changes
<marketo:get-lead-changes>
Paged Operation
Allows the caller to retrieve a list of changed data value for lead
XML Sample
<marketo:get-lead-changes config-ref="Marketo">
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-lead-changes>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
nextPageToken |
used to paginate through large result sets |
#[payload] |
|
|
listId |
the activities for leads with in this given list |
|
||
fields |
the fields to return |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<LeadChanges,MarketoConnector> |
LeadChanges with the call response} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-lead-changes/
Activities | Get Lead Activities
<marketo:get-lead-activities>
Paged Operation
Allows the caller to retrieve activities for the requested activity types
XML Sample
<marketo:get-lead-activities config-ref="Marketo" activityTypeIds-ref="#[flowVars.activityTypeIds]" >
<marketo:lead-ids ref="#[flowVars.LeadIdsRef]"/>
</marketo:get-lead-activities>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
activityTypeIds |
a list of activity type ids (max 10) |
x |
||
nextPageToken |
used to paginate through large result sets |
#[payload] |
|
|
listId |
the activities for leads with in this given list |
|
||
leadIds |
a list of lead IDs |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<LeadActivities,MarketoConnector> |
a List of LeadActivities with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-lead-activities/
Campaigns | Get Campaign By Id
<marketo:get-campaign-by-id>
Allows the caller to retrieve a campaign using a Marketo ID
XML Sample
<marketo:get-campaign-by-id config-ref="Marketo" marketoId="#[flowVars.marketoId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
campaignId |
int |
the campaign ID |
x |
Returns
| Return Java Type | Description |
|---|---|
a Campaign with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-campaign-by-id/
Campaigns | Get Multiple Campaigns
<marketo:get-multiple-campaigns>
Paged Operation
Allows the caller to retrieve multiple campaigns
XML Sample
<marketo:get-multiple-campaigns config-ref="Marketo">
<marketo:names ref="#[flowVars.NamesRef]"/>
<marketo:program-names ref="#[flowVars.ProgramNamesRef]"/>
<marketo:workspace-names ref="#[flowVars.WorkspaceNamesRef]"/>
</marketo:get-multiple-campaigns>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
campaignIds |
the campaigns ids |
|
||
names |
the campaigns names |
#[payload] |
|
|
programNames |
the program names |
|
||
workspaceNames |
the workspaces names |
|
||
nextPageToken |
used to paginate through large result sets |
|
||
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Campaign,MarketoConnector> |
a List of Campaign with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-multiple-campaigns/
Campaigns | Schedule Campaign
<marketo:schedule-campaign>
Allows the caller to schedule a batch Smart Campaign to run either immediately or at a future date
XML Sample
<marketo:schedule-campaign config-ref="Marketo" marketoId="#[flowVars.marketoId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
campaignId |
int |
the campaign ID |
x |
|
runAt |
the time to run the scheduled campaign. If not provided, schedule it to be 5 mins later. |
|
||
cloneToProgramName |
when this attribute is present, the campaign’s parent program will be cloned and the newly created campaign will be scheduled. |
|
||
token |
The name of the token/s you want to send a new value for. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The requested campaign id IdOnlyObject. |
APIDoc Reference
http://developers.marketo.com/documentation/rest/schedule-campaign/
Campaigns | Request Campaign
<marketo:request-campaign>
Allows the user to run an existing Marketo lead in a Marketo Smart Campaign
XML Sample
<marketo:request-campaign config-ref="Marketo" marketoId="#[flowVars.marketoId]" leads-ref="#[flowVars.leads]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
campaignId |
int |
the campaign ID |
x |
|
leads |
a list of lead IDs |
x |
||
tokens |
the name of the token/s you want to send a new value for |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The requested campaign id IdOnlyObject. |
APIDoc Reference
http://developers.marketo.com/documentation/rest/request-campaign/
Assets | Folder | Create Folder
<marketo:create-folder>
Allows the caller to create a folder.
XML Sample
<marketo:create-folder config-ref="Marketo" parent-ref="#[flowVars.parent]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderName |
Name for the folder shown in UI. Name has to be unique under the parent folder. Maximum length 255 characters. |
#[payload] |
|
|
parent |
Parent folder under which the folder will be created. |
x |
||
description |
Description for the folder. Data type: String. Maximum length 2000 characters. |
|
Returns
| Return Java Type | Description |
|---|---|
The Folder that was created. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/create-folder
Assets | Folder | Get Folder by ID
<marketo:get-folder-by-id>
Allows the caller to get a folder or program based on its ID.
XML Sample
<marketo:get-folder-by-id config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderId |
The ID for folder in database. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The requested Folder. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-folder-by-id
Assets | Folder | Get Folder by name
<marketo:get-folder-by-name>
Allows the caller to get a folder or program by name.
XML Sample
<marketo:get-folder-by-name config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderName |
Name of folder in the database. Case insensitive. |
#[payload] |
|
|
type |
Type of folder to retrieve. |
|
||
root |
ID of the parent folder in the database. |
|
||
workSpace |
Workspace that folder belongs to. |
|
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-folder-by-name
Assets | Folder | Get Folder Contents
<marketo:get-folder-contents>
Paged Operation
Allows the caller to get the contents of a folder.
XML Sample
<marketo:get-folder-contents config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderId |
ID and Type of folder to retrieve. |
#[payload] |
|
|
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<FolderContents,MarketoConnector> |
The contents of the folder, as a List of FolderContents. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-folder-contents/
Assets | Folder | Update Folder
<marketo:update-folder>
Allows the caller to update a folder using its ID.
XML Sample
<marketo:update-folder config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderId |
ID and Type of folder to update. |
#[payload] |
|
|
description |
Update folder with this description. Maximum length 2000 characters. |
|
||
newFolderName |
Update folder with this name. Maximum length 255 characters. Must be unique to the workspace. Name cannot be updated for programs. |
|
||
isArchive |
Set to true to archive the folder. If true, then all children folders will be archived as well. |
|
Returns
| Return Java Type | Description |
|---|---|
The updated Folder. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-folder
Assets | Folder | Delete Folder by ID
<marketo:delete-folder-by-id>
Allows the caller to delete a folder by folder ID.
XML Sample
<marketo:delete-folder-by-id config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderId |
ID and Type of folder to be deleted. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The deleted Folder, with only its ID populated. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/delete-folder-by-id
Assets | Folder | Browse Folders
<marketo:browse-folders>
Paged Operation
Allows the caller to get the contents of a folder.
XML Sample
<marketo:browse-folders config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
root |
ID and Type of Root folder in the database. |
#[payload] |
|
|
maxDepth |
Maximum number of levels to inspect in directory hierarchy. Default value is 2 |
|
||
workSpace |
Workspace filter. |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Folder,MarketoConnector> |
The List of Folders inside the root Folder. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/browse-folders
Assets | File | Create file
<marketo:create-file>
Allows the caller to upload a file.
XML Sample
<marketo:create-file config-ref="Marketo" fileName="#[flowVars.fileName]" folder-ref="#[flowVars.folder]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
fileName |
The name of the file to be uploaded. |
x |
||
content |
The content of the file. |
#[payload] |
|
|
folder |
The ID and Type of the parent folder under which the file will be created. |
x |
||
description |
The name of the file to be uploaded. |
|
||
insertOnly |
Sets if existing files are overwritten. |
|
Returns
| Return Java Type | Description |
|---|---|
The created AssetFile. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/create-a-file
Assets | File | Get file by ID
<marketo:get-file-by-id>
Allows the caller to get the contents of a file based on its ID.
XML Sample
<marketo:get-file-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
fileId |
ID of the file to be retrieved. |
x |
Returns
| Return Java Type | Description |
|---|---|
The AssetFile with the given id. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-file-by-id
Assets | Segmentations | Get Segmentations
<marketo:get-segmentations>
Paged Operation
Returns a list of segmentations present in the instance.
XML Sample
<marketo:get-segmentations config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
status |
Optional status filter for segmentations. |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Segmentation,MarketoConnector> |
The List of Segmentations. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-segmentation-by-id/
Assets | Segmentations | Get Segments
<marketo:get-segments>
Paged Operation
Retrieves a list of segments from a parent segmentation.
XML Sample
<marketo:get-segments config-ref="Marketo" segmentationId="#[flowVars.segmentationId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
segmentationId |
int |
ID of the parent segmentation. |
x |
|
status |
Query parameter to filter on draft or approved set of segments. |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Segment,MarketoConnector> |
The List of Segments. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-segments/
Lists | Get Multiple Lists
<marketo:get-multiple-lists>
Paged Operation
Allows the caller to retrieve multiple lists.
XML Sample
<marketo:get-multiple-lists config-ref="Marketo">
<marketo:names ref="#[flowVars.NamesRef]"/>
<marketo:program-names ref="#[flowVars.ProgramNamesRef]"/>
<marketo:workspace-names ref="#[flowVars.WorkspaceNamesRef]"/>
</marketo:get-multiple-lists>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
listIds |
the list of ids |
|
||
names |
the list of names |
#[payload] |
|
|
programNames |
the list of program names |
|
||
workspaceNames |
the list of workspace names |
|
||
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<MarketoList,MarketoConnector> |
a List of MarketoList with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-multiple-lists/
Lists | Get List By Id
<marketo:get-list-by-id>
Allows the caller to retrieve a List by their id
XML Sample
<marketo:get-list-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
listId |
int |
the list id |
x |
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.MarketoList} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-list-by-id/
Assets | File | Get file by name
<marketo:get-file-by-name>
Allows the caller to get the contents of a file based on its name.
XML Sample
<marketo:get-file-by-name config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
fileName |
Name of the file to be retrieved. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The AssetFile with the given name. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-file-by-name
Assets | Tokens | Create Token
<marketo:create-token>
Allows the caller to create custom tokens for a folder or program.
XML Sample
<marketo:create-token config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
token |
The token to create. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The created Token. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/create-token-by-folder-id/
Assets | File | List files
<marketo:get-file-list>
Paged Operation
Allows the caller to get a list of files from a folder.
XML Sample
<marketo:get-file-list config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folder |
ID and Type of folder to retrieve. |
#[payload] |
|
|
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<AssetFile,MarketoConnector> |
The contents of the folder, as a List of AssetFiles. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/list-files
Assets | Tokens | Get Tokens by Folder ID
<marketo:get-token-by-folder-id>
Allows the caller to get tokens for a folder based on the folder ID.
XML Sample
<marketo:get-token-by-folder-id config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folderId |
ID of folder or program. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The List of Tokens. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-tokens-by-folder-id/
Lists | Add Leads To List
<marketo:add-leads-to-list>
Allows the called to add leads to a list
XML Sample
<marketo:add-leads-to-list config-ref="Marketo" listId="#[flowVars.listId]" ids-ref="#[flowVars.ids]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
listId |
int |
the desired list where the leads will be added |
x |
|
leadIds |
the list of lead ids |
x |
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.LeadsList} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/add-leads-to-list/
Assets | File | Update file content
<marketo:update-file>
Allows the caller to replace the content of the file with the given id.
XML Sample
<marketo:update-file config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
fileId |
ID of the file to update. |
x |
||
content |
The new content of the file. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The updated AssetFile. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-channels/
Lists | Remove Leads From List
<marketo:remove-leads-from-list>
Allows the caller to remove a lead from a list
XML Sample
<marketo:remove-leads-from-list config-ref="Marketo" listId="#[flowVars.listId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
listId |
int |
the desired list where the leads will be removed |
x |
|
leadIds |
the list of lead ids |
|
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.LeadsList} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/remove-leads-from-list/
Lists | Member Of List
<marketo:member-of-list>
Allows the caller to find out if leads are a member of a given list
XML Sample
<marketo:member-of-list config-ref="Marketo" listId="#[flowVars.listId]" ids-ref="#[flowVars.ids]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
listId |
int |
the desired list where the leads will be removed |
x |
|
leadIds |
the list of lead ids |
x |
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.LeadsList} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/remove-leads-from-list/
Lists | Import Lead
<marketo:import-lead>
Allows the caller to sync leads in bulk
XML Sample
<marketo:import-lead config-ref="Marketo" file-ref="#[flowVars.file]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
format |
the file format: csv, tst or ssv |
CSV |
|
|
file |
the leads data |
#[payload] |
|
|
lookupField |
the deduplication field |
|
||
listId |
if listId is not specified, this API operation will create temp static list. Workspace for the list is determined whether partitionName is given or not. |
|
||
partitionName |
if specified, this parameter will verify if user has access to the partition. If not specified, this API operation will use primary partition of the list workspace |
|
Returns
| Return Java Type | Description |
|---|---|
a {java.util.List} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/import-lead/
Lists | Get Import Lead Status
<marketo:get-import-lead-status>
Allows the caller to retrieve the status of lead operation from Import Lead call
XML Sample
<marketo:get-import-lead-status config-ref="Marketo" batchId="#[flowVars.batchId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
batchId |
int |
the batch id returned from Import Lead call |
x |
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.LeadStatus} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-import-lead-status/
Lists | Get Import Failure File
<marketo:get-import-failure-file>
Allows the caller to return the failure file from Import Lead call in the same format that was used
XML Sample
<marketo:get-import-failure-file config-ref="Marketo" batchId="#[flowVars.batchId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
batchId |
int |
the batch id returned from Import Lead call |
x |
Returns
| Return Java Type | Description |
|---|---|
a {java.io.File} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-import-failure-file/
Lists | Get Import Warning File
<marketo:get-import-warning-file>
Allows the caller to return the warning file from Import Lead call in the same format that was used
XML Sample
<marketo:get-import-warning-file config-ref="Marketo" batchId="#[flowVars.batchId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
batchId |
int |
the batch id returned from Import Lead call |
x |
Returns
| Return Java Type | Description |
|---|---|
a {java.io.File} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-import-warning-file/
Assets | Tokens | Delete Tokens by Folder ID
<marketo:delete-tokens-by-folder-id>
Allows the caller to delete a token by folder ID.
XML Sample
<marketo:delete-tokens-by-folder-id config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
token |
The token to delete. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The DeletedTokens, containing only their folder IDs. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/delete-tokens-by-folder-id/
Leads | Create Or Update
<marketo:create-or-update-lead>
DataSense enabled
Allows the caller to create new leads within Marketo, or if the lead already exists update it with the submitted values
XML Sample
<marketo:create-or-update-lead config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
the list of lead records to create or update |
#[payload] |
|
|
lookupField |
if specified, will use this attribute to find the duplicate. Otherwise, email will be used for deduplication |
|
||
action |
the action to perform |
CREATE_OR_UPDATE |
|
|
asyncProcessing |
boolean |
this allows you to make call asynchronously. Default is false |
false |
|
partitionName |
lead partition name |
|
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.CreateOrUpdateLead} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/createupdate-leads/
Leads | Delete Lead
<marketo:delete-lead>
Allows the caller to delete leads
XML Sample
<marketo:delete-lead config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
records |
array of lead ids records to delete |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.CreateOrUpdateLead} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/delete-lead/
Leads | Get Lead By Id
<marketo:get-lead-by-id>
Allows the caller to retrieve a single lead using the Lead Id
XML Sample
<marketo:get-lead-by-id config-ref="Marketo" leadId="#[flowVars.leadId]" >
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-lead-by-id>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
leadId |
int |
the id of the lead |
x |
|
fields |
the fields parameter is not included, the following default fields will be returned: email, updatedAt, createdAt, lastName, firstName, and id |
|
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-lead-by-id/
Leads | Get Lead Partitions
<marketo:get-lead-partitions>
Allows the caller to return a list of lead partitions in a Marketo instance
XML Sample
<marketo:get-lead-partitions config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.Partition} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-lead-partitions/
Leads | Describe
<marketo:describe-lead>
Allows the caller to retrieve all fields and the data type of a lead object.
XML Sample
<marketo:describe-lead config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
APIDoc Reference
http://developers.marketo.com/documentation/rest/describe/
Leads | Associate Lead
<marketo:associate-lead>
Allows the caller to associate a lead with a cookie value
XML Sample
<marketo:associate-lead config-ref="Marketo" leadId="#[flowVars.leadId]" cookie="#[flowVars.cookie]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
leadId |
int |
the id of the lead |
x |
|
cookie |
cookie value of lead |
#[payload] |
|
APIDoc Reference
http://developers.marketo.com/documentation/rest/associate-lead/
Leads | Merge Lead
<marketo:merge-lead>
Allows the caller to merge a winning lead and a list of losers leads. When merging leads, the attributes of the winning lead will take precedence.
XML Sample
<marketo:merge-lead config-ref="Marketo" leadId="#[flowVars.leadId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
leadId |
int |
the winner lead id |
x |
|
losingLeadIds |
a list of losers leadId |
#[payload] |
|
|
mergeInCRM |
boolean |
set to true to merge in CRM. Default is false |
false |
|
APIDoc Reference
http://developers.marketo.com/documentation/rest/merge-lead/
Leads | Get Multiple Leads By List Id
<marketo:get-multiple-leads-by-list-id>
Paged Operation
Allows the caller to retrieve multiple leads from a given list id
XML Sample
<marketo:get-multiple-leads-by-list-id config-ref="Marketo" listId="#[flowVars.listId]" >
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-multiple-leads-by-list-id>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
listId |
int |
the id of the list. To retrieve a list id, see getMultipleLists |
x |
|
fields |
the list of fields to return |
|
||
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-multiple-leads-by-list-id
Leads | Get Multiple Leads By Program Id
<marketo:get-multiple-leads-by-program-id>
Paged Operation
Allows the caller to retrieve multiple leads from a given list id
XML Sample
<marketo:get-multiple-leads-by-program-id config-ref="Marketo" programId="#[flowVars.programId]" >
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-multiple-leads-by-program-id>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programId |
int |
the id of the program. |
x |
|
fields |
the list of fields to return |
|
||
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-multiple-leads-by-program-id/
Leads | Get Multiple Leads By Filter Type
<marketo:get-multiple-leads-by-filter-type>
Paged Operation
Allows the caller to retrieve multiple leads for a given search criteria
XML Sample
<marketo:get-multiple-leads-by-filter-type config-ref="Marketo" filterType="#[flowVars.filterType]" >
<marketo:filter-values ref="#[flowVars.FilterValuesRef]"/>
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-multiple-leads-by-filter-type>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
filterType |
one of the Marketo supported filter types |
x |
||
filterValues |
list of filter values |
x |
||
fields |
the list of fields to return |
|
||
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/rest/get-multiple-leads-by-filter-type
Assets | Landing Page Templates | Create Landing Page Template
<marketo:create-landing-page-template>
Allows the caller create Landing Page Template.
XML Sample
<marketo:create-landing-page-template config-ref="Marketo" folder-ref="#[flowVars.folder]" description="#[flowVars.description]" templateType="#[flowVars.templateType]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateName |
Name for the Landing Page Template shown in UI. It has to be unique. Maximum length 255 characters. |
#[payload] |
|
|
folder |
Folder in which the template will be created. Must be Folder for Landing Page Templates. |
x |
||
description |
Description for the template. Maximum length 2000 characters. |
x |
||
templateType |
Type of the template. Expects "freeForm" or "guided" and defaults to freeForm. |
x |
Returns
| Return Java Type | Description |
|---|---|
The created LandingPageTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/create-landing-page-template/
Assets | Landing Page Templates | Get Landing Page Template by ID
<marketo:get-landing-page-template-by-id>
Allows the caller to retrieve Landing Page Template metadata.
XML Sample
<marketo:get-landing-page-template-by-id config-ref="Marketo" id="#[flowVars.id]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the Landing Page Template to retrieve. |
x |
|
status |
Status of template to retrieve. |
x |
Returns
| Return Java Type | Description |
|---|---|
The requested LandingPageTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-landing-page-template-by-id/
Assets | Landing Page Templates | Get Landing Page Template by name
<marketo:get-landing-page-template-by-name>
Allows the caller to retrieve Landing Page Template metadata by Name.
XML Sample
<marketo:get-landing-page-template-by-name config-ref="Marketo" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateName |
The name of the Landing Page Template to retrieve. |
#[payload] |
|
|
status |
Status of template to retrieve. |
x |
Returns
| Return Java Type | Description |
|---|---|
The requested LandingPageTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-landing-page-template-by-name/
Assets | Landing Page Templates | Get multiple Landing Page Templates
<marketo:get-multiple-landing-page-templates>
Paged Operation
Allows the caller to retrieve metadata for multiple Landing Page Templates.
XML Sample
<marketo:get-multiple-landing-page-templates config-ref="Marketo" offset="#[flowVars.offset]" status="#[flowVars.status]" maxReturn="#[flowVars.maxReturn]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
status |
Status of template to retrieve. |
x |
||
folder |
Parent folder to retrieve templates from. Must be a Folder for Landing Page Templates. |
#[payload] |
|
|
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<LandingPageTemplate,MarketoConnector> |
The requested List of LandingPageTemplates. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-multiple-landing-page-templates/
Assets | Landing Page Templates | Get Landing Page Template Content
<marketo:get-landing-page-content>
Allows the caller to retrieve Landing Page Template content.
XML Sample
<marketo:get-landing-page-content config-ref="Marketo" id="#[flowVars.id]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the Landing Page Template to retrieve. |
x |
|
status |
Status of template to retrieve. |
x |
Returns
| Return Java Type | Description |
|---|---|
The LandingPageTemplateContent. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-landing-page-template-content/
Assets | Landing Page Templates | Update Landing Page Template Content by Id
<marketo:update-landing-page-template-content-by-id>
Allows the caller to update the content of a landing page template.
XML Sample
<marketo:update-landing-page-template-content-by-id config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
landingPageTemplateContent |
The ID and content of the Landing Page Template to update. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The UpdatedLandingPageTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-landing-page-template-content-by-id/
Assets | Landing Page Templates | Update Landing Page Template
<marketo:update-landing-page-template>
Allows the caller to update Landing Page Template metadata.
XML Sample
<marketo:update-landing-page-template config-ref="Marketo" id="#[flowVars.id]" templateName="#[flowVars.templateName]" description="#[flowVars.description]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the Landing Page Template to update. |
x |
|
templateName |
Name of the landing page template. |
x |
||
description |
Description of the template. |
x |
Returns
| Return Java Type | Description |
|---|---|
The updated LandingPageTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-landing-page-template/
Leads | Update Leads Partition
<marketo:update-leads-partition>
Allows the caller to update the partition for one or more leads
XML Sample
<marketo:update-leads-partition config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
input |
Array of input object (id and partitionName) |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
a {org.mule.modules.marketo.model.lead.PartitionResponse} with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/rest/update-leads-partition/
Assets | Snippets | Create
<marketo:create-snippet>
Allows the caller to create a snippet.
XML Sample
<marketo:create-snippet config-ref="Marketo" folder-ref="#[flowVars.folder]" description="#[flowVars.description]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetName |
The name of the snippet. Maximum length 100 characters. |
#[payload] |
|
|
folder |
The folder associated with the snippet. |
x |
||
description |
The description of the snippet. Maximum length 2000 characters. |
x |
Returns
| Return Java Type | Description |
|---|---|
a Snippet with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/create-snippet/
Assets | Snippets | Get by ID
<marketo:get-snippet-by-id>
Allows the caller to get a snippet based on its id.
XML Sample
<marketo:get-snippet-by-id config-ref="Marketo" id="#[flowVars.id]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the required snippet. |
x |
|
status |
The status of the snippet. |
x |
Returns
| Return Java Type | Description |
|---|---|
a Snippet with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-snippet-by-id/
Assets | Snippets | Delete by ID
<marketo:delete-snippet>
Allows the caller to delete a snippet by id.
XML Sample
<marketo:delete-snippet config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet to be deleted. |
x |
Returns
| Return Java Type | Description |
|---|---|
a SnippetId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/delete-snippet-by-id/
Assets | Snippets | Update
<marketo:update-snippet-by-id>
Allows the caller to update a snippet using its id.
XML Sample
<marketo:update-snippet-by-id config-ref="Marketo" id="#[flowVars.id]" description="#[flowVars.description]" snippetName="#[flowVars.snippetName]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet to be updated. |
x |
|
description |
The updated description of the snippet. Maximum length 2000 characters. |
|
||
snippetName |
The updated name for the snippet. Maximum length 100 characters. |
|
Returns
| Return Java Type | Description |
|---|---|
a Snippet with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-snippet/
Assets | Snippets | Get list
<marketo:get-snippets>
Paged Operation
Allows the caller to get a list of snippets.
XML Sample
<marketo:get-snippets config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
status |
Snippet status. |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Snippet,MarketoConnector> |
The List of Snippets. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-snippets/
Assets | Snippets | Get content by ID
<marketo:get-snippet-content-by-id>
Allows the caller to get the content of a snippet by its ID.
XML Sample
<marketo:get-snippet-content-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the required snippet content. |
x |
Returns
| Return Java Type | Description |
|---|---|
the List of Snippets. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-snippet-content-by-id/
Assets | Snippets | Update content by ID
<marketo:update-snippet-content-by-id>
Allows the caller to update the content of a snippet by its ID.
XML Sample
<marketo:update-snippet-content-by-id config-ref="Marketo" id="#[flowVars.id]" type="#[flowVars.type]" content="#[flowVars.content]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet which content is to be updated. |
x |
|
type |
The content type of the snippet. |
x |
||
content |
The content of the snippet. |
x |
Returns
| Return Java Type | Description |
|---|---|
a SnippetId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-snippet-content-by-id/
Assets | Snippets | Approve by ID
<marketo:approve-snippet-by-id>
Allows the caller to approve the draft version of a snippet by ID.
XML Sample
<marketo:approve-snippet-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet to be approved. |
x |
Returns
| Return Java Type | Description |
|---|---|
a Snippet with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/approve-snippet-by-id/
Assets | Snippets | Unapprove by ID
<marketo:unapprove-snippet-by-id>
Allows the caller to unapprove a snippet by ID. Note: Disapprove operation can be only on approved snippets.
XML Sample
<marketo:unapprove-snippet-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet to be unapproved. |
x |
Returns
| Return Java Type | Description |
|---|---|
a Snippet with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/unapprove-snippet-by-id/
Assets | Snippets | Disapprove by ID
<marketo:discard-snippet-draft-by-id>
Allows the caller to delete a draft snippet by ID. Note: Snippet must be in draft status to be discarded. An approved snippet cannot be discarded.
XML Sample
<marketo:discard-snippet-draft-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet which draft is to be discarded. |
x |
Returns
| Return Java Type | Description |
|---|---|
a SnippetId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/discard-snippet-draft-by-id/
Assets | Snippets | Clone snippet by ID
<marketo:clone-snippet-by-id>
Allows the caller to clone a snippet by its ID. Note: Creates a clone of approved snippet. If no approved version exists, then the draft version will be cloned.
XML Sample
<marketo:clone-snippet-by-id config-ref="Marketo" id="#[flowVars.id]" snippetName="#[flowVars.snippetName]" folder-ref="#[flowVars.folder]" description="#[flowVars.description]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet to be cloned. |
x |
|
snippetName |
The name of the cloned snippet. |
x |
||
folder |
The folder in which the cloned snippet will be created. |
x |
||
description |
The description of the snippet. |
|
Returns
| Return Java Type | Description |
|---|---|
a Snippet with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/clone-snippet/
Assets | Snippets | Update snippet dynamic content by ID
<marketo:update-snippet-dynamic-content-by-id>
Allows the caller to update the content of a segment that is associated with a snippet.
XML Sample
<marketo:update-snippet-dynamic-content-by-id config-ref="Marketo" id="#[flowVars.id]" segmentId="#[flowVars.segmentId]" type="#[flowVars.type]" value="#[flowVars.value]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet to be updated. |
x |
|
segmentId |
int |
The segment ID associated with the snippet. |
x |
|
type |
The type of the new content. |
|
||
value |
The content for the segment. |
|
Returns
| Return Java Type | Description |
|---|---|
a SnippetId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-snippet-dynamic-content-by-id/
Assets | Snippets | Get snippet dynamic content by ID
<marketo:get-snippet-dynamic-content-by-id>
Allows the caller to get the content of a segment that is associated with a snippet.
XML Sample
<marketo:get-snippet-dynamic-content-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snippetId |
int |
The ID of the snippet which dynamic content will be retrieved. |
x |
Returns
| Return Java Type | Description |
|---|---|
a SnippetId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-snippet-dynamic-content-by-id/
Assets | Email templates | Create email template
<marketo:create-email-template>
Allows the caller to create an email template.
XML Sample
<marketo:create-email-template config-ref="Marketo" emailTemplateName="#[flowVars.emailTemplateName]" folder-ref="#[flowVars.folder]" description="#[flowVars.description]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailTemplateName |
Name of the email template. Must be unique under parent folder. Maximum of 100 characters. |
x |
||
folder |
The ID and Type of the parent folder under which the template will be created. |
x |
||
content |
File containing HTML content for the email. |
#[payload] |
|
|
description |
Description of the template. |
|
Returns
| Return Java Type | Description |
|---|---|
The created EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/create-email-template
Assets | Email templates | Get email template by ID
<marketo:get-email-template-by-id>
Allows the caller to get an email template by its ID.
XML Sample
<marketo:get-email-template-by-id config-ref="Marketo" id="#[flowVars.id]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template. |
x |
|
status |
The status of the template. |
|
Returns
| Return Java Type | Description |
|---|---|
The requested EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-template-by-id
Assets | Email templates | Get email template by name
<marketo:get-email-template-by-name>
Allows the caller to get an email template by its ID.
XML Sample
<marketo:get-email-template-by-name config-ref="Marketo" emailTemplateName="#[flowVars.emailTemplateName]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailTemplateName |
Name of the email template. |
x |
||
status |
The status of the template. |
|
Returns
| Return Java Type | Description |
|---|---|
The requested EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-template-by-name
Assets | Email templates | Get email template by name
<marketo:update-email-template>
Allows the caller to update an email template.
XML Sample
<marketo:update-email-template config-ref="Marketo" id="#[flowVars.id]" description="#[flowVars.description]" emailTemplateName="#[flowVars.emailTemplateName]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template to update. |
x |
|
description |
Updated description for the email template. |
|
||
emailTemplateName |
Updated name for the email template. |
|
Returns
| Return Java Type | Description |
|---|---|
The requested EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-email-template
Assets | Email templates | Delete email template by ID
<marketo:delete-email-template-by-id>
Allows the caller to delete an email template by its ID.
XML Sample
<marketo:delete-email-template-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template to be deleted. |
x |
Returns
| Return Java Type | Description |
|---|---|
An EmailTemplateId with the deleted email template ID. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/delete-email-template-by-id
Assets | Email templates | Get email templates
<marketo:get-email-templates>
Paged Operation
Allows the caller to get a list of email templates.
XML Sample
<marketo:get-email-templates config-ref="Marketo" offset="#[flowVars.offset]" maxReturn="#[flowVars.maxReturn]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
status |
Status of the template to retrieve. |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<EmailTemplate,MarketoConnector> |
The requested List of EmailTemplates. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-templates
Assets | Email templates | Get email template content by ID
<marketo:get-email-template-content-by-id>
Allows the caller to get the content associated with an email template by the template ID.
XML Sample
<marketo:get-email-template-content-by-id config-ref="Marketo" id="#[flowVars.id]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template. |
x |
|
status |
The status of the template. |
|
Returns
| Return Java Type | Description |
|---|---|
The requested EmailTemplateContent. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-template-content-by-id
Assets | Email templates | Update email template content by ID
<marketo:update-email-template-content-by-id>
Allows the caller to update the content of an email template by the template ID.
XML Sample
<marketo:update-email-template-content-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template. |
x |
|
content |
The ID and content of the Landing Page Template to update. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The updated EmailTemplateContent. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-email-template-content-by-id
Assets | Email templates | Approve email template by ID
<marketo:approve-email-template-by-id>
Allows the caller to approve an email template by its ID.
XML Sample
<marketo:approve-email-template-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template. |
x |
Returns
| Return Java Type | Description |
|---|---|
The updated EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/approve-email-template-by-id
Assets | Email templates | Unapprove email template by ID
<marketo:unapprove-email-template-by-id>
Allows the caller to unapprove an email template by its ID.
XML Sample
<marketo:unapprove-email-template-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template. |
x |
Returns
| Return Java Type | Description |
|---|---|
The updated EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/unapprove-email-template-by-id
Assets | Email templates | Discard email template by ID
<marketo:discard-email-template-draft-by-id>
Allows the caller to discard a draft of an email template. Note: The draft version of the template is created after an approved email is updated.
XML Sample
<marketo:discard-email-template-draft-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template to discard. |
x |
Returns
| Return Java Type | Description |
|---|---|
The updated EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/discard-email-template-draft-by-id
Assets | Email templates | Clone email template
<marketo:clone-email-template>
Allows the caller to clone an email template.
XML Sample
<marketo:clone-email-template config-ref="Marketo" id="#[flowVars.id]" emailTemplateName="#[flowVars.emailTemplateName]" folder-ref="#[flowVars.folder]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
templateId |
int |
ID of the email template to clone. |
x |
|
emailTemplateName |
Name of the clone email template. Must be unique under parent folder. Maximum of 100 characters. |
x |
||
folder |
The ID and Type of the parent folder under which the template will be created. |
x |
Returns
| Return Java Type | Description |
|---|---|
The cloned EmailTemplate. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/clone-email-template
Company | Describe Company
<marketo:describe-company>
Allows the caller to retrieve company object metadata.
XML Sample
<marketo:describe-company config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
The EntityDescription. |
APIDoc Reference
http://developers.marketo.com/documentation/company-api/describe-company/
Company | Get Companies
<marketo:get-companies>
Paged Operation
DataSense enabled
Allows the caller to retrieve companies using specified input parameters.
XML Sample
<marketo:get-companies config-ref="Marketo" filterType="#[flowVars.filterType]" >
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-companies>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
filterType |
Can be any one of the searchable fields as indicated by the The #describeOpportunity company call. |
x |
||
filterValues |
List of values corresponding to the field in 'filterType', to use to perform de query. |
#[payload] |
|
|
fields |
List of company fields required. If not specified, the response will contain the following fields: id, dedupeFields, updatedAt, createdAt. |
|
||
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/company-api/get-companies/
Company | Create/Update/Upsert Companies
<marketo:create-update-upsert-companies>
DataSense enabled
Allows the caller to create/update or upsert company object metadata. A maximum of 300 records may be included in an individual call.
XML Sample
<marketo:create-update-upsert-companies config-ref="Marketo" key="#[flowVars.key]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
key |
+++The MetaDataKey. Must have the following format: (action) |
(dedupeBy). Action can be createOnly, updateOnly, or createOrUpdate. DedupeBy can be dedupeFields or idField.+ |
||
x |
inputCompanies |
The Company Object definitions. |
Returns
| Return Java Type | Description |
|---|---|
The List of created/updated/upserted CreateOrUpdateEntity companies. |
APIDoc Reference
http://developers.marketo.com/documentation/company-api/createupdateupsert-companies/
Company | Delete Companies
<marketo:delete-companies>
DataSense enabled
Allows the caller to delete companies by dedupe fields or ID field.
XML Sample
<marketo:delete-companies config-ref="Marketo" deleteBy="#[flowVars.deleteBy]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
deleteBy |
The deletion method. Can be "dedupeFields" or "idField". |
x |
||
criteria |
Deletion criteria. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The List of DeletedEntity deleted companies. |
APIDoc Reference
http://developers.marketo.com/documentation/company-api/delete-companies/
Program | Create Program
<marketo:create-program>
Alows for the creation of a new program.
XML Sample
<marketo:create-program config-ref="Marketo" folder-ref="#[flowVars.folder]" channel="#[flowVars.channel]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
folder |
ID and Type of folder where the program is to be created. |
x |
||
programName |
Name of the new program. This name must be globally unique to the target instance. |
#[payload] |
|
|
type |
Type of program. |
DEFAULT |
|
|
description |
Description of the new program. |
|
||
channel |
The channel of the program. Must be one of the available channels in the target instance. Obtain list of valid channels by calling #getChannels. |
x |
||
tags |
List of tag keys and values for the program. Obtain list of valid tag types by calling #getTags. Obtain list of valid tag values by calling #getTagByName. |
|
||
costs |
List of period costs for the program. |
|
Returns
| Return Java Type | Description |
|---|---|
The created ProgramResponse program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/create-a-program/
Program | Delete Program by ID
<marketo:delete-program-by-id>
Allows deletion of program by Id. Programs can not be deleted if they are referenced by assets outside of the program itself.
XML Sample
<marketo:delete-program-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programId |
int |
ID of the program to delete. |
x |
Returns
| Return Java Type | Description |
|---|---|
The ID of the deleted program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/delete-program-by-id/
Program | Get Program by ID
<marketo:get-program-by-id>
Allows the user to retrieve a ProgramResponse program based on its ID.
XML Sample
<marketo:get-program-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programId |
int |
ID of the program. |
x |
Returns
| Return Java Type | Description |
|---|---|
The requested ProgramResponse program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-program-by-id/
Program | Get Program by Name
<marketo:get-program-by-name>
Allows a user to specify a name parameter to use to retrieve program data.
XML Sample
<marketo:get-program-by-name config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programName |
Name of program to retrieve. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The requested ProgramResponse program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-program-by-name/
Program | Get Program by Tag
<marketo:get-program-by-tag>
Allows a user to specify a Tag (type and value) parameter to use to retrieve program data.
XML Sample
<marketo:get-program-by-tag config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
tag |
Tag type and value to filter on. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The requested List of ProgramResponse programs. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-programs-by-tag-type/
Program | Browse Programs
<marketo:browse-programs>
Paged Operation
Retrieves a list of programs.
XML Sample
<marketo:browse-programs config-ref="Marketo" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
status |
A status filter for Engagement and Email type programs. Can be used to filter on "on," "off," and "unlocked" |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<ProgramResponse,MarketoConnector> |
The List of ProgramResponse programs. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/browse-programs/
Program | Approve Program
<marketo:approve-program>
Allows the caller to approve a program by ID. This operation is only valid for Email Programs.
XML Sample
<marketo:approve-program config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programId |
int |
ID of the program to be approved. |
x |
Returns
| Return Java Type | Description |
|---|---|
The ID of the approved program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/approve-program/
Program | Unapprove Program
<marketo:unapprove-program>
Allows the caller to unapprove a program. This operation is only valid for Email Programs.
XML Sample
<marketo:unapprove-program config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programId |
int |
ID of the program to be unapproved. |
x |
Returns
| Return Java Type | Description |
|---|---|
The ID of the unapproved program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/unapprove-program/
Program | Clone Program
<marketo:clone-program>
Allows to user to clone a program and its underlying assets to a target folder with the designated name and description.
XML Sample
<marketo:clone-program config-ref="Marketo" id="#[flowVars.id]" programName="#[flowVars.programName]" folder-ref="#[flowVars.folder]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programId |
int |
ID of the program to clone. |
x |
|
programName |
Name of the resulting program. Must be globally unique to the target instance. |
x |
||
folder |
Parent folder. May not be in a different workspace from the program being cloned. |
x |
||
description |
Description of the resulting program. |
|
Returns
| Return Java Type | Description |
|---|---|
The cloned ProgramResponse program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/clone-program/
Program | Update Program
<marketo:update-program>
Allows the user to update fields on the target program.
XML Sample
<marketo:update-program config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
programId |
int |
ID of the program to update. |
x |
|
description |
New description for the target program. |
|
||
programName |
New name for the target program. |
|
||
tags |
New set of tags for the target program. |
|
||
costs |
List of period costs for the program. |
|
||
costsDestructiveUpdate |
boolean |
Boolean flag to destroy existing costs and replace them with the included costs. Defaults to false. |
false |
|
Returns
| Return Java Type | Description |
|---|---|
The updated ProgramResponse program. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/update-program/
Opportunity | Describe Opportunity
<marketo:describe-opportunity>
Allows the caller to retrieve opportunity object metadata.
XML Sample
<marketo:describe-opportunity config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
The requested List of Opportunity. |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/describe-opportunity/
Opportunity | Describe Opportunity Role
<marketo:describe-opportunity-role>
Allows the caller to retrieve opportunity role object metadata
XML Sample
<marketo:describe-opportunity-role config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
The requested List of Opportunity. |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/describe-opportunity-role/
Program | Get Tags
<marketo:get-tags>
Paged Operation
Returns a list of all available tags in the target instance.
XML Sample
<marketo:get-tags config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<TagType,MarketoConnector> |
The List of TagType tags. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-tags/
Program | Get Tag by Name
<marketo:get-tag-by-name>
Returns a tag by its name.
XML Sample
<marketo:get-tag-by-name config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
tagName |
The name of the tag to retrieve. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The requested TagType tag. |
APIDoc Reference
http://developers.marketo.com/documentation/programs/get-tag-by-name/
Opportunity | Create Or Update Opportunity
<marketo:create-or-update-opportunity>
DataSense enabled
Allows the caller to create/update or upsert opportunity object metadata.
XML Sample
<marketo:create-or-update-opportunity config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
objectDefinitions |
the Opportunity Object definitions. |
#[payload] |
|
|
action |
the storage operation |
CREATE_OR_UPDATE |
|
|
dedupeBy |
the deduplication method |
DEDUPE_FIELDS |
|
Returns
| Return Java Type | Description |
|---|---|
The requested OpportunityResponse. |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/createupdateupsert-opportunities/
Opportunity | Delete Opportunities
<marketo:delete-opportunities>
DataSense enabled
Allows the caller to delete opportunities by dedupe fields or id field
XML Sample
<marketo:delete-opportunities config-ref="Marketo" deleteBy="#[flowVars.deleteBy]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
searchValues |
the Opportunity Objects search values |
#[payload] |
|
|
deleteBy |
the deletion method |
x |
Returns
| Return Java Type | Description |
|---|---|
The requested OpportunityResponse. |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/delete-opportunities/
Opportunity | Get Opportunities
<marketo:get-opportunities>
Paged Operation
Allows the caller to retrieve opportunities using specified input parameters
XML Sample
<marketo:get-opportunities config-ref="Marketo" filterType="#[flowVars.filterType]" >
<marketo:filter-values ref="#[flowVars.FilterValuesRef]"/>
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-opportunities>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
filterType |
can be any field from searchableFields set |
x |
||
filterValues |
a list of search values |
#[payload] |
|
|
fields |
a list of fields. If not specified, the response will retrieve "marketoGuid", "dedupeFields", "udpatedAt", "createdAt" |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/get-opportunities/
Opportunity | Create Or Update Opportunity Roles
<marketo:create-or-update-opportunity-roles>
DataSense enabled
Allows the caller to create/update or upsert opportunity role object
XML Sample
<marketo:create-or-update-opportunity-roles config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
objectDefinitions |
the Opportunity Role Object definitions |
#[payload] |
|
|
action |
the storage operation |
CREATE_OR_UPDATE |
|
|
dedupeBy |
the deduplication method |
DEDUPE_FIELDS |
|
Returns
| Return Java Type | Description |
|---|---|
The requested OpportunityResponse. |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/createupdateupsert-opportunities-roles/
Sales Person | Describe Sales Person
<marketo:describe-sales-person>
Allows the caller to retrieve all fields and the data type of a sales person object.
XML Sample
<marketo:describe-sales-person config-ref="Marketo"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Returns
| Return Java Type | Description |
|---|---|
The EntityDescription. |
APIDoc Reference
http://developers.marketo.com/documentation/sales-persons/describe-sales-person/
Sales Person | Create/Update/Upsert Sales Persons
<marketo:create-update-upsert-sales-persons>
DataSense enabled
Allows the caller to create/update or upsert sales person objects records. A maximum of 300 records may be included in an individual call.
XML Sample
<marketo:create-update-upsert-sales-persons config-ref="Marketo" key="#[flowVars.key]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
key |
+++The MetaDataKey. Must have the following format: (action) |
(dedupeBy). Action can be createOnly, updateOnly, or createOrUpdate. DedupeBy can be dedupeFields or idField.+ |
||
x |
inputSalesPersons |
The Sales Person Object definitions. |
Returns
| Return Java Type | Description |
|---|---|
The List of created/updated/upserted CreateOrUpdateEntity companies. |
APIDoc Reference
http://developers.marketo.com/documentation/sales-persons/createupdateupsert-sales-persons/
Opportunity | Delete Opportunity Roles
<marketo:delete-opportunity-roles>
DataSense enabled
Allows the caller to delete opportunity by dedupe fields or id field.
XML Sample
<marketo:delete-opportunity-roles config-ref="Marketo" deleteBy="#[flowVars.deleteBy]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
searchValues |
the Opportunity Roles Objects search values |
#[payload] |
|
|
deleteBy |
the deletion method |
x |
Returns
| Return Java Type | Description |
|---|---|
The requested OpportunityResponse. |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/delete-opportunity-roles/
Sales Person | Delete Sales Persons
<marketo:delete-sales-persons>
DataSense enabled
Allows the caller to delete sales persons by dedupe fields or ID field.
XML Sample
<marketo:delete-sales-persons config-ref="Marketo" deleteBy="#[flowVars.deleteBy]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
deleteBy |
The deletion method. Can be "dedupeFields" or "idField". |
x |
||
criteria |
Deletion criteria. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The List of DeletedEntity deleted companies. |
APIDoc Reference
http://developers.marketo.com/documentation/sales-persons/delete-sales-persons/
Opportunity | Get Opportunity Roles
<marketo:get-opportunity-roles>
Paged Operation
Allows the caller to retrieve opportunity roles using specified input parameters
XML Sample
<marketo:get-opportunity-roles config-ref="Marketo" filterType="#[flowVars.filterType]" >
<marketo:filter-values ref="#[flowVars.FilterValuesRef]"/>
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-opportunity-roles>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
filterType |
can be any searchableFields set that has a single field in it |
x |
||
filterValues |
a list of search values |
#[payload] |
|
|
fields |
a list of fields. If not specified, the response will retrieve "marketoGuid", "dedupeFields", "udpatedAt", "createdAt" |
|
||
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/opportunity-api/get-opportunity-roles/
Sales Person | Get Sales Persons
<marketo:get-sales-persons>
Paged Operation
DataSense enabled
Allows the caller to retrieve sales persons using specified input parameters.
XML Sample
<marketo:get-sales-persons config-ref="Marketo" filterType="#[flowVars.filterType]" >
<marketo:fields ref="#[flowVars.FieldsRef]"/>
</marketo:get-sales-persons>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
filterType |
Can be any one of the searchable fields as indicated by the #describeSalesPerson call. |
x |
||
filterValues |
List of values corresponding to the field in 'filterType', to use to perform de query. |
#[payload] |
|
|
fields |
List of sales person fields required. If not specified, the response will contain the following fields: id, dedupeFields, updatedAt, createdAt. |
|
||
pagingConfiguration |
PagingConfiguration |
The PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<Map<String,Object>,MarketoConnector> |
APIDoc Reference
http://developers.marketo.com/documentation/sales-persons/get-sales-persons/
Assets | Email | Create email
<marketo:create-email>
Allows the caller to create an email.
XML Sample
<marketo:create-email config-ref="Marketo" email-ref="#[flowVars.email]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
A POJO with the data of the Email to be created. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
The created EmailResponse. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/create-email
Assets | Email | Get email by ID
<marketo:get-email-by-id>
Allows the caller to get an email based on its ID.
XML Sample
<marketo:get-email-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
The email ID. |
x |
|
status |
The email status. |
|
Returns
| Return Java Type | Description |
|---|---|
The requested EmailResponse. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-by-id
Assets | Email | Delete email by ID
<marketo:delete-email-by-id>
Allows the caller to delete an email by its ID.
XML Sample
<marketo:delete-email-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
ID of the email to be deleted. |
x |
Returns
| Return Java Type | Description |
|---|---|
An EmailId with the deleted email ID. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/delete-email-by-id
Assets | Email | Update email
<marketo:update-email>
Allows the caller to update an email using its ID.
XML Sample
<marketo:update-email config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
ID of the email template to update. |
x |
|
description |
Updated description for the email template. |
|
||
emailName |
Updated name for the email template. |
|
Returns
| Return Java Type | Description |
|---|---|
An EmailId with the updated email ID. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-email
Assets | Email | Get emails
<marketo:get-emails>
Paged Operation
Allows the caller to get a list of emails.
XML Sample
<marketo:get-emails config-ref="Marketo">
<marketo:folder ref="#[flowVars.FolderRef]"/>
</marketo:get-emails>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
status |
Email status. |
|
||
folder |
The folder under which the search is performed. |
#[payload] |
|
|
pagingConfiguration |
PagingConfiguration |
the PagingConfiguration object with the needed parameters for paged queries. |
x |
Returns
| Return Java Type | Description |
|---|---|
ProviderAwarePagingDelegate<EmailResponse,MarketoConnector> |
The List of EmailResponses. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-emails
Assets | Email | Get email content by ID
<marketo:get-email-content-by-id>
Allows the caller to get the content associated with an email by its ID.
XML Sample
<marketo:get-email-content-by-id config-ref="Marketo" id="#[flowVars.id]" status="#[flowVars.status]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
ID of the email. |
x |
|
status |
The status of the template. |
|
Returns
| Return Java Type | Description |
|---|---|
The requested EmailContent. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-content-by-id
Assets | Email | Update email content by ID
<marketo:update-email-content-by-id>
Allows the caller to update an email's content by id.
XML Sample
<marketo:update-email-content-by-id config-ref="Marketo" id="#[flowVars.id]" >
<marketo:subject ref="#[flowVars.SubjectRef]"/>
<marketo:from-email ref="#[flowVars.FromEmailRef]"/>
<marketo:from-name ref="#[flowVars.FromNameRef]"/>
<marketo:reply-to ref="#[flowVars.ReplyToRef]"/>
</marketo:update-email-content-by-id>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
ID of the email. |
x |
|
subject |
The subject for the email. |
|
||
fromEmail |
The from address for the email. |
|
||
fromName |
The from name for the email. |
|
||
replyTo |
The reply email address for the email. |
|
Returns
| Return Java Type | Description |
|---|---|
An EmailId with the updated email ID. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-email-content-by-id
Assets | Email | Update email content in editable section
<marketo:update-email-content-in-editable-section>
Allows the caller to associate static or dynamic content to a given editable section of an email.
XML Sample
<marketo:update-email-content-in-editable-section config-ref="Marketo" id="#[flowVars.id]" htmlId="#[flowVars.htmlId]" type="#[flowVars.type]" value-ref="#[flowVars.value]" textValue="#[flowVars.textValue]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
ID of the email. |
x |
|
htmlId |
The HTML ID of the editable section. |
x |
||
type |
The type of the editable section. |
|
||
value |
Depends of the type of the specified editable section: - Text: A String containing the HTML content. - DynamicContent: An Integer with the ID of the segmentation. - Snippet: An Integer with the ID of the snippet. |
|
||
textValue |
The text content if the type is text. |
|
Returns
| Return Java Type | Description |
|---|---|
An EmailId with the updated email ID. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-email-content-in-editable-section/
Assets | Email | Get email dynamic content by ID
<marketo:get-email-dynamic-content-by-id>
Allows the caller to associate static or dynamic content to a given editable section of an email.
XML Sample
<marketo:get-email-dynamic-content-by-id config-ref="Marketo" id="#[flowVars.id]" dynamicContentId="#[flowVars.dynamicContentId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
ID of the email. |
x |
|
dynamicContentId |
ID of the dynamic content. |
#[payload] |
|
Returns
| Return Java Type | Description |
|---|---|
An EmailId with the updated email ID. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-dynamic-content-by-id/
Assets | Email | Update email dynamic content by ID
<marketo:update-email-dynamic-content-by-id>
Allows the caller to create or update a section of the dynamic content of an email by segment ID.
XML Sample
<marketo:update-email-dynamic-content-by-id config-ref="Marketo" id="#[flowVars.id]" dynamicContentId="#[flowVars.dynamicContentId]" segment="#[flowVars.segment]" value="#[flowVars.value]" type="#[flowVars.type]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
The ID of the email to be updated. |
x |
|
dynamicContentId |
The segment ID associated with the email. |
#[payload] |
|
|
segment |
The segment name. |
|
||
value |
The content for the segment. |
|
||
type |
The type of the new content. |
x |
Returns
| Return Java Type | Description |
|---|---|
a EmailId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/update-email-dynamic-content-by-id/
Assets | Email | Approve by ID
<marketo:approve-email-by-id>
Allows the caller to approve the draft version of an email by ID.
XML Sample
<marketo:approve-email-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
The ID of the email to be approved. |
x |
Returns
| Return Java Type | Description |
|---|---|
an EmailId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/approve-email-by-id
Assets | Email | Unapprove by ID
<marketo:unapprove-email-by-id>
Allows the caller to unapprove an email by ID. Note: Disapprove operation can only be used on approved emails.
XML Sample
<marketo:unapprove-email-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
The ID of the email to be unapproved. |
x |
Returns
| Return Java Type | Description |
|---|---|
a EmailResponse with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/unapprove-email-by-id
Assets | Email | Discard draft by ID
<marketo:discard-email-draft-by-id>
Allows the caller to delete a draft email by ID. Note: Email must be in draft status to be discarded. An approved email cannot be discarded but, you can discard an approved email that was modified after approval and hence you will have an email approved with draft state.
XML Sample
<marketo:discard-email-draft-by-id config-ref="Marketo" id="#[flowVars.id]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
The ID of the email which draft is to be discarded. |
x |
Returns
| Return Java Type | Description |
|---|---|
a EmailId with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/discard-email-draft-by-id/
Assets | Email | Clone email by ID
<marketo:clone-email-by-id>
Allows the caller to clone an email by its ID. Note: Creates a clone of approved email. If no approved version exists, then the draft version will be cloned.
XML Sample
<marketo:clone-email-by-id config-ref="Marketo" id="#[flowVars.id]" emailName="#[flowVars.emailName]" folder-ref="#[flowVars.folder]" description="#[flowVars.description]" isOperational="#[flowVars.isOperational]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
The ID of the email to be cloned. |
x |
|
emailName |
The name of the cloned email. |
#[payload] |
|
|
folder |
The folder in which the cloned email will be created. |
x |
||
description |
The description of the email. |
|
||
isOperational |
Indicates if this is an operational email. Default: false. |
|
Returns
| Return Java Type | Description |
|---|---|
a EmailResponse with the call response |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/clone-email
Assets | File | Get email by name
<marketo:get-email-by-name>
Allows the caller to get an email by name.
XML Sample
<marketo:get-email-by-name config-ref="Marketo" emailName="#[flowVars.emailName]" status="#[flowVars.status]" folder-ref="#[flowVars.folder]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailName |
Name of the email to be retrieved. |
#[payload] |
|
|
status |
The email status. |
|
||
folder |
The parent folder of the email. |
|
Returns
| Return Java Type | Description |
|---|---|
The EmailResponse with the given name. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/get-email-by-name
Assets | File | Send sample email
<marketo:send-sample-email>
Allows the caller to send a sample email to a given address.
XML Sample
<marketo:send-sample-email config-ref="Marketo" id="#[flowVars.id]" emailAddress="#[flowVars.emailAddress]" textOnly="#[flowVars.textOnly]" leadId="#[flowVars.leadId]" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
emailId |
int |
The ID of the email to be sent. |
x |
|
emailAddress |
The email address to receive the sample email. |
#[payload] |
|
|
textOnly |
Sends the text version of the sample in addition to the HTML version. Default is false. |
|
||
leadId |
The lead id. If specified, then the token values for the lead are populated when the email is sent. |
|
Returns
| Return Java Type | Description |
|---|---|
The EmailId with the sent email. |
APIDoc Reference
http://developers.marketo.com/documentation/asset-api/send-sample-email/