Marketo MA (Preview)

Reference

Marketo Marketing Automation. This API provides access to Marketo objects such as Campaigns, Programs, Leads, Lists (Static and Smart) as well as filesystem assets such as files and folders.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD)
Power Automate	Standard	All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Standard	All Power Apps regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Marketo Developer Relations
URL	http://developers.marketo.com
Email	[email protected]

Connector Metadata
Publisher	Microsoft Inc.
Website	https://www.marketo.com/
Privacy policy	https://documents.marketo.com/legal/privacy/
Terms of service	https://go.microsoft.com/fwlink/?linkid=2237005
Categories	Marketing;Sales and CRM

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
MunchkinID	string	Your Marketo MunchkinID (see Admin page)	True
Client ID	string	Client ID	True
Client Secret	securestring	Client Secret	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add to List	Adds a given set of person records to a target static list. There is a limit of 300 lead ids per request. Required Permissions: Read-Write Lead
Approve Program	Approves the target program. Only valid for unapproved email programs. Required Permissions: Read-Write Assets
Cancel Export Lead Job	Cancel export job. Required Permissions: Read-Only Lead
Cancel Export Program Member Job	Cancel export job. Required Permissions: Read-Only Lead
Clone Program	Clones the target program. Required Permissions: Read-Write Assets
Clone Smart List	Clones the designated Smart List. Required Permissions: Read-Write Asset
Create Export Lead Job	Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Leads endpoints. Use Enqueue Export Lead Job endpoint to queue the export job for processing. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
Create Export Program Member Job	Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Program Members endpoints.
Create File	Creates a new file from the included payload. Required Permissions: Read-Write Assets
Create Folder	Creates a new folder. Required Permissions: Read-Write Assets
Create Program	Creates a new program. Required Permissions: Read-Write Assets
Create Static List	Creates a new Static List. Required Permissions: Read-Write Assets
Delete Folder	Deletes the designated folder. Deletion will fail if the folder has content. Required Permissions: Read-Write Assets
Delete Leads	Delete a list of leads from the destination instance. Required Permissions: Read-Write Lead
Delete Program	Deletes the target program. The program may not contain any assets which are in use outside the program. Required Permissions: Read-Write Assets
Delete Program Members	Delete a list of members from the destination instance. Required Permissions: Read-Write Lead
Delete Program Tag	Delete non-required program tag. Required Permissions: Read-Write Assets
Delete Smart List	Deletes the designated Smart List. Required Permissions: Read-Write Asset
Delete Static List	Deletes the designated Static List. Required Permissions: Read-Write Asset
Describe Lead	Returns metadata about lead objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead Note: This endpoint has been superceded. Use Describe Lead2 endpoint instead.
Describe Lead2	Returns list of searchable fields on lead objects in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead
Describe Program Member	Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead Note: This endpoint has been superceded. Use Describe Program Member endpoint instead.
Describe Program Member	Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead
Enqueue Export Lead Job	Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
Enqueue Export Program Member Job	Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state.
Get Campaign By Id	Returns the record of a campaign by its id. Required Permissions: Read-Only Campaigns, Read-Write Campaigns Note: This endpoint has been superceded. Use Get Smart Campaign by Id endpoint instead.
Get Campaigns	Returns a list of campaign records. Required Permissions: Read-Only Campaigns, Read-Write Campaigns Note: This endpoint has been superceded. Use Get Smart Campaigns endpoint instead.
Get Export Lead File	Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead The file format is specified by calling the Create Export Lead Job endpoint. The following is an example of the default file format ("CSV"). `firstName,lastName,email` `Marvin,Gaye,[email protected]`
Get Export Lead Job Status	Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead
Get Export Lead Jobs	Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead
Get Export Program Member File	Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead The file format is specified by calling the Create Export Program Member Job endpoint. The following is an example of the default file format ("CSV"). `firstName,lastName,email` `Marvin,Gaye,[email protected]`
Get Export Program Member Job Status	Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead
Get Export Program Member Jobs	Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead
Get File by Id	Returns the file record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Get File by Name	Returns files records for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Get Files	Returns the files from the given folder. Required Permissions: Read-Only Assets, Read-Write Assets
Get Folder by Id	Returns the folder record with the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Get Folder by Name	Returns a folder record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Get Folder Contents	Returns records for the contents of a given folder. Required Permissions: Read-Only Assets, Read-Write Assets
Get Folders	Retrieves child folders from within a given root folder. Required Permissions: Read-Only Assets, Read-Write Assets
Get Import Lead Failures	Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead
Get Import Lead Status	Returns the status of an import batch job. Required Permissions: Read-Write Lead
Get Import Lead Warnings	Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead
Get Import Program Member Failures	Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead
Get Import Program Member Status	Returns the status of an import batch job. Required Permissions: Read-Write Lead
Get Import Program Member Warnings	Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead
Get Lead by Id	Retrieves a single lead record through its Marketo id. Required Permissions: Read-Only Lead, Read-Write Lead
Get Lead Field by Name	Retrieves metadata for single lead field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Get Leads by Filter Type	Returns a list of up to 300 leads based on a list of values in a particular field. Required Permissions: Read-Only Lead, Read-Write Lead
Get Leads By List Id	Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead
Get Leads By List Id	Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead
Get Leads by Program Id	Retrieves a list of leads which are members of the designated program. Required Permissions: Read-Only Lead, Read-Write Lead
Get List by Id	Returns a list record by its id. Required Permissions: Read-Only Lead, Read-Write Lead
Get Lists	Returns a set of static list records based on given filter parameters. Required Permissions: Read-Only Lead, Read-Write Lead
Get Program by Id	Retrieves the program record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets
Get Program by Name	Retrieves the program record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets
Get Program Member Field by Name	Retrieves metadata for single program member field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Get Program Members	Returns a list of up to 300 program members on a list of values in a particular field. If you specify a filterType that is a custom field, the custom field’s dataType must be either “string” or “integer”. If you specify a filterType other than “leadId”, a maximum of 100,000 program member records can be processed by the request. Required Permissions: Read-Only Lead, Read-Write Lead
Get Programs	Retrieves the list of accessible programs from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets
Get Programs by Tag	Retrieves a list of programs matching the tag type and tag values given. Required Permissions: Read-Only Assets, Read-Write Assets
Get Smart List by Id	Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset
Get Smart List by Name	Retrieves a Smart List record by its name. Required Permissions: Read-Asset or Read-Write Asset
Get Smart List by Program Id	Retrieves a Smart List record by its Email Program id. Required Permissions: Read-Asset or Read-Write Asset
Get Smart Lists	Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset
Get Static List by Id	Retrieves a Static List record by its id. Required Permissions: Read-Asset or Read-Write Asset
Get Static List by Name	Retrieves a Static List record by its name. Required Permissions: Read-Asset or Read-Write Asset
Get Static Lists	Retrieves a list of Static List records. Required Permissions: Read-Asset or Read-Write Asset
Identity	Retrieve an access token from Marketo. Calls to this endpoint are not counted towards API call limit.
Identity	Retrieve an access token from Marketo. Calls to this endpoint are not counted towards API call limit.
Import Leads	Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead
Import Program Members	Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead
Member of List	Checks if leads are members of a given static list. Required Permissions: Read-Write Lead
Push Lead to Marketo	Upserts a lead and generates a Push Lead to Marketo activity. Required Permissions: Read-Write Lead
Remove from List	Removes a given set of person records from a target static list. Required Permissions: Read-Write Lead
Request Campaign	Passes a set of leads to a trigger campaign to run through the campaign's flow. The designated campaign must have a Campaign is Requested: Web Service API trigger, and must be active. My tokens local to the campaign's parent program can be overridden for the run to customize content. A maximum of 100 leads are allowed per call. Required Permissions: Execute Campaign
Schedule Campaign	Remotely schedules a batch campaign to run at a given time. My tokens local to the campaign's parent program can be overridden for the run to customize content. When using the "cloneToProgramName" parameter described below, this endpoint is limited to 20 calls per day. Required Permissions: Execute Campaign
Sync Leads	Syncs a list of leads to the target instance. Required Permissions: Read-Write Lead
Sync Program Member Data	Changes the program member data of a list of leads in a target program. Only existing members of the program may have their data changed with this API. Required Permissions: Read-Write Lead
Sync Program Member Status	Changes the program member status of a list of leads in a target program. If member is not part of the program, member is added to the program. Required Permissions: Read-Write Lead
Unapprove Program	Unapproves the target program. Only valid for approved email programs. Required Permissions: Read-Write Assets
Update File Content	Replaces the current content of the file with the included payload. Required Permissions: Read-Write Assets
Update Folder Metadata	Updates the metadata for a given folder. Required Permissions: Read-Write Assets
Update Lead Field	Update metadata for a lead field in the target instance. See update rules here. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Update Program Metadata	Updates the target program's metadata. Required Permissions: Read-Write Assets
Update Program Tag	Update program tag. Required Permissions: Read-Write Assets
Update Static List Metadata	Updates the metadata of a static list asset. Required Permissions: Read-Write Assets

Add to List

Operation ID:: addLeadsToListUsingPOST

Adds a given set of person records to a target static list. There is a limit of 300 lead ids per request. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of target list	listId	True	integer	Id of target list
id	id	True	integer	Unique integer id of a lead record
Comma-separated list of lead ids to add to the list	id		array	Comma-separated list of lead ids to add to the list

Returns

Body: ResponseOfListOperationOutputData

Approve Program

Operation ID:: approveProgramUsingPOST

Approves the target program. Only valid for unapproved email programs. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id

Returns

Body: ResponseOfIdResponse

Cancel Export Lead Job

Operation ID:: cancelExportLeadsUsingPOST

Cancel export job. Required Permissions: Read-Only Lead

Parameters

Name	Key	Required	Type	Description
Id of export batch job.	exportId	True	string	Id of export batch job.

Returns

Body: ResponseOfExportResponse

Cancel Export Program Member Job

Operation ID:: cancelExportProgramMembersUsingPOST

Cancel export job. Required Permissions: Read-Only Lead

Parameters

Name	Key	Required	Type	Description
Id of export batch job.	exportId	True	string	Id of export batch job.

Returns

Body: ResponseOfExportResponse

Clone Program

Operation ID:: cloneProgramUsingPOST

Clones the target program. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id
description	description		string
id	id	True	integer	Id of the folder
type	type	True	string	Type of folder
name	name	True	string	Name of the program. Max 255 characters

Returns

Body: ResponseOfProgramResponse

Clone Smart List

Operation ID:: cloneSmartListUsingPOST

Clones the designated Smart List. Required Permissions: Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Id of smart list to clone	id	True	integer	Id of smart list to clone
name	name	True	string	Name for the cloned smart list
id	id	True	integer	Id of the folder
type	type	True	string	Type of folder
description	description		string	Description of the cloned smart list

Returns

Body: ResponseOfSmartListResponse

Create Export Lead Job

Operation ID:: createExportLeadsUsingPOST

Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Leads endpoints. Use Enqueue Export Lead Job endpoint to queue the export job for processing. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead

Parameters

Name	Key	Required	Type	Description
name	name	True	string	REST API name for header field
value	value	True	string	Value for header field
fields	fields	True	array of string	Comma-separated list of fields to include in the file
endAt	endAt		string	End of date range filter (ISO 8601-format)
startAt	startAt		string	Start of date range filter (ISO-8601 format)
smartListId	smartListId	True	integer	Id of smart list to retrieve leads from
smartListName	smartListName	True	string	Name of smart list to retrieve leads from
staticListId	staticListId	True	integer	Id of static list to retrieve leads from
staticListName	staticListName	True	string	Name of static list to retrieve leads from
format	format		string	File format to create("CSV", "TSV", "SSV"). Default is "CSV"

Returns

Body: ResponseOfExportResponse

Create Export Program Member Job

Operation ID:: createExportProgramMembersUsingPOST

Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Program Members endpoints.

Parameters

Name	Key	Required	Type	Description
name	name	True	string	REST API name for header field
value	value	True	string	Value for header field
fields	fields	True	array of string	Comma-separated list of fields to include in the file
programId	programId	True	integer	Id of program to retrieve members from. Cannot be used in combination with "programIds" filter
programIds	programIds	True	array of integer	Array of program ids to retrieve members from. Cannot be used in combination with "programId" filter
isExhausted	isExhausted		boolean	Filter program membership records for people who have exhausted content
nurtureCadence	nurtureCadence		string	Filter program membership records for a given nurture cadence
statusNames	statusNames		array of string	Array of program member status names. Can be default and/or user-defined. Multiple status names are ORed together.
endAt	endAt		string	End of date range filter (ISO 8601-format)
startAt	startAt		string	Start of date range filter (ISO-8601 format)
format	format		string	File format to create("CSV", "TSV", "SSV"). Default is "CSV"

Returns

Body: ResponseOfExportResponse

Create File

Operation ID:: createFileUsingPOST

Creates a new file from the included payload. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
description	description		string	Description of the asset
file	file	True	string	Multipart file. Content of the file.
id	id	True	integer	Id of the folder
type	type	True	string	Type of folder
insertOnly	insertOnly		boolean	Whether the calls hould fail if there is already an existing file with the same name
name	name	True	string	Name of the File

Returns

Body: ResponseOfFileResponse

Create Folder

Operation ID:: createFolderUsingPOST

Creates a new folder. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
description	description		string	Description of the asset
name	name	True	string	Name of the Folder
id	id	True	integer	Id of the folder
type	type	True	string	Type of folder

Returns

Body: ResponseOfFolderResponse

Create Program

Operation ID:: createProgramUsingPOST

Creates a new program. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
channel	channel	True	string	Channel of the program
cost	cost	True	integer	Amount of the cost
note	note		string	Notes on the cost
startDate	startDate	True	date-time	Start date of the period cost
description	description		string
id	id	True	integer	Id of the folder
type	type	True	string	Type of folder
name	name	True	string	Name of the program
tagType	tagType		string	Type of program tag
tagValue	tagValue		string	Value of the tag
type	type	True	string	Type of the program

Returns

Body: ResponseOfProgramResponse

Create Static List

Operation ID:: createStaticListUsingPOST

Creates a new Static List. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
description	description		string	Description of the static list
name	name	True	string	Name of the static list
id	id	True	integer	Id of the folder
type	type	True	string	Type of folder

Returns

Body: ResponseOfStaticListResponse

Delete Folder

Operation ID:: deleteFolderUsingPOST

Deletes the designated folder. Deletion will fail if the folder has content. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
Id of the folder to delete	id	True	integer	Id of the folder to delete
type of folder	type	True	string	type

Returns

Body: ResponseOfIdResponse

Delete Leads

Operation ID:: deleteLeadsUsingPOST

Delete a list of leads from the destination instance. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
id	id	True	integer	Unique integer id of a lead record
Parameter can be specified if the request body is empty.	id		array	Parameter can be specified if the request body is empty. Multiple lead ids can be specified. e.g. id=1,2,3,2342

Returns

Body: ResponseOfLead

Delete Program

Operation ID:: deleteProgramUsingPOST

Deletes the target program. The program may not contain any assets which are in use outside the program. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id

Returns

Body: ResponseOfIdResponse

Delete Program Members

Operation ID:: deleteProgramMemberUsingPOST

Delete a list of members from the destination instance. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
The id of target program.	programId	True	integer	The id of target program.
leadId	leadId	True	integer	Unique integer id of a lead record

Returns

Body: ResponseOfProgramMemberDelete

Delete Program Tag

Operation ID:: deleteProgramTagUsingPOST

Delete non-required program tag. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id
Type of program tag	tagType	True	string	Type of program tag

Returns

Body: ResponseOfIdResponse

Delete Smart List

Operation ID:: deleteSmartListByIdUsingPOST

Deletes the designated Smart List. Required Permissions: Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Id of the smart list to delete	id	True	integer	Id of the smart list to delete

Returns

Body: ResponseOfIdResponse

Delete Static List

Operation ID:: deleteStaticListByIdUsingPOST

Deletes the designated Static List. Required Permissions: Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Id of the static list to delete	id	True	integer	Id of the static list to delete

Returns

Body: ResponseOfIdResponse

Describe Lead

Operation ID:: describeUsingGET_2

Returns metadata about lead objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead

Note: This endpoint has been superceded. Use Describe Lead2 endpoint instead.

Returns

Body: ResponseOfLeadAttribute

Describe Lead2

Operation ID:: describeUsingGET_6

Returns list of searchable fields on lead objects in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead

Returns

Body: ResponseOfLeadAttribute2

Describe Program Member

Operation ID:: describeProgramMemberUsingGET

Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead

Note: This endpoint has been superceded. Use Describe Program Member endpoint instead.

Returns

Body: ResponseOfProgramMemberAttributes

Describe Program Member

Operation ID:: describeProgramMemberUsingGET2

Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead

Returns

Body: ResponseOfProgramMemberAttributes2

Enqueue Export Lead Job

Operation ID:: enqueueExportLeadsUsingPOST

Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead

Parameters

Name	Key	Required	Type	Description
Id of export batch job.	exportId	True	string	Id of export batch job.

Returns

Body: ResponseOfExportResponse

Enqueue Export Program Member Job

Operation ID:: enqueueExportProgramMembersUsingPOST

Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state.

Parameters

Name	Key	Required	Type	Description
Id of batch job.	exportId	True	string	Id of export batch job.

Returns

Body: ResponseOfExportResponse

Get Campaign By Id

Operation ID:: getCampaignByIdUsingGET

Returns the record of a campaign by its id. Required Permissions: Read-Only Campaigns, Read-Write Campaigns

Note: This endpoint has been superceded. Use Get Smart Campaign by Id endpoint instead.

Parameters

Name	Key	Required	Type	Description
campaignId	campaignId	True	integer	campaignId

Returns

Body: ResponseOfCampaign

Get Campaigns

Operation ID:: getCampaignsUsingGET

Returns a list of campaign records. Required Permissions: Read-Only Campaigns, Read-Write Campaigns

Note: This endpoint has been superceded. Use Get Smart Campaigns endpoint instead.

Parameters

Name	Key	Type	Description
Comma-separated list of campaign ids to return records for	id	array	Comma-separated list of campaign ids to return records for
Comma-separated list of names to filter on	name	array	Comma-separated list of names to filter on
Comma-separated list of program names to filter on.	programName	array	Comma-separated list of program names to filter on. If set, will filter to only campaigns which are children of the designated programs.
Comma-separated list of workspace names to filter on.	workspaceName	array	Comma-separated list of workspace names to filter on. If set, will only return campaigns in the given workspaces.
Maximum number of records to return. Maximum and default is 300.	batchSize	integer	Maximum number of records to return. Maximum and default is 300.
A token will be returned by this endpoint. See Paging Tokens for more info.	nextPageToken	string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.
if is Requested trigger and source is Web Service API	isTriggerable	boolean	Set to true to return active Campaigns which have a Campaign is Requested trigger and source is Web Service API

Returns

Body: ResponseOfCampaign

Get Export Lead File

Operation ID:: getExportLeadsFileUsingGET

Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead

The file format is specified by calling the Create Export Lead Job endpoint. The following is an example of the default file format ("CSV").

firstName,lastName,email
Marvin,Gaye,[email protected]

Parameters

Name	Key	Required	Type	Description
Id of export batch job.	exportId	True	string	Id of export batch job.
To support partial retrieval of extracted data	Range		string	To support partial retrieval of extracted data, the HTTP header "Range" of type "bytes" may be specified. See RFC 2616 "Range Retrieval Requests" for more information. If the header is not set, the entire contents will be returned.

Returns

response: object

Get Export Lead Job Status

Operation ID:: getExportLeadsStatusUsingGET

Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead

Parameters

Name	Key	Required	Type	Description
Id of export batch job.	exportId	True	string	Id of export batch job.

Returns

Body: ResponseOfExportResponse

Get Export Lead Jobs

Operation ID:: getExportLeadsUsingGET

Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead

Parameters

Name	Key	Type	Description
Comma separated list of statuses to filter on.	status	array	Comma separated list of statuses to filter on.
The batch size to return. The max and default value is 300.	batchSize	integer	The batch size to return. The max and default value is 300.
The next page token	nextPageToken	string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfExportResponseWithToken

Get Export Program Member File

Operation ID:: getExportProgramMembersFileUsingGET

Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead

The file format is specified by calling the Create Export Program Member Job endpoint. The following is an example of the default file format ("CSV").

firstName,lastName,email
Marvin,Gaye,[email protected]

Parameters

Name	Key	Required	Type	Description
Id of export batch job.	exportId	True	string	Id of export batch job.
To support partial retrieval of extracted data.	Range		string	To support partial retrieval of extracted data, the HTTP header "Range" of type "bytes" may be specified. See RFC 2616 "Range Retrieval Requests" for more information. If the header is not set, the entire contents will be returned.

Returns

response: object

Get Export Program Member Job Status

Operation ID:: getExportProgramMembersStatusUsingGET

Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead

Parameters

Name	Key	Required	Type	Description
Id of export batch job.	exportId	True	string	Id of export batch job.

Returns

Body: ResponseOfExportResponse

Get Export Program Member Jobs

Operation ID:: getExportProgramMembersUsingGET

Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead

Parameters

Name	Key	Type	Description
Comma separated list of statuses to filter on.	status	array	Comma separated list of statuses to filter on.
The batch size to return. The max and default value is 300.	batchSize	integer	The batch size to return. The max and default value is 300.
Will be returned by this endpoint if result set is greater than batch size.	nextPageToken	string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfExportResponseWithToken

Get File by Id

Operation ID:: getFileByIdUsingGET

Returns the file record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
The id of the file	id	True	integer	Id for file in database

Returns

Body: ResponseOfFileResponse

Get File by Name

Operation ID:: getFileByNameUsingGET

Returns files records for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
The name of the file	name	True	string	Name of the file

Returns

Body: ResponseOfFileResponse

Get Files

Operation ID:: getFilesUsingGET

Returns the files from the given folder. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
id	id	True	integer	Id of the folder
type	type	True	string	Type of folder
maxReturn	maxReturn		integer	Maximum number of channels to return. Max 200, default 20
offset	offset		integer	Integer offset for paging
The folder where to put the file	folder		string	JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'

Returns

Body: ResponseOfFileResponse

Get Folder by Id

Operation ID:: getFolderByIdUsingGET

Returns the folder record with the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
The id of the folder to retrieve	id	True	integer	Id of the folder to retrieve
The type of the folder (Program or Folder)	type	True	string	Type of folder. 'Folder' or 'Program'

Returns

Body: ResponseOfFolderResponse

Get Folder by Name

Operation ID:: getFolderByNameUsingGET

Returns a folder record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
The name of the folder	name	True	string	Name of the folder. Not applicable for Programs
The type of the folder (Program or Folder)	type		string	Type of folder. 'Folder' or 'Program'
The parent folder reference	root		string	Parent folder reference
The name of the workspace	workSpace		string	Name of the workspace

Returns

Body: ResponseOfFolderResponse

Get Folder Contents

Operation ID:: getFolderContentUsingGET

Returns records for the contents of a given folder. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
Id of the folder to retrieve	id	True	integer	Id of the folder to retrieve
Maximum number of channels to return. Max 200, default 20	maxReturn		integer	Maximum number of channels to return. Max 200, default 20
Integer offset for paging	offset		integer	Integer offset for paging
Type of folder. 'Folder' or 'Program'. Default is 'Folder'	type	True	string	Type of folder. 'Folder' or 'Program'. Default is 'Folder'

Returns

Body: ResponseOfFolderContentResponse

Get Folders

Operation ID:: getFolderUsingGET

Retrieves child folders from within a given root folder. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Type	Description
Parent folder reference	root	string	Parent folder reference
Maximum folder depth to traverse, Default 2	maxDepth	integer	Maximum folder depth to traverse, Default 2
Maximum number of folders to return. Default 20, maximum 200	maxReturn	integer	Maximum number of folders to return. Default 20, maximum 200
Integer offset for paging. Default 0	offset	integer	Integer offset for paging. Default 0
Name of the workspace	workSpace	string	Name of the workspace

Returns

Body: ResponseOfFolderResponse

Get Import Lead Failures

Operation ID:: getImportLeadFailuresUsingGET

Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the import batch job.	batchId	True	integer	Id of the import batch job.

Returns

response: object

Get Import Lead Status

Operation ID:: getImportLeadStatusUsingGET

Returns the status of an import batch job. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the import batch job.	batchId	True	integer	Id of the import batch job.

Returns

Body: ResponseOfImportLeadResponse

Get Import Lead Warnings

Operation ID:: getImportLeadWarningsUsingGET

Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the import batch job.	batchId	True	integer	Id of the import batch job.

Returns

response: object

Get Import Program Member Failures

Operation ID:: getImportProgramMemberFailuresUsingGET

Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the import batch job.	batchId	True	integer	Id of the import batch job.

Returns

response: object

Get Import Program Member Status

Operation ID:: getImportProgramMemberStatusUsingGET

Returns the status of an import batch job. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the import batch job.	batchId	True	integer	Id of the import batch job.

Returns

Body: ResponseOfImportProgramMemberResponse

Get Import Program Member Warnings

Operation ID:: getImportProgramMemberWarningsUsingGET

Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the import batch job.	batchId	True	integer	Id of the import batch job.

Returns

response: object

Get Lead by Id

Operation ID:: getLeadByIdUsingGET

Retrieves a single lead record through its Marketo id. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Required	Type	Description
The Marketo lead id	leadId	True	integer	The Marketo lead id
Comma separated list of field names.	fields		array	Comma separated list of field names. If omitted, the following default fields will be returned: email, updatedAt, createdAt, lastName, firstName, and id.

Returns

Body: ResponseOfLead

Get Lead Field by Name

Operation ID:: getLeadFieldByNameUsingGET

Retrieves metadata for single lead field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field

Parameters

Name	Key	Required	Type	Description
The API name of lead field	fieldApiName	True	string	The API name of lead field

Returns

Body: ResponseOfLeadField

Get Leads by Filter Type

Operation ID:: getLeadsByFilterUsingGET

Returns a list of up to 300 leads based on a list of values in a particular field. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Required	Type	Description
The lead field to filter on.	filterType	True	string	The lead field to filter on. Any custom field (string, email, or integer types only), and any of the following fields are supported: cookies, email, facebookId, id, leadPartitionId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId, twitterId. A comprehensive list of fields can be obtained via the Describe Lead2 endpoint.
A comma-separated list of values to filter on in the specified fields.	filterValues	True	array	A comma-separated list of values to filter on in the specified fields.
A comma-separated list of lead fields to return for each record	fields		array	A comma-separated list of lead fields to return for each record
The batch size to return. The max and default value is 300.	batchSize		integer	The batch size to return. The max and default value is 300.
A token will be returned by this endpoint. See Paging Tokens for more info.	nextPageToken		string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfLead

Get Leads By List Id

Operation ID:: getLeadsByListIdUsingGET_1

Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the static list to retrieve records from	listId	True	integer	Id of the static list to retrieve records from
Comma-separated list of lead fields to return for each record.	fields		array	Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id
The batch size to return. The max and default value is 300.	batchSize		integer	The batch size to return. The max and default value is 300.
A token will be returned by this endpoint. See Paging Tokens for more info.	nextPageToken		string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfLead

Get Leads By List Id

Operation ID:: getLeadsByListIdUsingGET

Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the static list to retrieve records from	listId	True	integer	Id of the static list to retrieve records from
Comma-separated list of lead fields to return for each record.	fields		array	Comma-separated list of lead fields to return for each record. If unset will return email, updatedAt, createdAt, lastName, firstName and id
The batch size to return. The max and default value is 300.	batchSize		integer	The batch size to return. The max and default value is 300.
A token will be returned by this endpoint. See Paging Tokens for more info.	nextPageToken		string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfLeadByListId

Get Leads by Program Id

Operation ID:: getLeadsByProgramIdUsingGET

Retrieves a list of leads which are members of the designated program. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Required	Type	Description
The id of the program to retrieve from	programId	True	integer	The id of the program to retrieve from
A comma-separated list of fields to be returned for each record	fields		array	A comma-separated list of fields to be returned for each record
The batch size to return. The max and default value is 300.	batchSize		integer	The batch size to return. The max and default value is 300.
A token will be returned by this endpoint. See Paging Tokens for more info.	nextPageToken		string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfLead

Get List by Id

Operation ID:: getListByIdUsingGET

Returns a list record by its id. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the static list to retrieve records from	listId	True	integer	Id of the static list to retrieve records from

Returns

Body: ResponseOfStaticList

Get Lists

Operation ID:: getListsUsingGET

Returns a set of static list records based on given filter parameters. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Type	Description
Comma-separated list of static list ids to return	id	array	Comma-separated list of static list ids to return
Comma-separated list of static list names to return	name	array	Comma-separated list of static list names to return
Comma-separated list of program names.	programName	array	Comma-separated list of program names. If set will return all static lists that are children of the given programs
Comma-separated list of workspace names.	workspaceName	array	Comma-separated list of workspace names. If set will return all static lists that are children of the given workspaces
The batch size to return. The max and default value is 300.	batchSize	integer	The batch size to return. The max and default value is 300.
A token will be returned by this endpoint. See Paging Tokens for more info.	nextPageToken	string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfStaticList

Get Program by Id

Operation ID:: getProgramByIdUsingGET

Retrieves the program record for the given id. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id

Returns

Body: ResponseOfProgramResponse

Get Program by Name

Operation ID:: getProgramByNameUsingGET

Retrieves the program record for the given name. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
Name of the program	name	True	string	Name of the program
Set true to populate program tags	includeTags		boolean	Set true to populate program tags
Set true to populate program costs	includeCosts		boolean	Set true to populate program costs

Returns

Body: ResponseOfProgramResponse

Get Program Member Field by Name

Operation ID:: getProgramMemberFieldByNameUsingGET

Retrieves metadata for single program member field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field

Parameters

Name	Key	Required	Type	Description
The API name of program member field	fieldApiName	True	string	The API name of program member field

Returns

Body: ResponseOfLeadField

Get Program Members

Operation ID:: getProgramMembersUsingGET

Returns a list of up to 300 program members on a list of values in a particular field. If you specify a filterType that is a custom field, the custom field’s dataType must be either “string” or “integer”. If you specify a filterType other than “leadId”, a maximum of 100,000 program member records can be processed by the request. Required Permissions: Read-Only Lead, Read-Write Lead

Parameters

Name	Key	Required	Type	Description
The id of target program.	programId	True	integer	The id of target program.
The program member field to filter.	filterType	True	string	The program member field to filter on. Any custom field (string or integer types only), "updatedAt", or any searchable field. Searchable fields can be obtained via the Describe Program Member endpoint.
A comma-separated list of values to filter on in the specified fields.	filterValues	True	array	A comma-separated list of values to filter on in the specified fields.
When using filterType=updatedAt, the start of date range filter	startAt		string	When using filterType=updatedAt, the start of date range filter (ISO 8601-format)
When using filterType=updatedAt, the end of date range filter	endAt		string	When using filterType=updatedAt, the end of date range filter (ISO 8601-format)
A comma-separated list of lead fields to return for each record.	fields		array	A comma-separated list of lead fields to return for each record.
The batch size to return. The max and default value is 300.	batchSize		integer	The batch size to return. The max and default value is 300.
A token will be returned by if result set is greater than batch size.	nextPageToken		string	A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

Returns

Body: ResponseOfProgramMember

Get Programs

Operation ID:: browseProgramsUsingGET

Retrieves the list of accessible programs from the target instance. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Type	Description
Maximum number of channels to return. Max 200, default 20	maxReturn	integer	Maximum number of channels to return. Max 200, default 20
Integer offset for paging	offset	integer	Integer offset for paging
Optional filter. Requires filterValues	filterType	string	Optional filter. Requires filterValues
Exclude programs prior to this date. See Datetime field type description.	earliestUpdatedAt	string	Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
Exclude programs after this date. See Datetime field type description.	latestUpdatedAt	string	Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.

Returns

Body: ResponseOfBrowseAllPrograms

Get Programs by Tag

Operation ID:: getProgramListByTagUsingGET

Retrieves a list of programs matching the tag type and tag values given. Required Permissions: Read-Only Assets, Read-Write Assets

Parameters

Name	Key	Required	Type	Description
Type of program tag	tagType	True	string	Type of program tag
Value of the tag	tagValue	True	string	Value of the tag
Maximum number of channels to return. Max 200, default 20	maxReturn		integer	Maximum number of channels to return. Max 200, default 20
Integer offset for paging	offset		integer	Integer offset for paging

Returns

Body: ResponseOfProgramResponse

Get Smart List by Id

Operation ID:: getSmartListByIdUsingGET

Retrieves a Smart List record by its id. Required Permissions: Read-Asset or Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Id of the smart list to retrieve	id	True	integer	Id of the smart list to retrieve
Set true to populate smart list rules. Default false	includeRules		boolean	Set true to populate smart list rules. Default false

Returns

Body: ResponseOfSmartListResponseWithRules

Get Smart List by Name

Operation ID:: getSmartListByNameUsingGET

Retrieves a Smart List record by its name. Required Permissions: Read-Asset or Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Name of smart list to retrieve	name	True	string	Name of smart list to retrieve

Returns

Body: ResponseOfSmartListResponse

Get Smart List by Program Id

Operation ID:: getSmartListByProgramIdUsingGET

Retrieves a Smart List record by its Email Program id. Required Permissions: Read-Asset or Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Id for the email program containing smart list to retrieve	programId	True	integer	Id for the email program containing smart list to retrieve
Set true to populate smart list rules. Default false	includeRules		boolean	Set true to populate smart list rules. Default false

Returns

Body: ResponseOfSmartListResponseWithRules

Get Smart Lists

Operation ID:: getSmartListsUsingGET

Retrieves a list of user created Smart List records. Required Permissions: Read-Asset or Read-Write Asset

Parameters

Name	Key	Type	Description
JSON representation of parent folder	folder	string	JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
Integer offset for paging	offset	integer	Integer offset for paging
Maximum number of smart lists to return. Max 200, default 20.	maxReturn	integer	Maximum number of smart lists to return. Max 200, default 20.
Exclude smart lists prior to this date. See Datetime field type description.	earliestUpdatedAt	string	Exclude smart lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
Exclude smart lists after this date. See Datetime field type description.	latestUpdatedAt	string	Exclude smart lists after this date. Must be valid ISO-8601 string. See Datetime field type description.

Returns

Body: ResponseOfSmartListResponse

Get Static List by Id

Operation ID:: getStaticListByIdUsingGET

Retrieves a Static List record by its id. Required Permissions: Read-Asset or Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Id of the static list to retrieve	id	True	integer	Id of the static list to retrieve

Returns

Body: ResponseOfStaticListResponse

Get Static List by Name

Operation ID:: getStaticListByNameUsingGET

Retrieves a Static List record by its name. Required Permissions: Read-Asset or Read-Write Asset

Parameters

Name	Key	Required	Type	Description
Name of static list to retrieve	name	True	string	Name of static list to retrieve

Returns

Body: ResponseOfStaticListResponse

Get Static Lists

Operation ID:: getStaticListsUsingGET

Retrieves a list of Static List records. Required Permissions: Read-Asset or Read-Write Asset

Parameters

Name	Key	Type	Description
JSON representation of parent folder	folder	string	JSON representation of parent folder, with members 'id', and 'type' which may be 'Folder' or 'Program'
Integer offset for paging	offset	integer	Integer offset for paging
Maximum number of static lists to return. Max 200, default 20.	maxReturn	integer	Maximum number of static lists to return. Max 200, default 20.
Exclude static lists prior to this date. See Datetime field type description.	earliestUpdatedAt	string	Exclude static lists prior to this date. Must be valid ISO-8601 string. See Datetime field type description.
Exclude static lists after this date. See Datetime field type description.	latestUpdatedAt	string	Exclude static lists after this date. Must be valid ISO-8601 string. See Datetime field type description.

Returns

Body: ResponseOfStaticListResponse

Identity

Operation ID:: identityUsingGET

Retrieve an access token from Marketo. Calls to this endpoint are not counted towards API call limit.

Parameters

Name	Key	Required	Type	Description
The clientID for the Marketo REST API	client_id	True	string	Client ID from Admin > Integration > Launchpoint menu.
The client secret for the Marketo REST API	client_secret	True	string	Client Secret from Admin > Integration > Launchpoint menu.
The type of grant. Our case client credentials	grant_type	True	string	Grant type.

Returns

Body: ResponseOfIdentity

Identity

Operation ID:: identityUsingPOST

Retrieve an access token from Marketo. Calls to this endpoint are not counted towards API call limit.

Parameters

Name	Key	Required	Type	Description
The clientID for the Marketo REST API	client_id	True	string	Client ID from Admin > Integration > Launchpoint menu.
The client secret for the Marketo REST API	client_secret	True	string	Client Secret from Admin > Integration > Launchpoint menu.
The type of grant. Our case client credentials	grant_type	True	string	Grant type.

Returns

Body: ResponseOfIdentity

Import Leads

Operation ID:: importLeadUsingPOST

Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Import file format.	format	True	string	Import file format.
Field to use for deduplication. Custom fields (string, email, integer)	lookupField		string	Field to use for deduplication. Custom fields (string, email, integer), and the following field types are supported: id, cookies, email, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, sfdcLeadOwnerId, sfdcOpptyId. Default is email. Note: You can use id for update only operations.
Name of the lead partition to import to.	partitionName		string	Name of the lead partition to import to.
Id of the static list to import into.	listId		integer	Id of the static list to import into.
File containing the data records to import.	file	True	file	File containing the data records to import.

Returns

Body: ResponseOfImportLeadResponse

Import Program Members

Operation ID:: importProgramMemberUsingPOST

Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the program to add members to.	programId	True	string	Id of the program to add members to.
Program member status for members being added.	programMemberStatus	True	string	Program member status for members being added.
Import file format.	format	True	string	Import file format.
File containing the data records to import.	file	True	file	File containing the data records to import.

Returns

Body: ResponseOfImportProgramMemberResponse

Member of List

Operation ID:: areLeadsMemberOfListUsingGET

Checks if leads are members of a given static list. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of the static list to check against	listId	True	integer	Id of the static list to check against
id	id	True	integer	Unique integer id of a lead record
Comma-separated list of lead ids to check	id		array	Comma-separated list of lead ids to check

Returns

Body: ResponseOfListOperationOutputData

Push Lead to Marketo

Operation ID:: pushToMarketoUsingPOST

Upserts a lead and generates a Push Lead to Marketo activity. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
id	id		integer	Unique integer id of a lead record
code	code	True	string	Integer code of the reason
message	message	True	string	Message describing the reason for the status of the operation
status	status		string	Status of the operation performed on the record
lookupField	lookupField		string
partitionName	partitionName		string
programName	programName		string
programStatus	programStatus		string
reason	reason		string
source	source		string

Returns

Body: ResponseOfPushLeadToMarketo

Remove from List

Operation ID:: removeLeadsFromListUsingDELETE

Removes a given set of person records from a target static list. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
Id of static list to remove leads from	listId	True	integer	Id of static list to remove leads from
id	id	True	integer	Unique integer id of a lead record
id	id	True	array	id

Returns

Body: ResponseOfListOperationOutputData

Request Campaign

Operation ID:: triggerCampaignUsingPOST

Passes a set of leads to a trigger campaign to run through the campaign's flow. The designated campaign must have a Campaign is Requested: Web Service API trigger, and must be active. My tokens local to the campaign's parent program can be overridden for the run to customize content. A maximum of 100 leads are allowed per call. Required Permissions: Execute Campaign

Parameters

Name	Key	Required	Type	Description
The id of the campaign to trigger	campaignId	True	integer	The id of the campaign to trigger
id	id	True	integer	Unique integer id of a lead record
name	name	True	string	Name of the token. Should be formatted as "{{my.name}}"
value	value	True	string	Value of the token

Returns

Body: ResponseOfCampaign

Schedule Campaign

Operation ID:: scheduleCampaignUsingPOST

Remotely schedules a batch campaign to run at a given time. My tokens local to the campaign's parent program can be overridden for the run to customize content. When using the "cloneToProgramName" parameter described below, this endpoint is limited to 20 calls per day. Required Permissions: Execute Campaign

Parameters

Name	Key	Required	Type	Description
Id of the batch campaign to schedule.	campaignId	True	integer	Id of the batch campaign to schedule.
cloneToProgramName	cloneToProgramName		string	Name of the resulting program. When set, this attribute will cause the campaign, parent program, and all of its assets, to be created with the resulting new name. The parent program will be cloned and the newly created campaign will be scheduled. The resulting program is created underneath the parent. Programs with snippets, push notifications, in-app messages, static lists, reports, and social assets may not be cloned in this way
runAt	runAt		date-time	Datetime to run the campaign at. If unset, the campaign will be run five minutes after the call is made
name	name	True	string	Name of the token. Should be formatted as "{{my.name}}"
value	value	True	string	Value of the token

Returns

Body: ResponseOfCampaign

Sync Leads

Operation ID:: syncLeadUsingPOST

Syncs a list of leads to the target instance. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
action	action		string	Type of sync operation to perform. Defaults to createOrUpdate if unset
asyncProcessing	asyncProcessing		boolean	If set to true, the call will return immediately
id	id		integer	Unique integer id of a lead record
acquiredBy	acquiredBy		boolean	Whether the lead was acquired by the parent program
isExhausted	isExhausted		boolean	Whether the lead is currently exhausted in the stream, if applicable
membershipDate	membershipDate	True	string	Date the lead first became a member of the program
nurtureCadence	nurtureCadence		string	Cadence of the parent stream if applicable
progressionStatus	progressionStatus	True	string	Program status of the lead in the parent program
reachedSuccess	reachedSuccess		boolean	Whether the lead is in a success-status in the parent program
stream	stream		string	Stream that the lead is a member of, if the parent program is an engagement program
code	code	True	string	Integer code of the reason
message	message	True	string	Message describing the reason for the status of the operation
status	status		string	Status of the operation performed on the record
lookupField	lookupField		string	Field to deduplicate on. The field must be present in each lead record of the input. Defaults to email if unset
partitionName	partitionName		string	Name of the partition to operate on, if applicable. Should be set whenever possible, when interacting with an instance where partitions are enabled.

Returns

Body: ResponseOfLead

Sync Program Member Data

Operation ID:: syncProgramMemberDataUsingPOST

Changes the program member data of a list of leads in a target program. Only existing members of the program may have their data changed with this API. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
The id of target program.	programId	True	integer	The id of target program.
leadId	leadId	True	integer	Unique integer id of a lead record
{fieldApiName}	{fieldApiName}	True	string	API Name of field to update. Must be updateable as described by Describe Program Member endpoint.
{fieldApiName2}	{fieldApiName2}		string	API Name of another field to update (and so forth). Must be updateable as described by Describe Program Member endpoint.

Returns

Body: ResponseOfProgramMemberData

Sync Program Member Status

Operation ID:: syncProgramMemberStatusUsingPOST

Changes the program member status of a list of leads in a target program. If member is not part of the program, member is added to the program. Required Permissions: Read-Write Lead

Parameters

Name	Key	Required	Type	Description
The id of target program.	programId	True	integer	The id of target program.
statusName	statusName	True	string	Program member status
leadId	leadId	True	integer	Unique integer id of a lead record

Returns

Body: ResponseOfProgramMemberStatus

Unapprove Program

Operation ID:: unapproveProgramUsingPOST

Unapproves the target program. Only valid for approved email programs. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id

Returns

Body: ResponseOfIdResponse

Update File Content

Operation ID:: updateContentUsingPOST

Replaces the current content of the file with the included payload. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
The id of the file	id	True	integer	Id for file in database
file	file	True	string	Multipart file. Content of the file.
id	id	True	integer	Id of the file

Returns

Body: ResponseOfFileResponse

Update Folder Metadata

Operation ID:: updateFolderUsingPOST

Updates the metadata for a given folder. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
The id of the folder to update	id	True	integer	Id of the folder to update
description	description		string	Description of the asset
isArchive	isArchive		boolean	Whether the folder is archived or not. Toggling this value will change the archival status of the folder
name	name		string	Name of the Folder
type	type	True	string	Type of folder. 'Folder' or 'Program'

Returns

Body: ResponseOfFolderResponse

Update Lead Field

Operation ID:: updateLeadFieldUsingPOST

Update metadata for a lead field in the target instance. See update rules here. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field

Parameters

Name	Key	Required	Type	Description
The API name of lead field	fieldApiName	True	string	The API name of lead field
displayName	displayName		string	UI display-name of the field
description	description		string	Description of the field
isHidden	isHidden		boolean	If set to true, the field is hidden. Default is false
isHtmlEncodingInEmail	isHtmlEncodingInEmail		boolean	If set to true, field is encoded as HTML in email. Default is true
isSensitive	isSensitive		boolean	If set to true, field is marked as sensitive. Default is false

Returns

Body: ResponseOfUpdateLeadField

Update Program Metadata

Operation ID:: updateProgramUsingPOST

Updates the target program's metadata. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id
cost	cost	True	integer	Amount of the cost
note	note		string	Notes on the cost
startDate	startDate	True	date-time	Start date of the period cost
costsDestructiveUpdate	costsDestructiveUpdate		boolean	Set true to destroy existing costs and replace them with the specified costs
description	description		string	Updated description for the program
endDate	endDate		string	End date of the program. Applicable to event, email, and webinar type programs
name	name		string	Name of the program
startDate	startDate		string	Start date of program. Applicable to event, email and webinar type programs
tagType	tagType		string	Type of program tag
tagValue	tagValue		string	Value of the tag

Returns

Body: ResponseOfProgramResponse

Update Program Tag

Operation ID:: updateProgramTagUsingPOST

Update program tag. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
program id	id	True	integer	id
Type of program tag	tagType	True	string	Type of program tag
Value of program tag	tagValue	True	string	Value of program tag

Returns

Body: ResponseOfIdResponse

Update Static List Metadata

Operation ID:: updateStaticListUsingPOST

Updates the metadata of a static list asset. Required Permissions: Read-Write Assets

Parameters

Name	Key	Required	Type	Description
Id of static list to update	id	True	integer	Id of static list to update
description	description		string	Description of the static list
name	name		string	Name of the static list

Returns

Body: ResponseOfStaticListResponse

Definitions

ResponseOfIdentity

Name	Path	Type	Description
access_token	access_token	string	The token that you pass with subsequent calls to authenticate with the target instance
scope	scope	string	The owning API-only user of the custom service that was used to authenticate
expires_in	expires_in	integer	Remaining lifespan of the current token in seconds
token_type	token_type	string	The OAuth authentication method

ResponseOfStaticList

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of StaticList	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

Lead

Lead record. Always contains id, but may have any number of other fields, depending on the fields available in the target instance.

Name	Path	Type	Description
id	id	integer	Unique integer id of a lead record
membership	membership	ProgramMembership
reason	reason	Reason
status	status	string	Status of the operation performed on the record

LeadField

Lead field record

Name	Path	Type	Description
displayName	displayName	string	UI display-name of the field
name	name	string	API name of the field
description	description	string	Description of the field
dataType	dataType	string	Datatype of the field
length	length	integer	Max length of the field. Only applicable to text, string, and text area.
isHidden	isHidden	boolean	If set to true, the field is hidden
isHtmlEncodingInEmail	isHtmlEncodingInEmail	boolean	If set to true, field is encoded as HTML in email
isSensitive	isSensitive	boolean	If set to true, field is marked as sensitive
isCustom	isCustom	boolean	If set to true, field is custom
isApiCreated	isApiCreated	boolean	If set to true, field was created using REST API

LeadFieldStatus

Lead field update status

Name	Path	Type	Description
name	name	string	API name of the field
status	status	string	Status of the operation performed on the record

ListOperationOutputData

Name	Path	Type	Description
id	id	integer	Unique integer id of a lead record
reasons	reasons	array of Reason	List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted
status	status	string	Status of the operation performed on the record

LeadAttribute

Name	Path	Type	Description
dataType	dataType	string	Datatype of the field
displayName	displayName	string	UI display-name of the field
id	id	integer	Unique integer id of the field
length	length	integer	Max length of the field. Only applicable to text, string, and text area.
rest	rest	LeadMapAttribute
soap	soap	LeadMapAttribute

LeadAttribute2

Name	Path	Type	Description
name	name	string	"API Lead"
searchableFields	searchableFields	array of LeadAttribute2SearchableFields	List of searchable fields
fields	fields	array of LeadAttribute2Fields	Description of searchable fields

LeadAttribute2SearchableFields

List of searchable fields

Name	Path	Type	Description
Items		string	Searchable field

LeadAttribute2Fields

Name	Path	Type	Description
name	name	string	REST API name of field
displayName	displayName	string	Display name of field (friendly name)
dataType	dataType	string	Data type of field
length	length	integer	Length of field
updateable	updateable	boolean	Is field updateable
crmManaged	crmManaged	boolean	Is field managed by CRM

LeadAttribute2Fields2

Name	Path	Type	Description
name	name	string	REST API name of field
displayName	displayName	string	Display name of field (friendly name)
dataType	dataType	string	Data type of field
length	length	integer	Length of field
updateable	updateable	boolean	Is field updateable
crmManaged	crmManaged	boolean	Is field managed by CRM

ProgramMemberAttribute

Name	Path	Type	Description
name	name	string	"API Program Member"
fields	fields	array of LeadAttribute2Fields	Description of searchable fields

ProgramMemberAttribute2

Name	Path	Type	Description
name	name	string	"API Program Member"
description	description	string	"API Program Member Map"
createdAt	createdAt	string	Datetime when created
updatedAt	updatedAt	string	Datetime updated
dedupeFields	dedupeFields	array of string	List of dedupe fields
searchableFields	searchableFields	array of LeadAttribute2SearchableFields	List of searchable fields
fields	fields	array of LeadAttribute2Fields2	Description of searchable fields

ResponseOfImportLeadResponse

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ImportLeadResponse	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ImportProgramMemberResponse

Response containing import status information

Name	Path	Type	Description
batchId	batchId	integer	Unique integer id of the import job
importId	importId	string	Unique integer id of the import job
status	status	string	Status of the import job

ResponseOfImportProgramMemberResponse

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
requestId	requestId	string	Id of the request made
result	result	array of ImportProgramMemberResponse	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfCampaign

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of Campaign	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfListOperationOutputData

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ListOperationOutputData	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

Campaign

Record of a Marketo Smart Campaign

Name	Path	Type	Description
active	active	boolean	Whether the campaign is active. Only applicable to trigger campaigns
createdAt	createdAt	string	Datetime when the campaign was created
description	description	string	Description of the Smart Campaign
id	id	integer	Unique integer id of the Smart Campaign
name	name	string	Name of the Smart Campaign
programId	programId	integer	Id of the parent program if applicable
programName	programName	string	Name of the parent program if applicable
type	type	string	Type of the Smart Campaign
updatedAt	updatedAt	string	Datetime when the campaign was most recently updated
workspaceName	workspaceName	string	Name of the parent workspace if applicable

ResponseOfLead

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of Lead	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfLeadByListId

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of Lead	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfLeadField

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of LeadField	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfUpdateLeadField

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of LeadFieldStatus	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfPushLeadToMarketo

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
requestId	requestId	string	Id of the request made
result	result	array of Lead	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfLeadAttribute

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of LeadAttribute	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfLeadAttribute2

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of LeadAttribute2	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfProgramMemberAttributes

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ProgramMemberAttribute	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfProgramMemberAttributes2

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ProgramMemberAttribute2	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

Warning

Name	Path	Type	Description
code	code	integer	Integer code of the warning
message	message	string	Message describing the warning

ResponseOfExportResponse

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
requestId	requestId	string	Id of the request made
result	result	array of ExportResponse	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfExportResponseWithToken

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ExportResponse	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfProgramMember

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ProgramMember	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ProgramMember

Program member record. Always contains lead id, but may have any number of other fields, depending on the fields available in the target instance.

Name	Path	Type	Description
seq	seq	integer	Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.
leadId	leadId	integer	Unique integer id of a lead record
reachedSuccess	reachedSuccess	boolean	Boolean indicating if program member has reached success criteria for program
programId	programId	integer	Unique integer id of a program
acquiredBy	acquiredBy	boolean	Boolean indicating if program member was acquired by program
membershipDate	membershipDate	string	Date the lead first became a member of the program

ResponseOfProgramMemberStatus

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ProgramMemberStatusResponse	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfProgramMemberData

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ProgramMemberStatusResponse	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ResponseOfProgramMemberDelete

Name	Path	Type	Description
errors	errors	array of Error	Array of errors that occurred if the request was unsuccessful
moreResult	moreResult	boolean	Boolean indicating if there are more results in subsequent pages
nextPageToken	nextPageToken	string	Paging token given if the result set exceeded the allowed batch size
requestId	requestId	string	Id of the request made
result	result	array of ProgramMemberDeleteResponse	Array of results for individual records in the operation, may be empty
success	success	boolean	Whether the request succeeded
warnings	warnings	array of Warning	Array of warnings given for the operation

ImportLeadResponse

Response containing import status information

Name	Path	Type	Description
batchId	batchId	integer	Unique integer id of the import batch
importId	importId	string
message	message	string
numOfLeadsProcessed	numOfLeadsProcessed	integer	Number of rows processed so far
numOfRowsFailed	numOfRowsFailed	integer	Number of rows failed so far
numOfRowsWithWarning	numOfRowsWithWarning	integer	Number of rows with a warning so far
status	status	string	Status of the batch

ProgramMembership

Name	Path	Type	Description
acquiredBy	acquiredBy	boolean	Whether the lead was acquired by the parent program
isExhausted	isExhausted	boolean	Whether the lead is currently exhausted in the stream, if applicable
membershipDate	membershipDate	string	Date the lead first became a member of the program
nurtureCadence	nurtureCadence	string	Cadence of the parent stream if applicable
progressionStatus	progressionStatus	string	Program status of the lead in the parent program
reachedSuccess	reachedSuccess	boolean	Whether the lead is in a success-status in the parent program
stream	stream	string	Stream that the lead is a member of, if the parent program is an engagement program

ExportResponse

Response containing export job status information

Name	Path	Type	Description
createdAt	createdAt	date-time	Date when the export request was created
errorMsg	errorMsg	string	Error message in case of "Failed" status
exportId	exportId	string	Unique id of the export job
fileSize	fileSize	integer	Size of exported file in bytes. This will have a value only when status is "Completed", otherwise null
fileChecksum	fileChecksum	string	SHA-256 hash of exported file. This will have a value only when status is "Completed", otherwise null
finishedAt	finishedAt	date-time	Finish time of export job. This will have value only when status is "Completed" or "Failed", otherwise null
format	format	string	Format of file as given in the request ("CSV", "TSV", "SSV")
numberOfRecords	numberOfRecords	integer	Number of records in the export file. This will have value only when status is "Completed", otherwise null
queuedAt	queuedAt	date-time	Queue time of export job. This will have value when "Queued" status is reached, before that null
startedAt	startedAt	date-time	Start time of export job. This will have value when "Processing" status is reached, before that null
status	status	string	Status of the export job ("Created","Queued","Processing","Canceled","Completed","Failed")

Reason

Name	Path	Type	Description
code	code	string	Integer code of the reason
message	message	string	Message describing the reason for the status of the operation

LeadMapAttribute

Name	Path	Type	Description
name	name	string	Name of the attribute
readOnly	readOnly	boolean	Whether the attribute is read only

Error

Name	Path	Type	Description
code	code	string	Error code of the error. See full list of error codes here
message	message	string	Message describing the cause of the error

ProgramMemberStatusResponse

Name	Path	Type	Description
status	status	string	Status of the operation performed on the record
reasons	reasons	array of Reason	List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted
leadId	leadId	integer	Id of the lead associated to the program member
seq	seq	integer	Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.

ProgramMemberDeleteResponse

Name	Path	Type	Description
status	status	string	Status of the operation performed on the record
reasons	reasons	array of Reason	List of reasons why an operation did not succeed. Reasons are only present in API responses and should not be submitted
leadId	leadId	integer	Id of the lead associated to the program member
seq	seq	integer	Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.

StaticList

Name	Path	Type	Description
createdAt	createdAt	string	Datetime when the list was created
description	description	string	Description of the static list
id	id	integer	Unique integer id of the static list
name	name	string	Name of the static list
programName	programName	string	Name of the program
updatedAt	updatedAt	string	Datetime when the list was most recently updated
workspaceName	workspaceName	string	Name of the parent workspace, if applicable

BrowseAllPrograms

Name	Path	Type	Description
channel	channel	string	Channel of the program
createdAt	createdAt	date-time	Datetime the asset was created
description	description	string	Description of the asset
folder	folder	Folder	JSON representation of a folder
id	id	integer	Id of the asset
name	name	string	Name of the asset
sfdcId	sfdcId	string	SFDC id of the program if linked to an SFDC campaign
sfdcName	sfdcName	string	Name of the linked SFDC campaign if applicable
status	status	string	Status of the program. Only valid for Email and engagement program types.
type	type	string	Type of the program
updatedAt	updatedAt	date-time	Datetime the asset was most recently updated
url	url	string	Url of the asset in the Marketo UI
workspace	workspace	string	Name of the workspace

FolderContentResponse

Name	Path	Type	Description
id	id	integer
type	type	string

FileFolder

Name	Path	Type
id	id	integer
name	name	string
type	type	string

ResponseOfProgramResponse

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of ProgramResponse
success	success	boolean
warnings	warnings	array of string

ResponseOfSmartListResponse

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of SmartListResponse
success	success	boolean
warnings	warnings	array of string

ResponseOfSmartListResponseWithRules

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of SmartListResponseWithRules
success	success	boolean
warnings	warnings	array of string

SmartListResponse

Name	Path	Type	Description
id	id	integer	Id of the smart list
name	name	string	Name of the smart list
description	description	string	Description of the smart list
createdAt	createdAt	date-time	Datetime the smart list was created
updatedAt	updatedAt	date-time	Datetime the smart list was most recently updated
url	url	string	Url of the smart list in the Marketo UI
folder	folder	Folder	JSON representation of a folder
workspace	workspace	string	Name of the workspace

SmartListResponseWithRules

Name	Path	Type	Description
id	id	integer	Id of the smart list
name	name	string	Name of the smart list
description	description	string	Description of the smart list
createdAt	createdAt	date-time	Datetime the smart list was created
updatedAt	updatedAt	date-time	Datetime the smart list was most recently updated
url	url	string	Url of the smart list in the Marketo UI
folder	folder	Folder	JSON representation of a folder
workspace	workspace	string	Name of the workspace
rules	rules	SmartListRules	JSON representation of smart list rules

ResponseOfStaticListResponse

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of StaticListResponse
success	success	boolean
warnings	warnings	array of string

StaticListResponse

Name	Path	Type	Description
id	id	integer	Id of the static list
name	name	string	Name of the static list
description	description	string	Description of the static list
createdAt	createdAt	date-time	Datetime the static list was created
updatedAt	updatedAt	date-time	Datetime the static list was most recently updated
url	url	string	Url of the static list in the Marketo UI
folder	folder	Folder	JSON representation of a folder
workspace	workspace	string	Name of the workspace
computedUrl	computedUrl	string

ProgramResponse

Name	Path	Type	Description
channel	channel	string	Channel of the program
costs	costs	array of Costs	Lists of associated period costs
createdAt	createdAt	date-time	Datetime the asset was created
description	description	string	Description of the asset
endDate	endDate	date-time	End date of the program. Applicable to event, email, and webinar type programs
folder	folder	ProgramFolder
id	id	integer	Id of the asset
name	name	string	Name of the asset
sfdcId	sfdcId	string	SFDC id of the program if linked to an SFDC campaign
sfdcName	sfdcName	string	Name of the linked SFDC campaign if applicable
startDate	startDate	date-time	Start date of program. Applicable to event, email and webinar type programs
status	status	string	Status of the program. Only valid for Email and engagement program types.
tags	tags	array of Tags	List of associated program tags
type	type	string	Type of the program
updatedAt	updatedAt	date-time	Datetime the asset was most recently updated
url	url	string	Url of the asset in the Marketo UI
workspace	workspace	string	Name of the workspace
marketingProgramProgressionId	marketingProgramProgressionId	integer
headStart	headStart	boolean	Whether 'Head Start' function is enabled for the program

FileResponse

Name	Path	Type	Description
createdAt	createdAt	date-time	Datetime when the file was created
description	description	string	Description of the file
folder	folder	FileFolder
id	id	integer	Id of the file
mimeType	mimeType	string	MIME type of the file
name	name	string	Name of the file
size	size	integer	Size of the file in bytes
updatedAt	updatedAt	date-time	Datetime when the file was most recently updated
url	url	string	Publically accessible URL of the file

ResponseOfFileResponse

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of FileResponse
success	success	boolean
warnings	warnings	array of string

FolderResponse

Name	Path	Type	Description
accessZoneId	accessZoneId	integer
createdAt	createdAt	date-time	Datetime the folder was created
description	description	string	Description of the folder
folderId	folderId	Folder	JSON representation of a folder
folderType	folderType	string	Type of folder
id	id	integer	Id of the folder
isArchive	isArchive	boolean	Archival status of the folder
isSystem	isSystem	boolean	Whether the folder is system-managed
name	name	string	Name of the folder. Not applicable for Programs
parent	parent	Folder	JSON representation of a folder
path	path	string	Path of the folder
updatedAt	updatedAt	date-time	Datetime the folder was last updated
url	url	string	Url of the folder
workspace	workspace	string	Name of the workspace

ResponseOfIdResponse

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of IdResponse
success	success	boolean
warnings	warnings	array of string

ResponseOfBrowseAllPrograms

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of BrowseAllPrograms
success	success	boolean
warnings	warnings	array of string

ResponseOfFolderResponse

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of FolderResponse
success	success	boolean
warnings	warnings	array of string

ResponseOfFolderContentResponse

Name	Path	Type
errors	errors	array of Error
requestId	requestId	string
result	result	array of FolderContentResponse
success	success	boolean
warnings	warnings	array of string

IdResponse

Name	Path	Type	Description
id	id	integer	Id of the asset

Costs

Name	Path	Type	Description
cost	cost	integer	Amount of the cost
note	note	string	Notes on the cost
startDate	startDate	date-time	Start date of the period cost

ProgramFolder

Name	Path	Type	Description
type	type	string	The type of program folder
value	value	integer	The id of the program folder
folderName	folderName	string	The name of the program folder

Folder

JSON representation of a folder

Name	Path	Type	Description
id	id	integer	Id of the folder
type	type	string	Type of folder

SmartListRules

JSON representation of smart list rules

Name	Path	Type	Description
filterMatchType	filterMatchType	string	Smart list filter match type (rule logic)
triggers	triggers	array of string	List of smart list triggers
filters	filters	array of SmartListFilters	List of smart list filters

SmartListFilters

JSON representation of smart list filters

Name	Path	Type	Description
id	id	integer	Id of the filter
name	name	string	Name of filter
ruleTypeId	ruleTypeId	integer	Id of the rule type
ruleType	ruleType	string	Name of rule type
operator	operator	string	Name of operator
conditions	conditions	array of SmartListConditions	List of smart list conditions

SmartListConditions

JSON representation of smart list conditions

Name	Path	Type	Description
activityAttributeId	activityAttributeId	integer	Id of the activity attribute
activityAttributeName	activityAttributeName	string	Name of activity attribute
operator	operator	string	Value of operator
values	values	array of string	List of values
isPrimary	isPrimary	boolean	Whether the condition is primary or not (first condition of the smart list)

object

This is the type 'object'.

Поделиться через

Marketo MA (Preview)

Creating a connection

Default

Throttling Limits

Actions

Add to List

Parameters

Returns

Approve Program

Parameters

Returns

Cancel Export Lead Job

Parameters

Returns

Cancel Export Program Member Job

Parameters

Returns

Clone Program

Parameters

Returns

Clone Smart List

Parameters

Returns

Create Export Lead Job

Parameters

Returns

Create Export Program Member Job

Parameters

Returns

Create File

Parameters

Returns

Create Folder

Parameters

Returns

Create Program

Parameters

Returns

Create Static List

Parameters

Returns

Delete Folder

Parameters

Returns

Delete Leads

Parameters

Returns

Delete Program

Parameters

Returns

Delete Program Members

Parameters

Returns

Delete Program Tag

Parameters

Returns

Delete Smart List

Parameters

Returns

Delete Static List

Parameters

Returns

Describe Lead

Returns

Describe Lead2

Returns

Describe Program Member

Returns

Describe Program Member

Returns

Enqueue Export Lead Job

Parameters

Returns

Enqueue Export Program Member Job

Parameters

Returns

Get Campaign By Id

Parameters

Returns