CData Cloud offers access to Marketo across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Marketo through CData Cloud.
CData Cloud allows you to standardize and configure connections to Marketo as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Marketo in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Marketo and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Marketo through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Marketo by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Before obtaining OAuth credentials you need to create a custom service if you do not already have one. To do so follow the instructions provided in Creating a Custom Service.
To obtain OAuth credentials for a custom service:
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud models Marketo entities in relational Tables, Views, and Stored Procedures.
Note: The data model may differ when using the bulk API.
Stored Procedures are function-like interfaces to Marketo. They can be used to create, update, modify, and retrieve information that cannot be modeled as tables or views. Some procedures are used to download/upload files and interact with the Bulk API.
The Cloud models the data in Marketo as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Activities_Custom | Sample custom activity. |
| Companies | Query Companies in Marketo. |
| CustomObjects | Query custom objects for a Marketo organization. |
| Emails | Query emails for a Marketo organization. |
| EmailTemplates | Query email templates for a Marketo organization. |
| Folders | Create, update, delete, and query Folders for a Marketo organization. |
| Forms | Create, update, delete and query Forms for a Marketo organization. |
| LandingPageContentSection | Create, update, delete, and query Content Sections of Landing Pages for a Marketo organization. |
| LandingPages | Create, update, delete and query Landing Pages for a Marketo organization. |
| LandingPageTemplates | Create, update, delete and query Landing Page Templates for a Marketo organization. |
| Leads | Query Leads of a Marketo organization. |
| NamedAccounts | Query Named Accounts for a Marketo organization. |
| Opportunities | Query Opportunities in Marketo. |
| OpportunityRoles | Query Opportunity Roles in Marketo. |
| ProgramMembers | Query Program Members in Marketo. |
| Programs | Create, update, delete, and query Programs for a Marketo organization. |
| SalesPersons | Query Sales Persons in Marketo. |
| SmartCampaigns | Query Smart Campaigns for a Marketo organization. |
| SmartLists | Query Smart Lists for a Marketo organization. |
| Snippets | Create, update, delete and query snippets for a Marketo organization. |
| StaticListMembership | Query relations of static lists and leads in Marketo. |
| StaticLists | Query Static Lists for a Marketo organization. |
| Tokens | Create, delete, and query Tokens for a Marketo organization. |
| Users | Query users for a Marketo organization. |
| UserWorkspaceRoles | Query user roles for each workspace in Marketo. |
Sample custom activity.
Each custom activity in your Marketo organization is returned as a separate table, apart from the main "Activities" table. Each table name is prefixed with 'Activity_' followed by the name of your custom activity.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
The following queries are related to a sample custom activity 'Activities_AttendConference'. This table may not exist in your Marketo instance.
SELECT * FROM Activities_AttendConference WHERE ListId = '1014'
INSERT INTO Activities_AttendConference (ActivityDate, LeadId, PrimaryAttributeValue, ConferenceDate, NumberOfAttendees) VALUES ('2024-01-01T00:01:00Z', 4, 'asd', '2024-01-10', 4)
SELECT * FROM Activities_AttendConference WHERE ActivityDate > '2024-01-01T00:00:00Z'
SELECT * FROM Activities_AttendConference WHERE ActivityDate >= '2024-01-01T00:00:00Z' AND ActivityDate <= '2024-03-01T00:00:00Z'
SELECT * FROM Activities_AttendConference WHERE ListId = '1014' AND ActivityDate > '2024-01-01T00:00:00Z'
SELECT * FROM Activities_AttendConference WHERE ListId = '1014' AND ActivityDate >' 2024-01-01T00:00:00Z'
| Name | Type | ReadOnly | Operators | Description |
| ActivityId [KEY] | String | False |
Unique id of the activity. | |
| ActivityDate | Datetime | False |
Datetime of the activity. | |
| LeadId | Int | False | =,IN |
Id of the lead associated to the activity. |
| CampaignId | Int | False |
Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | False | = |
Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ConferenceName | String | False | ||
| ConferenceNameValue | String | False | ||
| ConferenceDate | Datetime | False | ||
| NumberOfAttendees | Int | False |
Query Companies in Marketo.
Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.
Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
SELECT * FROM Companies WHERE [Id]=10
SELECT * FROM Companies WHERE [Id] IN (10, 11, 22)
SELECT * FROM Companies WHERE [ExternalCompanyId]='CData'
SELECT * FROM Companies WHERE [ExternalCompanyId] IN ('CData', 'Marketo')
SELECT * FROM Companies WHERE [Company]='CData'
SELECT * FROM Companies WHERE [Company] IN ('CData', 'Marketo')
SELECT * FROM Companies WHERE [ExternalSalesPersonId]='CDataSales'
SELECT * FROM Companies WHERE [ExternalSalesPersonId] IN ('CDataSales', 'MarketoSales')
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO Companies (ExternalCompanyId, Company, Industry, Website) VALUES ('cdata', 'CData', 'Tech', 'cdata.com'), ('marketo', 'Marketo', 'Tech', 'marketo.com')
This table supports BATCH UPDATE when UseBulkAPI is set to false.
UPDATE Companies SET Company='test_UPDATE_Companies', MainPhone='800-555-1234', AnnualRevenue='10000000.00' WHERE ExternalCompanyId='cdata'
UPDATE Companies SET Company='CData', MainPhone='800-555-1234', AnnualRevenue='10000000.00' WHERE WHERE Id IN (2523781, 2523782, 2523783, 2523784)
This table supports BATCH UPSERT when UseBulkAPI is set to false.
UPSERT INTO Companies (ExternalCompanyId, Company, Industry, Website) VALUES ('testUpsert', 'Google', 'Tech', 'google.com')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM Companies WHERE externalCompanyId='cdata'
DELETE FROM Companies WHERE Id IN (2521059, 2521060, 123, 2521058)
DELETE FROM Companies WHERE Company='testName'
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | =,IN | |
| ExternalCompanyId | String | True | =,IN | |
| AnnualRevenue | Decimal | False | ||
| BillingCity | String | False | ||
| BillingCountry | String | False | ||
| BillingPostalCode | String | False | ||
| BillingState | String | False | ||
| BillingStreet | String | False | ||
| Company | String | False | =,IN | |
| CompanyNotes | String | False | ||
| ExternalSalesPersonId | String | False | =,IN | |
| Industry | String | False | ||
| MainPhone | String | False | ||
| NumberOfEmployees | Int | False | ||
| SicCode | String | False | ||
| Site | String | False | ||
| Website | String | False | ||
| CreatedAt | Datetime | True | ||
| UpdatedAt | Datetime | True |
Query custom objects for a Marketo organization.
Each custom object in your Marketo organization is returned as a separate table. Each table name is prefixed with 'CustomObject_' followed by the name of your custom object.
Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
The following queries are related to a sample custom object. This table may not exist in your Marketo instance.
SELECT * FROM CustomObject_cdata WHERE MarketoGUID IN ('8207b49b-933c-40a0-995d-d12c90572a65', '71cce7c8-e7d1-4a00-8ea7-89806fee56be')
SELECT * FROM CustomObject_cdata WHERE Mailaddress IN ('[email protected]', '[email protected]')
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO CustomObject_cdata (Names) VALUES ('tes123')
This table supports BATCH UPDATE when UseBulkAPI is set to false.
UPDATE CustomObject_cdata SET Value1='testupdate' WHERE Mailaddress='[email protected]'
UPDATE CustomObject_cdata SET Value1='testupdateMultipleValues' WHERE Mailaddress IN ('[email protected]', '[email protected]')
This table supports BATCH UPSERT when UseBulkAPI is set to false.
This table supports BULK UPSERT when UseBulkAPI is set to true.
UPSERT INTO CustomObject_cdata (Mailaddress, Value1) VALUES ('[email protected]', 'test01')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM [CustomObject_cdata] WHERE MarketoGUID='8207b49b-933c-40a0-995d-d12c90572a65'
DELETE FROM [CustomObject_cdata] WHERE MarketoGUID IN ('980415e9-3cf0-4168-ae99-8cf3c613c83b', '71cce7c8-e7d1-4a00-8ea7-89806fee56be')
DELETE FROM [CustomObject_cdata] WHERE Mailaddress='[email protected]'
DELETE FROM [CustomObject_cdata] WHERE Mailaddress IN ('[email protected]', '[email protected]')
| Name | Type | ReadOnly | Operators | Description |
| ListId | Int | True | = |
Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided static list Id. |
| ListName | String | True | = |
Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided static list name. |
| SmartListId | Int | True | = |
Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list Id. |
| SmartListName | String | True | = |
Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list name. |
SELECT * FROM CustomObject_cdata WHERE UpdatedAt>'2024-04-01T00:00:00Z'
SELECT * FROM CustomObject_cdata WHERE UpdatedAt>'2024-04-01T00:00:00Z' AND UpdatedAt<'2024-09-01T00:00:00Z'
SELECT * FROM CustomObject_cdata WHERE ListId=2
| Name | Type | ReadOnly | Operators | Description |
| MarketoGUID [KEY] | String | True | =,IN | |
| UpdatedAt | Datetime | True |
The datetime when the custom object was last updated. | |
| CreatedAt | Datetime | True | ||
| Mailaddress | String | False | =,IN | |
| Value1 | String | False |
Query emails for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
GetEmailFullContent can be used to retrieve the full content of an email.
UpdateEmailContent can be used to update the content content of an email.
UpdateEmailFullContent can be used to update the full content of an email.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following queries are processed server-side:
SELECT * FROM Emails WHERE Id=15457
SELECT * FROM Emails WHERE Name='[email protected]'
SELECT * FROM Emails WHERE FolderId=26
SELECT * FROM Emails WHERE UpdatedAt >= '2023-03-22 00:09:14.0' AND UpdatedAt <= '2023-03-22 01:49:03.0'
INSERT INTO Emails (Name, TemplateId, FolderId, FolderType) VALUES ('My Email', 1037, 5111, 'Program')
UPDATE Emails SET Name='CRUD Test', Description='Testing CRUD' WHERE Id=23852
DELETE FROM Emails WHERE Id=23838
DELETE FROM Emails WHERE Id=23759 AND Status='approved'
DELETE FROM Emails WHERE Id IN (17008, 23764) AND Status='draft'
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
The unique, Marketo-assigned identifier of the email. |
| Status [KEY] | String | True | = |
The status of the email, draft or approved version. |
| Name | String | False | = |
The name of the email. |
| Description | String | False |
The description of the email. | |
| Subject | String | False |
The email subject. | |
| FromName | String | False |
The from name. | |
| FromEmail | String | False |
The from email address. | |
| ReplyEmail | String | False |
The reply email address. | |
| PreHeader | String | False |
The pre-header text for the email. | |
| URL | String | True |
The URL of the asset in the Marketo UI. | |
| TemplateId | Int | False |
The template associated with the email. | |
| PublishToMSI | Bool | True |
Identifies whether the email is published. | |
| Version | Int | True |
The Template version type. | |
| Operational | Bool | False |
Identifies whether the email is operational. | |
| TextOnly | Bool | False |
Identifies whether the email is text only. | |
| WebView | Bool | False |
Identifies whether the email is web view. | |
| AutoCopyToText | Bool | False |
Identifies whether the email is auto copied to text. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| WorkspaceName | String | True |
Name of the workspace the email is part of. | |
| CreatedAt | Datetime | True |
Datetime the email was created. | |
| UpdatedAt | Datetime | True | =,>,<,>=,<= |
Datetime the email was most recently updated. |
Query email templates for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
CreateEmailTemplate can be used to create email templates.
GetEmailTemplateContent can be used to retrieve the email template content.
UpdateEmailTemplateContent can be used to update the email template content.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following queries are processed server-side:
SELECT * FROM EmailTemplates WHERE ID=1038
SELECT * FROM EmailTemplates WHERE Name='Test Template 3'
SELECT * FROM EmailTemplates WHERE Status='approved'
SELECT * FROM EmailTemplates WHERE ID=1038 AND Status='approved'
UPDATE EmailTemplates SET Description='test update' WHERE Id=1039
DELETE FROM EmailTemplates WHERE Id=1014
DELETE FROM EmailTemplates WHERE Id=1034 AND Status='draft'
DELETE FROM EmailTemplates WHERE Name='Serenity (Marketo Starter Template)
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
The id of the asset. |
| Status [KEY] | String | True | = |
Status of the email template, draft or approved versions. |
| Name | String | False | = |
The name of the asset. |
| Description | String | False |
The description of the asset. | |
| URL | String | True |
The URL of the asset in the Marketo UI. | |
| Version | Int | True |
The Template version type. | |
| WorkspaceName | String | True |
Name of the workspace the email template is part of. | |
| FolderId | Int | True |
The unique, Marketo-assigned identifier of the parent folder/program. | |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | True |
The type of folder (Folder,Program) | |
| CreatedAt | Datetime | True |
The date and time the asset was created. | |
| UpdatedAt | Datetime | True |
The date and time the asset was last updated. |
Create, update, delete, and query Folders for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following queries are processed server-side:
SELECT * FROM Folders WHERE Name='Marketo8'
SELECT * FROM Folders WHERE Name='Default'
SELECT * FROM Folders WHERE Name='Default' AND WorkspaceName='Default'
SELECT * FROM Folders WHERE MaxDepth=1;
SELECT * FROM Folders WHERE ParentId=12 AND ParentType='Folder'
SELECT * FROM Folders WHERE ParentId=12
INSERT INTO Folders (Name, ParentId, ParentType, Description) VALUES ('newFolder1234567', 38, 'Folder', 'test insert description')
UPDATE Folders SET Description='test update folders2', IsArchive='true' WHERE Id IN (5910, 5911) AND Type='Folder'
Note: Folders of Type='Program' and folders with IsSystem=true can not be deleted.
DELETE FROM Folders WHERE Id=5363 AND Type='Folder'
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
The unique, Marketo-assigned identifier of the folder. |
| Type [KEY] | String | False | = |
The type of the folder (Folder or Program). |
| Name | String | False | = |
The name of the folder. |
| Description | String | False |
The description of the folder. | |
| FolderType | String | True |
The type of the folder (Revenue Cycle Model, Marketing Folder, List, Smart List). | |
| ParentId | Int | False | = |
The Id of the parent folder. |
| ParentType | String | False | = |
The type of the parent folder. |
| Path | String | True |
The path of a folder shows its hierarchy in the folder tree, similar to a Unix-style path. | |
| WorkspaceName | String | True | = |
The name of the smart campaign workspace. |
| URL | String | True |
The explicit URL of the asset in the designated instance. | |
| IsSystem | Bool | True |
Whether or not the folder is a system folder. | |
| IsArchive | Bool | False |
Whether or not the folder is archived. | |
| AccessZoneId | Int | True |
The access zone id | |
| CreatedAt | Datetime | True |
The date and time the folder was created. | |
| UpdatedAt | Datetime | True |
The date and time the folder was last updated. | |
| MaxDepth | Int | True | = |
Mirror column used to specify the maximum folder depth to traverse. Will be ignored when filtering by Id or Name. |
Create, update, delete and query Forms for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following queries are processed server-side:
SELECT * FROM FORMS WHERE status='draft'
SELECT * FROM FORMS WHERE Id=1001
SELECT * FROM FORMS WHERE Name='Form1'
SELECT * FROM FORMS WHERE Id=1001 AND Status='draft'
SELECT * FROM FORMS WHERE FolderId=1089 AND FolderType='Program'
SELECT * FROM FORMS WHERE FolderId=1002
INSERT INTO Forms (Name, Description, FolderId, FolderType, FontFamily, FontSize, LabelPosition, Language, Locale, ProgressiveProfiling)
VALUES ('test insert form', 'test form description', 1089, 'Program', 'Arial', '12px', 'left', 'English', 'en_US', true)
UPDATE Forms SET Name='test update form', Description='Testing Update', FontSize='13px' WHERE Id=1016
DELETE FROM Forms WHERE Id=1004
DELETE FROM Forms WHERE Id=1004 AND Status='draft'
DELETE FROM Forms WHERE Name IN ('test', 'My Snippet')
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
The unique, Marketo-assigned identifier of the form. |
| Status [KEY] | String | True | = |
Status of the form, draft or approved versions. |
| Name | String | False | = |
The name of the form. |
| Description | String | False |
The description of the form. | |
| URL | String | True |
The URL of the form in the Marketo UI. | |
| KnownVisitorTemplate | String | False |
Template of the known visitor behavior for the form. | |
| KnownVisitorType | String | False |
Type of the known visitor behavior for the form. | |
| Theme | String | False |
CSS theme for the form to use. | |
| Language | String | False |
Language of the form. | |
| Locale | String | False |
Locale of the form. | |
| ProgressiveProfiling | Bool | False |
Whether progressive profiling is enabled for the form. | |
| LabelPosition | String | False |
Default positioning of labels. | |
| ButtonLabel | String | False |
Label text of the button. | |
| ButtonWaitingLabel | String | False |
Waiting text of the button. | |
| ButtonLocation | Int | False |
Location in pixels of the button relative to the left of the form. | |
| FontFamily | String | False |
font-family property for the form. | |
| FontSize | String | False |
font-size property of the form. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| WorkspaceId | Int | True |
Workspace Id of the asset. | |
| CreatedAt | Datetime | True |
Datetime the form was created. | |
| UpdatedAt | Datetime | True |
Datetime the form was most recently updated. | |
| ThankYouList | String | True |
JSON array of ThankYouPage JSON objects. |
Create, update, delete, and query Content Sections of Landing Pages for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following queries are processed server-side:
SELECT * FROM LandingPageContentSection WHERE LandingPageId='2'
SELECT * FROM LandingPageContentSection WHERE LandingPageId='2' AND status='draft'
INSERT INTO LandingPageContentSection (LandingPageId, Content, Type, Height, Width, FormattingOptionsTop, FormattingOptionsLeft, Opacity, BorderColor, BackgroundColor, HideDesktop, HideMobile, ImageOpenNewWindow, FormattingOptionsZIndex)
VALUES (1009, '<html><body>Hello World!</body></html>', 'HTML', '100', '101', '1', '2', '0.8', '#ff00ff', '#00ffff', false, true, true, 1)
UPDATE LandingPageContentSection BorderColor='#ff0000', BackgroundColor='#0000ff', HideMobile='true', ImageOpenNewWindow='true', Type='HTML', FormattingOptionsTop='1', FormattingOptionsLeft='2', Width='101', HideDesktop='false', Opacity='0.8', Content='<html><body>Hello World!</body></html>', Height='100', FormattingOptionsZIndex='1'
WHERE LandingPageId=1009 AND Id=1049
DELETE FROM LandingPageContentSection WHERE LandingPageId=1009
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | String | True |
Id of the content section. | |
| LandingPageId [KEY] | String | False | = |
Id of the landing page to which the content section belongs to. |
| Status [KEY] | String | True | = |
Status filter for draft or approved versions. |
| Index | Int | True |
Index of the content section. Index orients the elements from lowest to highest. | |
| Type | String | False |
Type of content section. | |
| Content | String | False |
Content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content. | |
| RawContent | String | True |
Raw content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content. | |
| ContentType | String | True |
Content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content. | |
| ContentURL | String | True |
Content of the section. Expected values vary based on type. Image: An image URL. RichText: HTML Content. | |
| LinkURL | String | False |
RL parameter of a link type section. | |
| FollowupType | String | False |
Follow-up behavior of a form. Only available for form-type content sections. Defaults to form defined behavior. | |
| FollowupValue | String | False |
Where to follow-up on form submission. When followupType is lp, accepts the integer id of a landing page. For url, it accepts a url string. | |
| Height | String | False |
The height of the content. | |
| MinHeight | String | True |
The min height of the content. | |
| Width | String | False |
The width of the content. | |
| MinWidth | String | True |
The min width of the content. | |
| FormattingOptionsTop | String | False |
The top margin of the content. | |
| FormattingOptionsLeft | String | False |
The left margin of the content. | |
| Opacity | String | False |
The opacity of the content. | |
| BorderWidth | String | False |
The border width of the content. | |
| BorderStyle | String | False |
The border style of the content. | |
| BorderColor | String | False |
The border color of the content. | |
| BackgroundColor | String | False |
The background color of the content. | |
| HideDesktop | Bool | False |
Hide the section when displayed on a desktop browser. Default false. | |
| HideMobile | Bool | False |
Hide the section when displayed on a desktop browser. Default false. | |
| ImageOpenNewWindow | String | False |
ImageOpenNewWindow | |
| FormattingOptionsZIndex | String | False |
The z-index of the content. |
Create, update, delete and query Landing Pages for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following queries are processed server-side:
SELECT * FROM LandingPages WHERE status='approved'
SELECT * FROM LandingPages WHERE folderId=1001
SELECT * FROM LandingPages WHERE folderId=1001 AND status='draft'
SELECT * FROM LandingPages WHERE name='string'
INSERT INTO LandingPages (Name, CustomHeadHTML, Description, FacebookOgTags, FolderId, FolderType, Keywords, MobileEnabled, Robots, Template, Title)
VALUES ('test insert landing page', '<!DOCTYPE html>\\n<html>\\n<body>\\n<h1>My landing page</h1>\\n<p>My landing page content.</p>\\n</body></html>', 'Testing Insert operation', '', 1184, 'Program', '', true, 'index, nofollow', 1, 'Insert Operation')
UPDATE LandingPages SET Description='Testing Update', FacebookOgTags='', Keywords='',
MobileEnabled=false, Name='Test Update', Robots='index, nofollow',Title='Updating Landing Page',
CustomHeadHTML='<!DOCTYPE html>\n<html>\n<body>\n<h1>Updating Landing Page</h1>\n<p>Editing Landing Page</p>\n</body></html>'
WHERE Id=1009
Note: Approved landing pages cannot be deleted. Use UnApproveAsset to revoke landing page approval.
DELETE FROM LandingPages WHERE Id=1003
DELETE FROM LandingPages WHERE Id=1003 WHERE status='draft'
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
The unique, Marketo-assigned identifier of the landing page. |
| Status [KEY] | String | True | = |
Status filter for draft or approved versions. |
| Name | String | False | = |
The name of the landing page. |
| Description | String | False |
The description of the landing page. | |
| Title | String | False |
Title element of the landing page. | |
| URL | String | True |
The URL of the landing page in the Marketo UI. | |
| ComputedURL | String | True |
Computed URL of landing page. | |
| WorkspaceName | String | False |
Workspace name of the asset. | |
| Template | Int | False |
Id of the template used. | |
| Robots | String | False |
Robots directives to apply to the pages meta tags | |
| MobileEnabled | Bool | False |
Whether the page has mobile viewing enabled. Free-form pages only. Default false. | |
| CustomHeadHTML | String | False |
Any custom HTML to embed in the tag of the page. | |
| Keywords | String | False |
Keywords | |
| FormPrefill | Bool | True |
Boolean to toggle whether forms embedded in the page will prefill. Default false. | |
| FacebookOgTags | String | False |
Any OpenGraph meta tags to apply to the page. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| CreatedAt | Datetime | True |
Datetime the landing page was created. | |
| UpdatedAt | Datetime | True |
Datetime the landing page was most recently updated. |
Create, update, delete and query Landing Page Templates for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side. The Name and Id filters will be processed server-side only if Status='approved'.
For example, the following queries are processed server-side:
SELECT * FROM LandingPageTemplates WHERE Status='approved'
SELECT * FROM LandingPageTemplates WHERE FolderId=19
SELECT * FROM LandingPageTemplates WHERE Name='Test Insert 1' AND Status='approved'
SELECT * FROM LandingPageTemplates WHERE Id=3 AND Status='approved'
INSERT INTO LandingPageTemplates (Name, TemplateType, Description, EnableMunchkin, FolderId, FolderType)
VALUES ('Test Insert 1', 'guided', 'Testing Insert', true, 19, 'Folder')
UPDATE LandingPageTemplates SET Description='Testing Update', EnableMunchkin=false, Name='Test Update' WHERE Id=1
DELETE FROM LandingPageTemplates WHERE Id=2 AND Status='approved'
DELETE FROM LandingPageTemplates WHERE Name='Test Insert 1'
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
The unique, Marketo-assigned identifier of the landing page template. |
| Status [KEY] | String | True | = |
Status of the landing page template, draft or approved versions. |
| Name | String | False | = |
The name of the landing page template. |
| Description | String | False |
The description of the landing page template. | |
| EnableMunchkin | Bool | False |
Whether to enable munchkin on the derived pages. Defaults to true. | |
| TemplateType | String | False |
Type of template to create 'guided' or 'freeForm' | |
| URL | String | True |
The URL of the landing page in the Marketo UI. | |
| WorkspaceName | String | True |
Workspace name of the asset. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| CreatedAt | Datetime | True |
Datetime the landing page template was created. | |
| UpdatedAt | Datetime | True |
Datetime the landing page template was most recently updated. |
Query Leads of a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
To optimize response time from the server, identify only the rows and columns you want to retrieve.
SELECT Id, FirstName, LastName FROM Leads WHERE Id IN (1, 2, 5, 10)
To achieve the best performance from this query, confine it to a list of known Leads within Marketo. Create a static list of Leads within Marketo, and then specify the ListId to retrieve them.
SELECT * FROM Leads WHERE ListId=1014
If you do not specify a filter, the driver retrieves all Leads, which might take a long time depending on the number of leads in your Marketo instance.
Specify the LeadChangeDateTime pseudo-column to improve query performance by limiting the number of records requested.
Note: LeadChangeDateTime is a pseudo column that can only be used as a server-side filter.
The API does not return values for this column.
This is a result of the documented API behavior, see this forum post.
SELECT * FROM Leads WHERE LeadChangeDateTime >= '2024-03-20T15:49:22.000Z'
SELECT Id, LeadChangeDateTime, UpdatedAt FROM Leads WHERE LeadChangeDateTime >= '2024-01-17T14:32:37.000-05:00'
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO Leads (FirstName, LastName, Email, DoNotCall, DoNotCallReason, DateOfBirth) VALUES ('test', 'test', '[email protected]', true, 'Testing', '01/01/2000')
INSERT INTO Leads (FirstName, LastName, Email, DoNotCall, DoNotCallReason, DateOfBirth) VALUES ('test1', 'test1', '[email protected]', true, 'Testing', '01/01/2000'), ('test3', 'test3', '[email protected]', true, 'Testing', '01/01/2000')
INSERT INTO Leads (FirstName, LastName, Email, PartitionName) VALUES ('test', 'test', '[email protected]', 'testPartition')
To insert multiple leads at once via a #TEMP table, first create the #TEMP table, and then insert that table into your Leads table.
The following example creates a #TEMP table with three new Leads, and then inserts that #TEMP table into the Leads table:
INSERT INTO Leads#TEMP (FirstName, LastName, Email, Company) VALUES ('John', 'Mangel', '[email protected]', 'ABC')
INSERT INTO Leads#TEMP (FirstName, LastName, Email, Company) VALUES ('Steve', 'Puth', '[email protected]', 'ABC')
INSERT INTO Leads#TEMP (FirstName, LastName, Email, Company) VALUES ('Andrew', 'Stack', 'andy@abc', 'ABC')
INSERT INTO Leads (FirstName, LastName, Email, Company) SELECT FirstName, LastName, Email, Company FROM Leads#TEMP
This table supports BATCH UPDATE when UseBulkAPI is set to false.
You can update any field in the Leads table that is not read-only. All critria fields are used as deduplication fields. Use a field for deduplication if it supports server side filtering, otherwise the Id column is used for deduplication.
UPDATE Leads SET Company='TestCompany', NumberOfEmployees=100 WHERE Id='2521004'
UPDATE Leads SET Title='My Job', Address='123 Main St' WHERE Email='[email protected]'
UPDATE LEADS SET Email='[email protected]' WHERE Id=2523020
UPDATE LEADS SET TestKpQA='test' WHERE TestCustomfieldEmail='[email protected]'
This table supports BATCH UPSERT when UseBulkAPI is set to false.
This table supports BULK UPSERT when UseBulkAPI is set to true.
UPSERT INTO Leads (Email, FirstName, LastName) VALUES ('[email protected]', 'Lead', 'Upsert_InsertNewRecord')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM Leads WHERE Id=508
DELETE FROM Leads WHERE Id IN (505, 506, 501, 507)
DELETE FROM Leads WHERE Email='[email protected]'
Note: The API returns only leads which have been deleted in the past 14 days.
GetDeleted FROM Leads
GetDeleted supports filtering by UpdatedAt.
GETDELETED FROM Leads WHERE UpdatedAt > '2024-01-01T01:00:00' GETDELETED FROM Leads WHERE UpdatedAt > '2024-01-01T01:00:00' AND UpdatedAt <= '2024-02-01T01:00:00'
| Name | Type | ReadOnly | Operators | Description |
| StaticListName | String | True | = |
Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided static list name. |
| SmartListId | Int | True | = |
Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list Id. |
| SmartListName | String | True | = |
Mirror column that can be used only as a filter. Will retrieve custom objects related to the provided smart list name. |
SELECT Id, LeadChangeDateTime, UpdatedAt FROM LEADS WHERE LeadChangeDateTime>'2024-01-17T14:28:57.000-05:00' AND LeadChangeDateTime<'2024-01-29T04:29:55.000-05:00'
SELECT Id, CreatedAt FROM LEADS WHERE CreatedAt>='2024-01-17T14:27:20.000-05:00' AND CreatedAt<'2024-01-29T04:29:30.000-05:00'
SELECT * FROM LEADS WHERE ListId=1062
SELECT * FROM LEADS WHERE StaticListName='test0614'
SELECT Id FROM LEADS WHERE SmartListId=1095
SELECT Id FROM LEADS WHERE SmartListName='LeadSmartListTest'
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | =,IN |
The id of the lead. |
| CreatedAt | Datetime | True |
The datetime when the lead was created. | |
| UpdatedAt | Datetime | True |
The datetime when the lead was last updated. | |
| ProgramId | Int | True | = |
Mirror column that can be used only as a filter. Will retrieve Leads related to the given email ProgramId. Not available when UseBulkAPI=true. |
| ListId | Int | True | = |
Mirror column that can be used only as a filter. Will retrieve Leads related to the provided static list Id. |
| PartitionName | String | False |
Mirror column that can be used only during inserts to specify the partition of the lead. | |
| ItemURL | String | True |
The URL of the lead in the Marketo UI. | |
| LeadChangeDateTime | Datetime | True | =,>,>=,<,<= |
A server-side filter for the datetime when the Lead was updated, not necessarily the latest update. |
| AcmeAccessCode | String | False | =,IN | |
| AcquisitionProgramId | Int | False | ||
| Address | String | False | ||
| AnnualRevenue | Decimal | False | ||
| AnonymousIP | String | False | ||
| BillingCity | String | False | ||
| BillingCountry | String | False | ||
| BillingPostalCode | String | False | ||
| BillingState | String | False | ||
| BillingStreet | String | False | ||
| BlackListed | Bool | False | ||
| BlackListedCause | String | False | ||
| City | String | False | ||
| Company | String | False | ||
| ContactCompany | Int | True | ||
| Cookies | String | False | =,IN | |
| Country | String | False | ||
| Cstmfdtest1 | String | False | =,IN | |
| Cstmfdtest2 | String | False | =,IN | |
| DateOfBirth | Date | False | ||
| Department | String | False | =,IN | |
| DoNotCall | Bool | False | ||
| DoNotCallReason | String | False | ||
| Ecids | String | True | ||
| String | False | =,IN | ||
| EmailInvalid | Bool | False | ||
| EmailInvalidCause | String | False | ||
| EmailSuspended | Bool | False | ||
| EmailSuspendedAt | Datetime | False | ||
| EmailSuspendedCause | String | False | =,IN | |
| ExternalCompanyId | String | False | =,IN | |
| ExternalSalesPersonId | String | False | =,IN | |
| Fax | String | False | ||
| FirstName | String | False | ||
| FirstUTMCampaign | String | False | ||
| FirstUTMContent | String | False | ||
| FirstUTMMedium | String | False | ||
| FirstUTMSource | String | False | ||
| FirstUTMTerm | String | False | ||
| GdprMailableStatus | String | False | ||
| Industry | String | False | ||
| InferredCity | String | True | ||
| InferredCompany | String | True | ||
| InferredCountry | String | True | ||
| InferredMetropolitanArea | String | True | ||
| InferredPhoneAreaCode | String | True | ||
| InferredPostalCode | String | True | ||
| InferredStateRegion | String | True | ||
| IsAnonymous | Bool | False | ||
| IsLead | Bool | False | ||
| LastName | String | False | ||
| LatestUTMCampaign | String | False | ||
| LatestUTMContent | String | False | ||
| LatestUTMMedium | String | False | ||
| LatestUTMSource | String | False | ||
| LatestUTMterm | String | False | ||
| LeadPartitionId | Int | False | =,IN | |
| LeadPerson | Int | True | ||
| LeadRevenueCycleModelId | Int | False | ||
| LeadRevenueStageId | Int | False | ||
| LeadRole | String | False | ||
| LeadScore | Int | False | ||
| LeadSource | String | False | ||
| LeadStatus | String | False | ||
| MainPhone | String | False | ||
| MarketingSuspended | Bool | False | ||
| MarketingSuspendedCause | String | False | ||
| MiddleName | String | False | ||
| MktoAcquisitionDate | Datetime | False | ||
| MktoCompanyNotes | String | False | ||
| MktoDoNotCallCause | String | False | ||
| MktoIsCustomer | Bool | False | ||
| MktoIsPartner | Bool | False | ||
| MktoName | String | True | =,IN | |
| MktoPersonNotes | String | False | ||
| MobilePhone | String | False | ||
| NumberOfEmployees | Int | False | ||
| NumberofEmployeesProspect | String | False | ||
| OriginalReferrer | String | True | ||
| OriginalSearchEngine | String | True | ||
| OriginalSearchPhrase | String | True | ||
| OriginalSourceInfo | String | True | ||
| OriginalSourceType | String | True | ||
| PersonLevelEngagementScore | Int | False | =,IN | |
| PersonPrimaryLeadInterest | Int | True | ||
| PersonTimeZone | String | True | ||
| PersonType | String | False | ||
| Phone | String | False | ||
| PostalCode | String | False | ||
| Priority | Int | False | ||
| Rating | String | False | ||
| RegistrationSourceInfo | String | False | ||
| RegistrationSourceType | String | False | ||
| RelativeScore | Int | False | ||
| RelativeUrgency | Int | False | ||
| Salutation | String | False | ||
| SicCode | String | False | ||
| Site | String | False | ||
| State | String | False | ||
| Test | String | False | =,IN | |
| Test1 | Bool | False | ||
| Test98 | String | False | =,IN | |
| TestBoolean | Bool | False | ||
| TestCustomfieldEmail | String | False | =,IN | |
| TestFieldText1 | String | False | =,IN | |
| TestInteger | Bool | False | ||
| TestInteger_cf | Int | False | =,IN | |
| TestKpQA | String | False | =,IN | |
| Title | String | False | ||
| Unsubscribed | Bool | False | ||
| UnsubscribeDateFoFS | String | False | ||
| UnsubscribeDateUnleashed | String | False | ||
| UnsubscribedReason | String | False | ||
| UnsubscribeFoFS | String | False | ||
| UnsubscribeMarketing | String | False | ||
| UnsubscribeSales | String | False | ||
| UnsubscribeUnleashed | String | False | ||
| Urgency | Double | False | ||
| UTMTerm | String | False | =,IN | |
| Website | String | False |
Query Named Accounts for a Marketo organization.
Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
SELECT * FROM NamedAccounts WHERE Name='MyNamedAccount1'
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO NamedAccounts (Name, City, Country, DomainName, Industry) VALUES ('testNamedAccountInsert002', 'Chapel Hill', 'USA', 'MyDomain', 'Tech')
This table supports BATCH UPDATE when UseBulkAPI is set to false.
UPDATE NamedAccounts SET NumberOfEmployees=100, State='NC', AnnualRevenue='10000000.00' WHERE Name='testNamedAccountInsert002'
UPDATE NamedAccounts SET NumberOfEmployees=999 WHERE MarketoGUID='197d0ecd-4264-4826-a44a-58a6df1f9ae5'
This table supports BATCH UPSERT when UseBulkAPI is set to false.
UPSERT INTO NamedAccounts (Name, City, Country, DomainName, Industry) VALUES ('testUpsert', 'Chapel Hill', 'USA', 'MyDomain', 'Tech')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM NamedAccounts WHERE Name IN ('MyAccount2', 'MyAccount')
DELETE FROM NamedAccounts WHERE marketoGUID IN ('04da404b-c4e9-40c8-867f-d9fae0062343', 'fd422222-a37f-4c2b-86df-3ed4c22e9c79')
| Name | Type | ReadOnly | Operators | Description |
| MarketoGUID [KEY] | String | True | =,IN | |
| Id | Int | True | =,IN | |
| ApproximateNumOfPeople | Int | True | =,IN | |
| ParentAccountId | Int | True | =,IN | |
| AccountOwnerId | Int | False | =,IN | |
| AccountPhoneNumber | String | False | =,IN | |
| AddressPostalCode | String | False | =,IN | |
| AddressRegion | String | False | =,IN | |
| AnnualRevenue | Decimal | False | =,IN | |
| City | String | False | =,IN | |
| Country | String | False | =,IN | |
| CreatedAt | Datetime | True | ||
| CrmGuid | String | False | =,IN | |
| CrmOrgId | Int | False | =,IN | |
| DomainName | String | False | =,IN | |
| ExternalSourceId | String | False | =,IN | |
| ExternalSourceInstanceId | String | False | =,IN | |
| ExternalSourceKey | String | False | =,IN | |
| ExternalSourceType | String | False | =,IN | |
| Industry | String | False | =,IN | |
| LogoUrl | String | False | =,IN | |
| MembershipCount | Int | True | =,IN | |
| Name | String | False | =,IN | |
| NumberOfEmployees | Int | False | =,IN | |
| OpptyAmount | Decimal | True | =,IN | |
| OpptyCount | Int | True | =,IN | |
| SicCode | String | False | =,IN | |
| SourceType | String | False | =,IN | |
| State | String | False | =,IN | |
| Street1 | String | False | =,IN | |
| UpdatedAt | Datetime | True |
Query Opportunities in Marketo.
Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
Note: A filter must be specified when retrieving Opportunities.
SELECT * FROM Opportunities WHERE ExternalOpportunityId='test2'
SELECT * FROM Opportunities WHERE ExternalCompanyId='CData'
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO Opportunities (ExternalOpportunityId, Description, ExternalCompanyId, Name) VALUES ('testOpportunitiesInsert001', 'First Opportunity', 'cdata', 'Opp')
This table supports BATCH UPDATE when UseBulkAPI is set to false.
UPDATE Opportunities SET IsWon=true, FiscalYear=2016, Amount='1000.00' WHERE ExternalOpportunityId='testOpportunitiesInsert001'
UPDATE Opportunities SET IsWon=false, FiscalYear=2017, Amount='1000.00' WHERE ExternalCompanyId='testInsert_ExternalCompanyId_012'
This table supports BATCH UPSERT when UseBulkAPI is set to false.
UPSERT INTO Opportunities (ExternalOpportunityId, Description, ExternalCompanyId, Name) VALUES ('testUpsert', 'First Opportunity', 'CData', 'Opp')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM Opportunities WHERE ExternalOpportunityId='CDATA2'
DELETE FROM Opportunities WHERE marketoGUID IN ('c1bac835-e5d3-47cc-9c87-bd18fdf573f8', '04ecb93c-d140-4c38-96cc-1fc2821e91eb')
| Name | Type | ReadOnly | Operators | Description |
| CreatedAt | Datetime | True | ||
| ExternalOpportunityId | String | True | =,IN | |
| MarketoGUID [KEY] | String | True | =,IN | |
| UpdatedAt | Datetime | True | ||
| Amount | Decimal | False | ||
| CloseDate | Date | False | ||
| Description | String | False | ||
| ExpectedRevenue | Decimal | False | ||
| ExternalCompanyId | String | False | =,IN | |
| ExternalCreatedDate | Datetime | False | ||
| ExternalSalesPersonId | String | False | =,IN | |
| Fiscal | String | False | ||
| FiscalQuarter | Int | False | ||
| FiscalYear | Int | False | ||
| ForecastCategory | String | False | ||
| ForecastCategoryName | String | False | ||
| IsClosed | Bool | False | ||
| IsWon | Bool | False | ||
| LastActivityDate | Date | False | ||
| LeadSource | String | False | ||
| Name | String | False | ||
| NextStep | String | False | ||
| Probability | Int | False | ||
| Quantity | Double | False | ||
| Stage | String | False | ||
| Type | String | False |
Query Opportunity Roles in Marketo.
Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.
Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
SELECT * FROM OpportunityRoles WHERE externalOpportunityId='test2'
SELECT * FROM OpportunityRoles WHERE ExternalOpportunityId IN ('[email protected]', '[email protected]')
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO OpportunityRoles (ExternalOpportunityId, LeadId, IsPrimary, Role) VALUES ('testOpportunitiesInsert', '12', false, 'Test')
This table supports BATCH UPDATE when UseBulkAPI is set to false.
UPDATE OpportunityRoles SET IsPrimary=true WHERE MarketoGUID='c92c78dd-b869-40dc-bb2b-7cba112e8f50'
UPDATE OpportunityRoles SET IsPrimary=false WHERE ExternalOpportunityId='testOpportunitiesInsert'
UPDATE OpportunityRoles SET IsPrimary=false WHERE ExternalOpportunityId='testOpportunitiesInsert001' AND LeadId=12 AND Role='Test1'
This table supports BATCH UPSERT when UseBulkAPI is set to false.
UPSERT INTO OpportunityRoles (ExternalOpportunityId, LeadId, IsPrimary, Role) VALUES ('testOpportunitiesInsert001', '4', false, 'Test')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM OpportunityRoles WHERE ExternalOpportunityId='CDATA1'
DELETE FROM OpportunityRoles WHERE LeadId IN (4, 6)
DELETE FROM OpportunityRoles WHERE ExternalOpportunityId='CDATA1' AND LeadId=6 AND Role='MyRole2'
| Name | Type | ReadOnly | Operators | Description |
| CreatedAt | Datetime | True | ||
| MarketoGUID [KEY] | String | True | =,IN | |
| UpdatedAt | Datetime | True | ||
| ExternalCreatedDate | Datetime | False | ||
| ExternalOpportunityId | String | False | =,IN | |
| IsPrimary | Bool | False | ||
| LeadId | Int | False | =,IN | |
| Role | String | False |
Query Program Members in Marketo.
UpdateLeadProgramStatus can be used to update the membership status of a lead.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
Note: The REST API throws an error if you query program members for a program with more than 100'000 members. You can set UseBulkAPI to 'true' or 'auto' to automatically use the BULK API to retrieve the records.
SELECT * FROM ProgramMembers WHERE ProgramId=1001
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO ProgramMembers (ProgramId, LeadId, StatusName) VALUES ('1001', 4, 'member')
This table supports BATCH UPDATE when UseBulkAPI is set to false.
UPDATE ProgramMembers SET WebinarURL='wsfldknfs1.com', RegistrationCode='adcff5f12-a7c7-11eb-bcbc-0242ac130001' WHERE LeadId='13' AND ProgramId='1001'
UPDATE ProgramMembers SET WebinarURL='[email protected]/sync' WHERE ProgramId=1001 AND LeadId IN (28, 29, -2)
UPDATE ProgramMembers SET WebinarURL='[email protected]/sync' WHERE ProgramId IN (1001, 1018) AND LeadId IN (12, 14)
This table supports only BULK UPSERT when UseBulkAPI is set to true.
UPSERT INTO OpportunityRoles (ExternalOpportunityId, LeadId, IsPrimary, Role) VALUES ('testOpportunitiesInsert001', '4', false, 'Test')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM ProgramMembers WHERE ProgramId=1001 AND LeadId=21
DELETE FROM ProgramMembers WHERE ProgramId=1001 AND LeadId IN (28, 29, -2)
DELETE FROM ProgramMembers WHERE ProgramId IN (1001, 1018) AND LeadId IN (12, 14, -2)
DELETE FROM ProgramMembers WHERE ProgramId=1001 AND registrationCode='494164'
| Name | Type | ReadOnly | Operators | Description |
| ProgramId [KEY] | Int | False | = |
Id of the program. |
| LeadId [KEY] | Int | False |
Id of the lead. | |
| UpdatedAt | Datetime | True |
Datetime the records was most recently updated. | |
| IsExhausted | Bool | True | ||
| NurtureCadence | String | True | ||
| StatusName | String | False | =,IN | |
| AttendanceLikelihood | Int | True | ||
| CreatedAt | Datetime | True | ||
| MembershipDate | Datetime | True | ||
| Program | String | True | ||
| ReachedSuccess | Bool | True | =,IN | |
| ReachedSuccessDate | Datetime | True | ||
| RegistrationLikelihood | Int | True | ||
| TrackName | String | True | ||
| WaitlistPriority | Int | True | ||
| AcquiredBy | Bool | False | ||
| FlowStep | Int | False | =,IN | |
| RegistrationCode | String | False | ||
| ReiNewCustomField | String | False | =,IN | |
| StatusReason | String | False | ||
| Test99 | Int | False | =,IN | |
| TestCustomObjFd | String | False | =,IN | |
| UTMSource | String | False | =,IN | |
| WebinarUrl | String | False |
Create, update, delete, and query Programs for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Programs WHERE Id=6201
SELECT * FROM Programs WHERE Id IN (6201, 6200, 6152, 6117)
SELECT * FROM Programs WHERE Name='duplicateProgramName'
SELECT * FROM Programs WHERE WorkspaceName='test'
SELECT * FROM Programs WHERE FolderId=48
SELECT * FROM Programs WHERE FolderId=48 AND folderType='Folder'
SELECT * FROM Programs WHERE UpdatedAt >' 2023-03-28T00:19:32.000-04:00'
SELECT * FROM Programs WHERE UpdatedA >=' 2023-03-28T00:19:32.000-04:00'
SELECT * FROM Programs WHERE UpdatedAt =' 2023-03-28T00:19:32.000-04:00'
SELECT * FROM Programs WHERE UpdatedAt <=' 2023-03-28T00:19:32.000-04:00' AND UpdatedAt>'2021-08-11T08:10:01.000Z'
SELECT * FROM Programs WHERE UpdatedAt < '2023-03-28T00:19:32.000-04:00' AND UpdatedAt>'2021-08-11T08:10:01.000Z'
INSERT INTO Programs (Name, FolderId, FolderType, Type, Description, Channel)
VALUES ('test insert program', '6152', 'Program', 'Event', 'Test Insert Description', 'Tradeshow')
UPDATE Programs SET Name='UpdatedProgram', Description='Updated Description' WHERE Id=6224
DELETE FROM Programs WHERE Id=2383
DELETE FROM Programs WHERE Name='Sample0034'
DELETE FROM Programs WHERE ID IN (1064, 1065, 1066, 1067)
DELETE FROM Programs WHERE Name IN ('Sample0035', 'Sample0036', 'Sample0037')
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | =,IN |
The unique, Marketo-assigned identifier of the program. |
| Name | String | False | = |
The name of the program. |
| Description | String | False |
The description of the program. | |
| Type | String | False |
The program type. | |
| Channel | String | False |
The channel the program is associated with. | |
| WorkspaceName | String | True | =,IN |
The name of the workspace where the program is located. |
| URL | String | True |
The URL reference to the program. | |
| Status | String | True |
The status of the program. | |
| FolderId | Int | False | =,IN |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| CreatedAt | Datetime | True |
Datetime the channel was created. | |
| UpdatedAt | Datetime | True | =,>,<,>=,<= |
Datetime the channel was most recently updated. |
Query Sales Persons in Marketo.
Note: This table is only available for Marketo subscriptions which do not have a native CRM sync enabled.
Note: A server-side filter must be specified to query this table. Queries with the 'OR' operator are not supported.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
SELECT * FROM SalesPersons WHERE ExternalSalesPersonId='test SalesPerson'
SELECT * FROM SalesPersons WHERE Id=2520998
SELECT * FROM SalesPersons WHERE Email='[email protected]'
SELECT * FROM SalesPersons WHERE Email IN ('[email protected]', '[email protected]')
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO SalesPersons (ExternalSalesPersonId, Email, FirstName, LastName) VALUES ('testInsertSalesPersons001', '[email protected]', 'Sales', 'Person')
This table supports BATCH UPDATE when UseBulkAPI is set to false.
UPDATE SalesPersons SET Phone='800-123-4567', Title='Technical Sales', Email='[email protected]' WHERE ExternalSalesPersonId='testInsertSalesPersons001'
This table supports BATCH UPSERT when UseBulkAPI is set to false.
UPSERT INTO SalesPersons (ExternalSalesPersonId, Email, FirstName, LastName) VALUES ('testInsertSalesPersons123', '[email protected]', 'Sales', 'Person')
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM SalesPersons WHERE ExternalSalesPersonId='[email protected]'
DELETE FROM SalesPersons WHERE ID='2521702'
DELETE FROM SalesPersons WHERE ID IN (2521703, 2521704)
DELETE FROM SalesPersons WHERE Email='[email protected]'
DELETE FROM SalesPersons WHERE Email IN ('[email protected]', '[email protected]')
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | =,IN | |
| ExternalSalesPersonId | String | True | =,IN | |
| String | False | =,IN | ||
| Fax | String | False | ||
| FirstName | String | False | ||
| LastName | String | False | ||
| MobilePhone | String | False | ||
| Phone | String | False | ||
| Title | String | False | ||
| CreatedAt | Datetime | True | ||
| UpdatedAt | Datetime | True |
Query Smart Campaigns for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM SmartCampaigns WHERE IsActive='False'
SELECT * FROM SmartCampaigns WHERE FolderId=5318 AND FolderType='Folder' AND IsActive='true'
SELECT * FROM SmartCampaigns WHERE UpdatedAt >'2024-01-17T19:19:51Z'
SELECT * FROM SmartCampaigns WHERE UpdatedAt >='2024-01-17T19:19:51Z'
SELECT * FROM SmartCampaigns WHERE UpdatedAt <'2024-01-17T19:19:51Z'
SELECT * FROM SmartCampaigns WHERE UpdatedAt <='2024-01-17T19:19:51Z'
SELECT * FROM SmartCampaigns WHERE UpdatedAt = '2024-01-17T19:19:51Z'
INSERT INTO SmartCampaigns (Name, FolderId, FolderType, Description)
VALUES ('test insert smart campaign', '6152', 'Program', 'Test Insert Description')
UPDATE SmartCampaigns Set Name = 'UpdatedSmartCampaignName', Description = 'CData Campaign' WHERE Id = 1109
DELETE FROM SmartCampaigns WHERE Id=1106
DELETE FROM SmartCampaigns WHERE Name='JET - Test email link reports'
DELETE FROM SmartCampaigns WHERE ID IN (1043, 5318)
DELETE FROM SmartCampaigns WHERE Name IN ('TestCampaign1', 'RCM Success Only (v1) Known --> Engaged', 'Update Segmentation [1001](1001)')
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
Id of the smart campaign. |
| ParentProgramId | Int | True |
The id of the parent program. Present if smart campaign is under program or nested folder | |
| Name | String | False |
Name of the smart campaign. | |
| Description | String | False |
Description of the smart campaign. | |
| Type | String | True |
The type of the the smart campaign. Batch: has at least one filter and no triggers. Trigger: has at least one trigger. Default: has no smart list rules. | |
| ComputedUrl | String | True |
The Computed Url of the Smart Campaign | |
| Status | String | True |
The status of the smart campaign. | |
| IsSystem | Bool | True |
Whether smart campaign is system managed. | |
| IsActive | Bool | True | = |
Whether smart campaign is active. |
| IsRequestable | Bool | True |
Whether smart campaign is requestable (is active and contains 'Campaign is Requested' trigger with Source of 'Web Service API'). | |
| IsCommunicationLimitEnabled | Bool | True |
Whether smart campaign communication limit is enabled (i.e. block non-operational emails). | |
| MaxMembers | Int | True |
The smart campaign membership limit. | |
| SmartListId | Int | True |
The Id of the smart campaign's child smart list. | |
| FlowId | Int | True |
The Id of the smart campaign's child flow. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| WorkspaceName | String | True |
Name of the workspace the smart campaign is part of. | |
| QualificationRuleType | String | True |
The type of qualification rule. | |
| QualificationRuleInterval | Int | True |
The interval of qualification rule. Only set when qualificationRuleType is 'interval' | |
| QualificationRuleUnit | String | True |
The unit of measure of qualification rule. Only set when qualificationRuleType is 'interval' = ['hour', 'day', 'week', 'month'] | |
| RecurrenceStartAt | Datetime | True |
The datetime of the first scheduled campaign to run. Required if setting recurrence. Not required to create a smart campaign that has no recurrence. | |
| RecurrenceEndAt | Datetime | True |
The datetime after which no further runs will be automatically scheduled. | |
| RecurrenceIntervalType | String | True |
The recurrence interval. Not required to create a smart campaign that has no recurrence = ['Daily', 'Weekly', 'Monthly']. | |
| RecurrenceInterval | Int | True |
The number of interval units between recurrences. | |
| RecurrenceWeekDayOnly | Bool | True |
Only run smart campaign on weekdays. May only be set if intervalType is 'Daily'. | |
| RecurrenceWeekDayMask | String | True |
String array of empty or one or more of 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'. May only be set if intervalType is 'Weekly'. | |
| RecurrenceDayOfMonth | Int | True |
The day of the month to recur. Permissible range 1-31. May only be set if intervalType is 'Monthly' and dayOfWeek and weekOfMonth are unset. | |
| RecurrenceDayOfWeek | String | True |
The day of the week to recur. May only be set if dayOfMonth is not set, and weekOfMonth is set = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']. | |
| RecurrenceWeekOfMonth | Int | True |
The week of the month to recur. Permissible range 1-4. May only be set if dayOfMonth is not set, and dayOfWeek is set. | |
| CreatedAt | Datetime | True |
Datetime the smart campaign was created. | |
| UpdatedAt | Datetime | True | =,>,<,>=,<= |
Datetime the smart campaign was most recently updated. |
Query Smart Lists for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM SmartLists WHERE Id='1093'
SELECT * FROM SmartLists WHERE Name='LeadSmartListTest'
SELECT * FROM SmartLists WHERE FolderId=7
SELECT * FROM SmartLists WHERE ProgramId=6116
SELECT * FROM SmartLists WHERE SmartCampaignId=1043
SELECT * FROM SmartLists WHERE UpdatedAt = '2021-02-02T08:26:01Z'
SELECT * FROM SmartLists WHERE UpdatedAt > '2021-02-02T08:26:01Z'
SELECT * FROM SmartLists WHERE UpdatedAt >= '2021-02-02T08:26:01Z'
SELECT * FROM SmartLists WHERE UpdatedAt <' 2022-06-08T06:17:24Z'
SELECT * FROM SmartLists WHERE UpdatedAt <=' 2022-06-08T06:17:24Z'
DELETE FROM SmartLists WHERE Id=3991
DELETE FROM SmartLists WHERE ID IN (3560, 1266, 3999)
DELETE FROM SmartLists WHERE Name='TestProgram Opportunities'
DELETE FROM SmartLists WHERE Name IN ('test_from_ui', 'JET - email tests')
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | False | = |
Id of the smart list. |
| Name | String | False | = |
Name of the smart list. |
| Description | String | False |
Description of the smart list. | |
| URL | String | False |
The URL of the smart list in the Marketo UI | |
| WorkspaceName | String | False |
Name of the workspace the smart list is part of. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| CreatedAt | Datetime | False |
Datetime the smart list was created. | |
| UpdatedAt | Datetime | False | =,>,<,>=,<= |
Datetime the smart list was most recently updated. |
| SmartCampaignId | Int | False | = |
Mirror column that can be used only as a filter. Will retrieve SmartLists related to the given SmartCampaignId. |
| ProgramId | Int | False | = |
Mirror column that can be used only as a filter. Will retrieve SmartLists related to the given email ProgramId. |
Create, update, delete and query snippets for a Marketo organization.
GetSnippetContent can be used to get the content of a snippet.
UpdateSnippetContent can be used to update the content of a snippet.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Snippets WHERE status='approved'
SELECT * FROM Snippets WHERE Id='9'
SELECT * FROM Snippets WHERE Id='9' AND Status='approved'
INSERT INTO Snippets (Name, FolderId, FolderType, Description)
VALUES ('test insert smart snippet', '31', 'Folder', 'Test Insert Description')
UPDATE Snippets SET Description='Testing Update', IsArchive='true', Name='Test Update' WHERE Id=12
DELETE FROM Snippets WHERE Id=7
DELETE FROM Snippets WHERE Name='My Snippet2'
DELETE FROM Snippets WHERE ID IN (1, 9, 111)
DELETE FROM Snippets WHERE Name IN ('My Snippet1', 'My Snippet11')
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
The unique, Marketo-assigned identifier of the snippet. |
| Status [KEY] | String | True | = |
Status filter for draft or approved versions. |
| Name | String | False |
The name of the snippet. | |
| Description | String | False |
The description of the snippet. | |
| URL | String | True |
The URL of the snippet in the Marketo UI. | |
| WorkspaceName | String | True |
Workspace name of the asset. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| CreatedAt | Datetime | True |
Datetime the snippet was created. | |
| UpdatedAt | Datetime | True |
Datetime the snippet was most recently updated. |
Query relations of static lists and leads in Marketo.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM StaticListMembership WHERE ListId='1014'
SELECT * FROM StaticListMembership WHERE LeadId='4'
Other queries partialy server-side:
SELECT * FROM StaticListMembership WHERE ListId IN (1014, 1044, 1057)
SELECT * FROM StaticListMembership WHERE LeadId IN (4, 9999, 1199433)
SELECT * FROM StaticListMembership WHERE ListId=1014 AND LeadId=1199433
SELECT * FROM StaticListMembership WHERE ListId=1014 AND LeadId IN (4, 9999, 1199433, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
This table supports BATCH INSERT when UseBulkAPI is set to false.
INSERT INTO StaticListMemberShip (ListId, LeadId) VALUES (1014, 4)
INSERT INTO StaticListMemberShip (ListId, LeadId) VALUES (1014, 4), (1014, 8), (1014, 12), (1014, 21)
INSERT INTO StaticListMemberShip (ListId, LeadId) VALUES (1014, 4), (1014, 8), (1014, 12), (1014, 21), (1349, 4), (1349, 8), (1062, 8), (1349, 21), (1349, 22)
This table supports BATCH DELETE when UseBulkAPI is set to false.
DELETE FROM StaticListMembership WHERE ListId=1057 AND LeadId=1083278
DELETE FROM StaticListMembership WHERE ListId=1057 AND LeadId IN (1083292, 1083293, 1199432)
DELETE FROM StaticListMembership WHERE ListId=1057
DELETE FROM StaticListMembership WHERE LeadId=9999
DELETE FROM StaticListMembership WHERE ListId IN (1057, 1568) AND LeadId IN (1083292, 1083293, 1199432, 1199433, 2521698)
DELETE FROM StaticListMembership WHERE LeadId IN (1083292, 1083293, 1199432, 1199433, 2521698, 4, 5, 6, 7, 8, 9, 10)
| Name | Type | ReadOnly | Operators | Description |
| ListId [KEY] | Int | False | = |
Id of the static list. |
| LeadId [KEY] | Int | False | = |
Id of the Lead. |
Query Static Lists for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM StaticLists WHERE Id='1556'
SELECT * FROM StaticLists WHERE Name='Anti-Smart List'
SELECT * FROM StaticLists WHERE FolderId='12'
SELECT * FROM StaticLists WHERE FolderType='Folder'
SELECT * FROM StaticLists WHERE FolderId='6113' AND FolderType='Program'
SELECT * FROM StaticLists WHERE UpdatedAt = '2024-01-17T14:31:26.000'
SELECT * FROM StaticLists WHERE UpdatedAt > '2023-06-07T08:00:01.000'
SELECT * FROM StaticLists WHERE UpdatedAt >= '2023-06-07T08:00:01.000'
SELECT * FROM StaticLists WHERE UpdatedAt < '2023-06-07T08:00:01.000'
SELECT * FROM StaticLists WHERE UpdatedAt <= '2023-06-07T08:00:01.000'
SELECT * FROM StaticLists WHERE UpdatedAt >= '2022-09-01T14:08:37.000' AND UpdatedAt < '2023-10-06T10:43:02.000'
INSERT INTO StaticLists (Name, FolderId, FolderType, Description) VALUES ('test insert StaticLists', '6152', 'Program', 'Test Insert Description')
UPDATE StaticLists Set Name = 'UpdatedStaticList', Description = 'CData StaticList' WHERE Id = 1570
DELETE FROM StaticLists WHERE Id=1561
DELETE FROM StaticLists WHERE Name='test'
DELETE FROM StaticLists WHERE ID IN (1563, 1564, 1565, 111)
DELETE FROM StaticLists WHERE Name IN ('test46AU1gBBg1', 'asd', 'testsDxzV3BAqn')
| Name | Type | ReadOnly | Operators | Description |
| Id [KEY] | Int | True | = |
Id of the static list. |
| Name | String | False | = |
Name of the static list. |
| Description | String | False |
Description of the static list. | |
| ComputedURL | String | True |
Computed URL of static list. | |
| WorkspaceName | String | True |
Name of the workspace the static list is part of. | |
| FolderId | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderName | String | True |
The name of the folder | |
| FolderType | String | False | = |
The type of folder (Folder,Program) |
| CreatedAt | Datetime | True |
Datetime the static list was created. | |
| UpdatedAt | Datetime | True | =,>,<,>=,<= |
Datetime the static list was most recently updated. |
Create, delete, and query Tokens for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Tokens WHERE folderId=70
SELECT * FROM Tokens WHERE folderId=70 and FolderType='Folder'
INSERT INTO Tokens (Name, Type, Value, FolderId, FolderType) VALUES ('test insert token', 'text', 'test token value', 5365, 'Folder')
DELETE FROM Tokens WHERE FolderId=1111 AND FolderType='Program' AND Name='testname2' AND Type='text'
DELETE FROM Tokens WHERE FolderId=1112 AND FolderType='Program' AND Name='test'
DELETE FROM Tokens WHERE FolderId=1112
| Name | Type | ReadOnly | Operators | Description |
| Name [KEY] | String | False |
The name of the Token. | |
| Type [KEY] | String | False |
The data type of the Token. The supported values are date, number, rich text, score, sfdc campaign and text | |
| Value | String | False |
The value of the Token. | |
| ComputedURL | String | False |
The Computed URL of the Token. | |
| FolderId [KEY] | Int | False | = |
The unique, Marketo-assigned identifier of the parent folder/program. |
| FolderType [KEY] | String | False | = |
The type of folder (Folder,Program) |
Query users for a Marketo organization.
Note: Insert queries are not supported. Users can be invited using the InviteUser stored procedure. Invited users can be retrieved using the GetInvitedUserById stored procedure. Invited users can be deleted using the DeleteInvitedUser stored procedure.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following queries are processed server-side:
SELECT * FROM Users WHERE UserId='[email protected]'
UPDATE USERS SET EmailAddress='[email protected]', FirstName='updated', LastName='updated', ExpiresAt='2024-12-12T00:00:00-01:00' WHERE UserId='[email protected]'
DELETE FROM USERS WHERE UserId='[email protected]'
| Name | Type | ReadOnly | Operators | Description |
| UserId [KEY] | String | True | = |
The user id in the form of an email address. |
| Id | Integer | True |
The user identifier. | |
| EmailAddress | String | False |
The user's email address. | |
| FirstName | String | False |
The user's first name. | |
| LastName | String | False |
The user's last name. | |
| APIOnly | Boolean | True |
Whether the user is API-Only. | |
| ExpiresAt | Datetime | False |
The date and time when the user login expires. | |
| LastLoginAt | Datetime | True |
The date and time of user's most recent login. | |
| FailedLogins | Integer | True |
Count of user login failures. | |
| FailedDeviceCode | Integer | True |
Device code for user login failure. | |
| IsLocked | Boolean | True |
Whether the user account is locked. | |
| LockedReason | String | True |
Reason that user account is locked. | |
| OptedIn | Boolean | True |
Whether user has opted in. | |
| UserWorkspaceRoles | String | True |
Array of user roles and workspaces. |
Query user roles for each workspace in Marketo.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
For example, the following query is processed server-side:
SELECT * FROM UserWorkspaceRoles WHERE UserId='[email protected]'
INSERT INTO UserWorkspaceRoles (UserId, WorkspaceId, AccessRoleId) VALUES ('[email protected]', 0, 1002)
DELETE FROM UserWorkspaceRoles WHERE UserId='[email protected]' AND AccessRoleId=1002 AND WorkspaceId=0;
| Name | Type | ReadOnly | Operators | Description |
| UserId [KEY] | String | False | = |
The user id in the form of an email address. |
| AccessRoleId [KEY] | Integer | False |
The user role id. | |
| AccessRoleName | String | False |
The user role name. | |
| WorkspaceId [KEY] | Integer | False |
The workspace id. | |
| WorkspaceName | String | False |
The workspace name. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| Activities | Retrieve activities of different types after a specific datetime. |
| Activities_AddtoList | Add a person/record to a list |
| Activities_AddtoNurture | Add a lead to a nurture program |
| Activities_AddtoOpportunity | Add to an Opportunity |
| Activities_Asksquestionsinwebinar | Lead asks questions in a webinar event |
| Activities_Assetdownloadsinwebinar | Lead downloads file/asset in a webinar event |
| Activities_Calltoactionclickedinwebinar | Lead clicks on a Call to Action Link in a webinar event |
| Activities_CallWebhook | Call a Webhook |
| Activities_ChangeDataValue | Changed attribute value for a person/record |
| Activities_ChangeLeadPartition | Lead partition is changed for a lead |
| Activities_ChangeNurtureCadence | Change the nurture cadence for a lead |
| Activities_ChangeNurtureTrack | Change the nurture track for a lead |
| Activities_ChangeProgramMemberData | Change Program Member Data |
| Activities_ChangeRevenueStage | Modify the value of a revenue stage field |
| Activities_ChangeRevenueStageManually | Revenue stage is changed manually (e.g. Lead Database or Salesforce) |
| Activities_ChangeScore | Modify the value of a score field |
| Activities_ChangeSegment | Change segment (within a segmentation) for a lead |
| Activities_ChangeStatusinProgression | Change a Status in an program progression |
| Activities_ClickEmail | User clicks on a link in a Marketo Email |
| Activities_ClickLink | User clicks link on a page |
| Activities_ClickSalesEmail | User clicks on a link in a sales Email |
| Activities_CreateBuyingGroup | Create Buying Group |
| Activities_DeleteLead | Delete lead from Marketo database |
| Activities_EmailBounced | Marketo Email is bounced for a lead |
| Activities_EmailBouncedSoft | Campaign Email is bounced soft for a lead |
| Activities_EmailDelivered | Marketo Email is delivered to a lead/contact |
| Activities_EngagedwithaConversationalFlow | Lead engages with Dynamic Chat conversational flow |
| Activities_EngagedwithaDialogue | Lead engages with Dynamic Chat dialogue |
| Activities_EngagedwithanAgentinConversationalFlow | Lead engages with an Agent in Dynamic Chat conversational flow |
| Activities_EngagedwithanAgentinDialogue | Lead engages with an Agent in Dynamic Chat dialogue |
| Activities_ExecuteCampaign | Invoke an executable campaign |
| Activities_FillOutForm | User fills out and submits a form on web page |
| Activities_Hasattendedevent | Has attended event |
| Activities_InteractedwithDocumentinConversationalFlow | Lead interacts with a document in Dynamic Chat conversational flow |
| Activities_InteractedwithDocumentinDialogue | Lead interacts with a document in Dynamic Chat dialogue |
| Activities_MergeLeads | Merge two or more leads into a single record |
| Activities_NewLead | New person/record is added to the lead database |
| Activities_OpenEmail | User opens Marketo Email |
| Activities_OpenSalesEmail | User opens a sales Email |
| Activities_PushLeadtoMarketo | Generated schema file. |
| Activities_ReachedConversationalFlowGoal | Lead reaches a goal in Dynamic Chat conversational flow |
| Activities_ReachedDialogueGoal | Lead reaches a goal in Dynamic Chat dialogue |
| Activities_ReceivedForwardtoFriendEmail | User receives forwarded Email from friend |
| Activities_ReceiveSalesEmail | Receive Email using Sales View (Outlook Plugin) |
| Activities_RemovefromList | Remove this lead from a list |
| Activities_RemovefromOpportunity | Remove from an Opportunity |
| Activities_ReplytoSalesEmail | User replies to a sales email |
| Activities_RequestCampaign | Campaign membership is requested for lead |
| Activities_Respondedtoapollinwebinar | Lead responds to a poll in a webinar event |
| Activities_SalesEmailBounced | Sales Email bounced |
| Activities_ScheduledMeetinginConversationalFlow | Lead schedules an appointment in Dynamic Chat conversational flow |
| Activities_ScheduledMeetinginDialogue | Lead schedules an appointment in Dynamic Chat dialogue |
| Activities_SendAlert | Send alert Email about a lead |
| Activities_SendEmail | Send Marketo Email to a person |
| Activities_SendSalesEmail | Send Email using Sales View (Outlook Plugin) |
| Activities_SentForwardtoFriendEmail | User Forwards Email to a person/record |
| Activities_ShareContent | Share Content |
| Activities_UnsubscribeEmail | Person unsubscribed from Marketo Emails |
| Activities_UpdateOpportunity | Update an Opportunity |
| Activities_VisitWebpage | User visits a web page |
| ActivityTypes | Get available activity types. |
| ActivityTypesAttributes | Get available activity type attributes. |
| BulkExportJobs | Returns a list of bulk export jobs that were created in the past 7 days. |
| Campaigns | Query Campaigns for a Marketo organization. |
| ChannelProgressionStatuses | Query ProgressionStatuses of Channels for a Marketo organization. |
| Channels | Query Channels for a Marketo organization. |
| DailyErrorStatistics | Retrieve the count of each error users have encountered in the current day. |
| DailyUsageStatistics | Retrieve the number of API calls that specific users have consumed in the current day. |
| EmailCCFields | Query Emails CC Fields for a Marketo organization. |
| EmailTemplatesUsedBy | Query email records which depend on a given email template. |
| Files | Query files for a Marketo organization. |
| FolderContents | Query Folders contents for a Marketo organization. |
| LandingPageTemplateContent | Query landing page template contents for a Marketo organization. |
| LeadChanges | Query Lead changes. |
| LeadChangesAttributes | Query Lead changes attributes. |
| LeadChangesFields | Query fields of lead changes. |
| LeadPartitions | Query Lead Partitions for a Marketo organization. |
| LeadPrograms | Query program membership for leads. |
| Lists | Query Static Lists for a Marketo organization from the Leads API. |
| ListStaticMemberShip | Query leads of a static list in Marketo. |
| ProgramCosts | Query, insert and delete program cost relations for a Marketo organization. |
| ProgramTags | Query tags relations for a Marketo organization. |
| Roles | Query roles. Requires permissions: 'Access User Management Api' and 'Access Users'. |
| Segmentations | Query segmentations for a Marketo organization. |
| Segments | Query segments for a Marketo organization. |
| SmartListFilterConditions | Query filters of smart lists in a Marketo organization. |
| SmartListFilters | Query filters of smart lists in a Marketo organization. |
| SmartListTriggers | Query rules of smart lists in a Marketo organization. |
| TagAllowedValues | Query allowed values for tags in a Marketo organization. |
| Tags | Query tags for a Marketo organization. |
| ThankYouList | Query form thank you pages for a Marketo organization. |
| WeeklyErrorStatistics | Retrieve the count of each error users have encountered in the past 7 days. |
| WeeklyUsageStatistics | Retrieve the number of API calls that specific users have consumed in the past 7 days. |
| Workspaces | Retrieve workspaces. Requires permissions: 'Access User Management Api' and 'Access Users'. |
Retrieve activities of different types after a specific datetime.
Each activity type in your Marketo organization is returned as a separate table. Each table name is prefixed with 'Activities_' followed by the name of the activity type. Activities are pushed as views. Custom activities are pushed as tables CustomActivities
All activities tables support BULK SELECT when UseBulkAPI is set to true.
By default, this view retrieves all activity types from the creation of Marketo.
It is advised to provide a filter for ActivityTypeId and ActivityDate, or to make use of tables such as Activities_AddtoList, Activities_AddtoNurture, Activities_AddtoOpportunity, which are linked to a specific activity type.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Activities WHERE ActivityDate > '2024-01-01T00:00:00Z'
SELECT * FROM Activities WHERE ActivityDate >= ' 2024-01-01T00:00:00Z' AND ActivityDate <= '2024-03-01T00:00:00Z'
SELECT * FROM Activities WHERE ListId = '1014' AND ActivityDate > '2024-01-01T00:00:00Z'
SELECT * FROM Activities WHERE ListId = '1014' AND ActivityTypeId = '13'
SELECT * FROM Activities WHERE ListId = '1014' AND ActivityTypeId = '13' AND ActivityDate > ' 2024-01-01T00:00:00Z'
SELECT * FROM Activities WHERE ActivityTypeId = 24
SELECT * FROM Activities WHERE ActivityTypeId IN (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13)
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| ActivityTypeId | Int | =,IN | Id of the activity type. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| PrimaryAttributeValueId | Int | Id of the primary attribute field. | |
| PrimaryAttributeValue | String | Value of the primary attribute. | |
| Attributes | String | JSON aggregate containing the list of attribute key value pair for this activity. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
Add a person/record to a list
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListID | Int | = | |
| ListIDValue | String | ||
| Source | String |
Add a lead to a nurture program
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| TrackID | Int | ||
| TrackName | String |
Add to an Opportunity
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| OpptyID | Int | ||
| OpptyIDValue | String | ||
| IsPrimary | Bool | ||
| Role | String |
Lead asks questions in a webinar event
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| Question | String | ||
| Questionwasanswered | Bool |
Lead downloads file/asset in a webinar event
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| Downloadedasset | String |
Lead clicks on a Call to Action Link in a webinar event
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| Linkclicked | String |
Call a Webhook
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| Webhook | Int | ||
| WebhookValue | String | ||
| ErrorType | Int | ||
| Response | String |
Changed attribute value for a person/record
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| AttributeName | Int | ||
| AttributeNameValue | String | ||
| NewValue | String | ||
| OldValue | String | ||
| Reason | String | ||
| Source | String | ||
| APIMethodName | String | ||
| ModifyingUser | String | ||
| RequestId | String |
Lead partition is changed for a lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| NewPartitionID | Int | ||
| NewPartitionIDValue | String | ||
| OldPartitionID | Int | ||
| Reason | String |
Change the nurture cadence for a lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| NewNurtureCadence | String | ||
| PreviousNurtureCadence | String |
Change the nurture track for a lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| NewTrackID | Int | ||
| PreviousTrackID | Int | ||
| TrackName | String | ||
| PreviousTrackName | String |
Change Program Member Data
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| AttributeName | Int | ||
| NewValue | String | ||
| OldValue | String | ||
| Reason | String | ||
| Source | String | ||
| AttributeDisplayName | String |
Modify the value of a revenue stage field
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ModelID | Int | ||
| ModelIDValue | String | ||
| NewStageID | Int | ||
| OldStageID | Int | ||
| SLAExpiration | Datetime | ||
| Reason | String | ||
| NewStage | String | ||
| OldStage | String |
Revenue stage is changed manually (e.g. Lead Database or Salesforce)
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| PrimaryAttributeValueId | Int | Id of the primary attribute field. | |
| PrimaryAttributeValue | String | Value of the primary attribute. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
Modify the value of a score field
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ScoreName | Int | ||
| ScoreNameValue | String | ||
| ChangeValue | String | ||
| NewValue | Int | ||
| OldValue | Int | ||
| Reason | String |
Change segment (within a segmentation) for a lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| SegmentationID | Int | ||
| SegmentationIDValue | String | ||
| NewSegmentID | Int |
Change a Status in an program progression
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| NewStatusID | Int | ||
| OldStatusID | Int | ||
| Reason | String | ||
| AcquiredBy | Bool | ||
| Success | Bool | ||
| ProgramMemberID | Int | ||
| ReachedSuccessDate | Datetime | ||
| StatusReason | String | ||
| WebinarURL | String | ||
| RegistrationCode | String | ||
| NewStatus | String | ||
| OldStatus | String |
User clicks on a link in a Marketo Email
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int | ||
| Link | String | ||
| TestVariant | Int | ||
| LinkID | String | ||
| IsMobileDevice | Bool | ||
| Device | String | ||
| Platform | String | ||
| UserAgent | String | ||
| CampaignRunID | Int | ||
| IsPredictive | Bool | ||
| IsBotActivity | Bool | ||
| BotActivityPattern | String | ||
| Browser | String |
User clicks link on a page
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| LinkID | Int | ||
| LinkIDValue | String | ||
| WebpageID | Int | ||
| QueryParameters | String | ||
| ClientIPAddress | String | ||
| ReferrerURL | String | ||
| UserAgent | String | ||
| Browser | String | ||
| Platform | String | ||
| Device | String |
User clicks on a link in a sales Email
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ArtifactID | Int | ||
| ArtifactIDValue | String | ||
| Sentby | String | ||
| Link | String | ||
| TemplateID | Int | ||
| CampaignRunID | Int | ||
| IsPredictive | Bool | ||
| Source | String | ||
| SalesTemplateURL | String | ||
| SalesCampaignURL | String | ||
| SalesTemplateName | String | ||
| SalesCampaignName | String | ||
| MarketoSalesPersonID | Int | ||
| SalesEmailURL | String | ||
| IsBotActivity | Bool | ||
| BotActivityPattern | String |
Create Buying Group
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| PrimaryAttributeValueId | Int | Id of the primary attribute field. | |
| PrimaryAttributeValue | String | Value of the primary attribute. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| BuyingGroupId | Int | ||
| BuyingGroupTemplateId | Int | ||
| SolutionInterestId | Int | ||
| MarketoGUID | Int |
Delete lead from Marketo database
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| LeadIDValue | String | ||
| RemovefromCRM | Bool | ||
| APIMethodName | String | ||
| ModifyingUser | String | ||
| RequestId | String |
Marketo Email is bounced for a lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int | ||
| Category | String | ||
| Details | String | ||
| Subcategory | String | ||
| String | |||
| TestVariant | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Browser | String | ||
| Platform | String | ||
| Device | String | ||
| UserAgent | String |
Campaign Email is bounced soft for a lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int | ||
| Category | String | ||
| Details | String | ||
| Subcategory | String | ||
| String | |||
| TestVariant | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Browser | String | ||
| Platform | String | ||
| Device | String | ||
| UserAgent | String |
Marketo Email is delivered to a lead/contact
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int | ||
| TestVariant | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Browser | String | ||
| Platform | String | ||
| Device | String | ||
| UserAgent | String |
Lead engages with Dynamic Chat conversational flow
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ConversationalFlowID | Int | ||
| ConversationalFlowIDValue | String | ||
| ConversationalFlowName | String | ||
| PageURL | String | ||
| ConversationStatus | String | ||
| ConversationTranscript | String | ||
| ConversationSummary | String | ||
| SourceType | String | ||
| SourceName | String | ||
| InteractedUIType | String | ||
| Language | String | ||
| Workspace | String | ||
| DiscussedTopics | String | ||
| ConversationScore | Int |
Lead engages with Dynamic Chat dialogue
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| DialogueID | Int | ||
| DialogueIDValue | String | ||
| DialogueName | String | ||
| PageURL | String | ||
| ConversationStatus | String | ||
| ConversationTranscript | String | ||
| ConversationSummary | String | ||
| Language | String | ||
| Workspace | String | ||
| DiscussedTopics | String | ||
| ConversationScore | Int |
Lead engages with an Agent in Dynamic Chat conversational flow
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ConversationalFlowID | Int | ||
| ConversationalFlowIDValue | String | ||
| ConversationalFlowName | String | ||
| PageURL | String | ||
| AgentID | Int | ||
| AgentEmail | String | ||
| AgentName | String | ||
| RoutingQueueID | Int | ||
| RoutingQueueType | String | ||
| RoutingQueueName | String | ||
| ConversationTranscript | String | ||
| ConversationSummary | String | ||
| ConversationStatus | String | ||
| DiscussedTopics | String | ||
| ConversationScore | Int |
Lead engages with an Agent in Dynamic Chat dialogue
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| DialogueID | Int | ||
| DialogueIDValue | String | ||
| DialogueName | String | ||
| PageURL | String | ||
| AgentID | Int | ||
| AgentEmail | String | ||
| AgentName | String | ||
| RoutingQueueID | Int | ||
| RoutingQueueType | String | ||
| RoutingQueueName | String | ||
| ConversationTranscript | String | ||
| ConversationSummary | String | ||
| ConversationStatus | String | ||
| DiscussedTopics | String | ||
| ConversationScore | Int |
Invoke an executable campaign
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| CampaignIDValue | String | ||
| Qualified | Bool | ||
| UsedParentCampaignTokenContext | Bool | ||
| TokenContextCampaignID | Int |
User fills out and submits a form on web page
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| WebformID | Int | ||
| WebformIDValue | String | ||
| FormFields | String | ||
| WebpageID | Int | ||
| QueryParameters | String | ||
| ClientIPAddress | String | ||
| ReferrerURL | String | ||
| UserAgent | String | ||
| Browser | String | ||
| Platform | String | ||
| Device | String |
Has attended event
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| Numberofpollresponses | Int | ||
| Numberofansweredquestions | Int | ||
| Numberofunansweredquestions | Int | ||
| Livewatchtimebypercent | Int | ||
| NumberofCTAsclicked | Int | ||
| Numberofassetsdownloaded | Int | ||
| EventMode | String | ||
| Watchdurationinminutes | Int | ||
| WatchedDate | Datetime |
Lead interacts with a document in Dynamic Chat conversational flow
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| DocumentID | Int | ||
| DocumentIDValue | String | ||
| DocumentName | String | ||
| DocumentURL | String | ||
| ConversationalFlowID | Int | ||
| ConversationalFlowName | String | ||
| PageURL | String | ||
| DocumentOpened | Bool | ||
| DocumentDownloaded | Bool | ||
| SearchTerms | String | ||
| Language | String | ||
| Workspace | String |
Lead interacts with a document in Dynamic Chat dialogue
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| DocumentID | Int | ||
| DocumentIDValue | String | ||
| DocumentName | String | ||
| DocumentURL | String | ||
| DialogueID | Int | ||
| DialogueName | String | ||
| PageURL | String | ||
| DocumentOpened | Bool | ||
| DocumentDownloaded | Bool | ||
| SearchTerms | String | ||
| Language | String | ||
| Workspace | String |
Merge two or more leads into a single record
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| LeadIDValue | String | ||
| MergeIDs | String | ||
| MasterUpdated | Bool | ||
| MergedinSales | Bool | ||
| MergeSource | String | ||
| APIMethodName | String | ||
| ModifyingUser | String | ||
| RequestId | String |
New person/record is added to the lead database
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| PrimaryAttributeValueId | Int | Id of the primary attribute field. | |
| PrimaryAttributeValue | String | Value of the primary attribute. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| SourceType | String | ||
| FormName | String | ||
| ListName | String | ||
| SFDCType | String | ||
| LeadSource | String | ||
| CreatedDate | Date | ||
| APIMethodName | String | ||
| ModifyingUser | String | ||
| RequestId | String |
User opens Marketo Email
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int | ||
| TestVariant | Int | ||
| IsMobileDevice | Bool | ||
| Device | String | ||
| Platform | String | ||
| UserAgent | String | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| IsBotActivity | Bool | ||
| BotActivityPattern | String | ||
| Browser | String |
User opens a sales Email
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ArtifactID | Int | ||
| ArtifactIDValue | String | ||
| Sentby | String | ||
| TemplateID | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Source | String | ||
| SalesTemplateURL | String | ||
| SalesCampaignURL | String | ||
| SalesTemplateName | String | ||
| SalesCampaignName | String | ||
| MarketoSalesPersonID | Int | ||
| SalesEmailURL | String | ||
| IsBotActivity | Bool | ||
| BotActivityPattern | String |
Generated schema file.
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| Source | String | ||
| Reason | String | ||
| APIMethodName | String | ||
| ModifyingUser | String | ||
| RequestId | String |
Lead reaches a goal in Dynamic Chat conversational flow
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ConversationalFlowID | Int | ||
| ConversationalFlowIDValue | String | ||
| GoalName | String | ||
| ConversationalFlowName | String | ||
| PageURL | String | ||
| Language | String | ||
| Workspace | String |
Lead reaches a goal in Dynamic Chat dialogue
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| DialogueID | Int | ||
| DialogueIDValue | String | ||
| GoalName | String | ||
| PageURL | String | ||
| DialogueName | String | ||
| Language | String | ||
| Workspace | String |
User receives forwarded Email from friend
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int |
Receive Email using Sales View (Outlook Plugin)
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ArtifactID | Int | ||
| ArtifactIDValue | String | ||
| Receivedby | String | ||
| Source | String |
Remove this lead from a list
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListID | Int | = | |
| ListIDValue | String | ||
| Source | String |
Remove from an Opportunity
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| OpptyID | Int | ||
| OpptyIDValue | String | ||
| IsPrimary | Bool | ||
| Role | String |
User replies to a sales email
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ArtifactID | Int | ||
| ArtifactIDValue | String | ||
| Sentby | String | ||
| TemplateID | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Source | String | ||
| SalesTemplateURL | String | ||
| SalesCampaignURL | String | ||
| SalesTemplateName | String | ||
| SalesCampaignName | String | ||
| MarketoSalesPersonID | Int | ||
| SalesEmailURL | String |
Campaign membership is requested for lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| CampaignIDValue | String | ||
| Source | String |
Lead responds to a poll in a webinar event
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ProgramID | Int | ||
| ProgramIDValue | String | ||
| Pollquestion | String | ||
| Pollresponse | String |
Sales Email bounced
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ArtifactID | Int | ||
| ArtifactIDValue | String | ||
| Sentby | String | ||
| Category | String | ||
| Details | String | ||
| Subcategory | String | ||
| String | |||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| TemplateID | Int | ||
| MarketoSalesPersonID | Int | ||
| Source | String |
Lead schedules an appointment in Dynamic Chat conversational flow
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| AgentID | Int | ||
| AgentIDValue | String | ||
| AgentEmail | String | ||
| AgentName | String | ||
| ConversationalFlowID | Int | ||
| ConversationalFlowName | String | ||
| PageURL | String | ||
| MeetingStatus | String | ||
| ScheduledFor | Datetime | ||
| RoutingQueueID | Int | ||
| RoutingQueueType | String | ||
| RoutingQueueName | String |
Lead schedules an appointment in Dynamic Chat dialogue
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| AgentID | Int | ||
| AgentIDValue | String | ||
| AgentEmail | String | ||
| AgentName | String | ||
| DialogueID | Int | ||
| DialogueName | String | ||
| PageURL | String | ||
| MeetingStatus | String | ||
| ScheduledFor | Datetime | ||
| RoutingQueueID | Int | ||
| RoutingQueueType | String | ||
| RoutingQueueName | String |
Send alert Email about a lead
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| SendToOwner | String | ||
| SendToSmartList | String | ||
| SendToList | String |
Send Marketo Email to a person
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int | ||
| TestVariant | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Browser | String | ||
| Platform | String | ||
| Device | String | ||
| UserAgent | String |
Send Email using Sales View (Outlook Plugin)
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| ArtifactID | Int | ||
| ArtifactIDValue | String | ||
| Sentby | String | ||
| TemplateID | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Source | String | ||
| SalesTemplateURL | String | ||
| SalesCampaignURL | String | ||
| SalesTemplateName | String | ||
| SalesCampaignName | String | ||
| MarketoSalesPersonID | Int | ||
| SalesEmailURL | String |
User Forwards Email to a person/record
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| StepID | Int | ||
| ChoiceNumber | Int |
Person unsubscribed from Marketo Emails
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| MailingID | Int | ||
| MailingIDValue | String | ||
| WebpageID | Int | ||
| QueryParameters | String | ||
| ClientIPAddress | String | ||
| ReferrerURL | String | ||
| UserAgent | String | ||
| WebformID | Int | ||
| FormFields | String | ||
| TestVariant | Int | ||
| CampaignRunID | Int | ||
| HasPredictive | Bool | ||
| Browser | String | ||
| Platform | String | ||
| Device | String |
Update an Opportunity
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| OpptyID | Int | ||
| OpptyIDValue | String | ||
| DataValueChanges | String | ||
| AttributeName | String | ||
| NewValue | String | ||
| OldValue | String |
User visits a web page
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
| WebpageID | Int | ||
| WebpageIDValue | String | ||
| WebpageURL | String | ||
| QueryParameters | String | ||
| ClientIPAddress | String | ||
| ReferrerURL | String | ||
| UserAgent | String | ||
| SearchEngine | String | ||
| SearchQuery | String | ||
| Token | String | ||
| Browser | String | ||
| Platform | String | ||
| Device | String |
Get available activity types.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM ActivityTypes WHERE Id=123
| Name | Type | Operators | Description |
| Id [KEY] | Int | The unique, Marketo-assigned identifier of the Activity type. | |
| Name | String | The name of the Activity type. | |
| Description | String | The description of the Activity type. | |
| PrimaryAttributeName | String | The name of the primary attribute. | |
| PrimaryAttributeDatatype | String | The data type of the primary attribute. | |
| Attributes | String | The activity attributes JSON aggregate. |
Get available activity type attributes.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM ActivityTypesAttributes WHERE ActivityTypeId=123
| Name | Type | Operators | Description |
| ActivityTypeId [KEY] | Int | The unique, Marketo-assigned identifier of the activity type. | |
| ActivityName | String | The name of the activity type. | |
| AttributeName [KEY] | String | The name of the attribute. | |
| AttributeDataType | String | The data type of the attribute. |
Returns a list of bulk export jobs that were created in the past 7 days.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM BulkExportJobs WHERE Table='Leads'
SELECT * FROM BulkExportJobs WHERE Table='Leads' AND Status='Created'
| Name | Type | Operators | Description |
| ExportId [KEY] | String | Unique id of the export job. | |
| Table [KEY] | String | = | Name of the table the export job was created for. Can be Activities, Leads, ProgramMembers or any CustomObject_ table. |
| Status | String | = | The status of the export. |
| Format | String | The format of the file. | |
| CreatedAt | Datetime | The date when the export request was created. | |
| QueuedAt | Datetime | The queue time of the export job. This column will have a value only when 'Queued' status is reached. | |
| StartedAt | Datetime | The start time of the export job. This column will have a value only when 'Processing' status is reached. | |
| FinishedAt | Datetime | The finish time of export job. This column will have a value only when status is 'Completed' or 'Failed'. | |
| FileSize | Long | The size of file in bytes. This column will have a value only when status is 'Completed'. | |
| FileChecksum | String | The checksum of the generated file. | |
| NumberOfRecords | Long | The number of records in the export file. This column will have a value only when the status is 'Completed'. | |
| ErrorMessage | String | The error message in case of failed status. |
Query Campaigns for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Campaigns WHERE Id='1037'
SELECT * FROM Campaigns WHERE Id IN (1037, 1055, 1058)
SELECT * FROM Campaigns WHERE Name='TestCampaign1'
SELECT * FROM Campaigns WHERE Name='test' AND WorkspaceName='Default'
SELECT * FROM Campaigns WHERE ProgramName='Program6'
| Name | Type | Operators | Description |
| Id [KEY] | Int | =,IN | The unique, Marketo-assigned identifier of the campaign. |
| Name | String | =,IN | The name of the campaign. |
| Description | String | The description of the campaign. | |
| Type | String | The campaign type. | |
| ProgramId | Int | The Id of the program associated with the campaign. | |
| ProgramName | String | =,IN | The name of the program associated with the campaign. |
| WorkspaceName | String | =,IN | The name of the workspace associated with the campaign. |
| Active | Bool | Identifies whether the campaign is active. | |
| CreatedAt | Datetime | The date and time the campaign was created. | |
| UpdatedAt | Datetime | The date and time the campaign was last updated. |
Query ProgressionStatuses of Channels for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM ChannelProgressionStatuses WHERE ChannelName='Online Advertising'
Other queries:
SELECT * FROM ChannelProgressionStatuses WHERE ChannelName IN (SELECT Channel FROM Programs WHERE id=1010)
| Name | Type | Operators | Description |
| ChannelName [KEY] | String | = | The name of the channel. |
| Name [KEY] | String | Name of the status. | |
| Description | String | Description of the program status. | |
| Hidden | Bool | Whether the status has been hidden. | |
| Type | String | Type of the status. | |
| Step | Int | Step number of the status. | |
| Success | Bool | Whether this status is a success step for program members. |
Query Channels for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Channels WHERE Name='Online Advertising'
| Name | Type | Operators | Description |
| Id [KEY] | Int | The unique, Marketo-assigned identifier of the channel. | |
| Name | String | = | The name of the channel. |
| ApplicableProgramType | String | The type of program that the channel is used for. | |
| CreatedAt | Datetime | The date and time the channel was created. | |
| UpdatedAt | Datetime | The date and time the channel was last updated. | |
| ProgressionStatuses | String | JSON array of progression statuses aggregates. Additionally exposed as the separate table ChannelProgressionStatuses. |
Retrieve the count of each error users have encountered in the current day.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM DailyErrorStatistics WHERE ErrorCode='610'
| Name | Type | Operators | Description |
| Date | Date | The date when the error was encountered. | |
| ErrorCode | String | The error code. | |
| Count | Int | The error count for the particular error code. |
Retrieve the number of API calls that specific users have consumed in the current day.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM DailyUsageStatistics WHERE UserId='User123'
| Name | Type | Operators | Description |
| Date | Date | The date when the API Calls were made. | |
| UserId | String | The ID of the user. | |
| Count | Int | The individual count for the user. |
Query Emails CC Fields for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM EmailCCFields WHERE AttributeId='attribute_123'
| Name | Type | Operators | Description |
| AttributeId [KEY] | String | The attribute identifier. | |
| ObjectName | String | Object name. Lead or Company. | |
| DisplayName | String | The display name. | |
| ApiName | String | The API name. |
Query email records which depend on a given email template.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM EmailTemplatesUsedBy WHERE EmailTemplateId=1
| Name | Type | Operators | Description |
| EmailTemplateId [KEY] | Int | = | The id of the email template. |
| Id [KEY] | Int | The id of the email that uses the email template. | |
| Name | String | The name of the email. | |
| Type | String | The type of the asset. | |
| Status | String | The status of the email. | |
| UpdatedAt | Datetime | The update date time of the email. |
Query files for a Marketo organization.
CreateFile can be used to upload a file.
UpdateFile can be used to update the file content.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Files WHERE id='421'
SELECT * FROM Files WHERE Name='CData.png'
SELECT * FROM Files WHERE FolderId='34'
SELECT * FROM Files WHERE FolderId='34' AND ParentType='Folder'
| Name | Type | Operators | Description |
| Id [KEY] | Int | = | The unique, Marketo-assigned identifier of the file. |
| Name | String | = | The name of the file. |
| Description | String | Description of the file. | |
| FolderId | Int | = | The unique, Marketo-assigned identifier of the folder. |
| FolderName | String | The Name of the folder | |
| FolderType | String | The type of folder (Folder,Program) | |
| MimeType | String | MIME type of the file | |
| Size | Int | Size of the file in bytes | |
| URL | String | The explicit URL of the asset in the designated instance. | |
| CreatedAt | Datetime | The date and time the folder was created. | |
| UpdatedAt | Datetime | The date and time the folder was last updated. | |
| ParentType | String | = | Mirror column used as server side filter for the type of the parent folder. Will be ignored when filtering by Id or Name. |
Query Folders contents for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM FolderContents WHERE FolderId=12
SELECT * FROM FolderContents WHERE FolderId=12 AND FolderType='Folder'
| Name | Type | Operators | Description |
| Id [KEY] | Int | The marketo-assigned identifier of the folder content. | |
| Type | String | The type of the folder content. | |
| FolderId | Int | = | The unique, Marketo-assigned identifier of the folder. |
| FolderType | String | = | The type of the folder. Folder or Program, defaults to Folder. |
Query landing page template contents for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
UpdateLandingPageTemplateContent can be used to update the Landing Page Template Content.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateId=1 AND LandingPageTemplateStatus='approved'
SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateId IN (1, 1005) AND LandingPageTemplateStatus IN ('draft', 'approved')
SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateId IN (1, 1005)
SELECT * FROM LandingPageTemplateContent WHERE LandingPageTemplateStatus='draft'
SELECT * FROM LandingPageTemplateContent
| Name | Type | Operators | Description |
| LandingPageTemplateId [KEY] | Int | = | The unique, Marketo-assigned identifier of the landing page template. |
| LandingPageTemplateStatus [KEY] | String | = | Status of the landing page template, draft or approved versions. |
| Content | String | HTML content of the landing page template. | |
| EnableMunchkin | Bool | Whether to enable munchkin on the derived pages. Defaults to true. | |
| TemplateType | String | Type of template. |
Query Lead changes.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM LeadChanges WHERE ActivityDate = '2024-02-02 08:15:10.0'
SELECT * FROM LeadChanges WHERE ActivityDate > '2024-01-17T14:32:21'
SELECT * FROM LeadChanges WHERE ActivityDate >= '2024-01-17T14:32:21'
SELECT * FROM LeadChanges WHERE ActivityDate > '2024-01-17T14:32:21' AND ActivityDate < '2024-02-17T14:32:21'
SELECT * FROM LeadChanges WHERE LeadId IN (4, 14454)
SELECT * FROM LeadChanges WHERE ListId = 1014
SELECT * FROM LeadChanges WHERE ListId = 1014 AND ActivityDate > '2023-06-14T14:13:27Z'
SELECT * FROM LeadChanges WHERE LeadId = 9 AND ActivityDate > '2023-06-14T14:13:27Z'
Use LeadFields to specify the Lead columns from which you want to retrieve changes. Defaults to all columns. Retrieve column names from SYS_TABLECOLUMNS and provide them as comma-separated values.
SELECT * FROM LeadChanges WHERE LeadFields = 'mobilePhone'
SELECT * FROM LeadChanges WHERE LeadId = 4 AND LeadFields = 'mobilePhone'
| Name | Type | Operators | Description |
| ActivityId [KEY] | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| ActivityTypeId | Int | Id of the activity type. | |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| CampaignId | Int | Id of the associated Smart Campaign, if applicable. | |
| Attributes | String | JSON aggregate containing the list of attribute key value pair for this activity. | |
| Fields | String | JSON aggregate containing a list of changes made to lead fields. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| LeadFields | String | Mirror column used to specify Lead columns for which you want to retrieve changes for. Defaults to all columns. Column names can be retrieved from SYS_TABLECOLUMNS. SELECT [ColumnName] FROM SYS_TABLECOLUMNS WHERE TableName='leads' and should be provided as comma separated values. |
Query Lead changes attributes.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM LeadChangesAttributes WHERE ActivityDate = '2024-02-02 08:15:10.0'
SELECT * FROM LeadChangesAttributes WHERE ActivityDate > '2024-01-17T14:32:21'
SELECT * FROM LeadChangesAttributes WHERE ActivityDate >= '2024-01-17T14:32:21'
SELECT * FROM LeadChangesAttributes WHERE ActivityDate > '2024-01-17T14:32:21' AND ActivityDate < '2024-02-17T14:32:21'
SELECT * FROM LeadChangesAttributes WHERE LeadId IN (4, 14454)
SELECT * FROM LeadChangesAttributes WHERE ListId = 1014
SELECT * FROM LeadChangesAttributes WHERE ListId = 1014 AND ActivityDate > '2023-06-14T14:13:27Z'
SELECT * FROM LeadChangesAttributes WHERE LeadId = 9 AND ActivityDate > '2023-06-14T14:13:27Z'
Use LeadFields to specify the Lead columns from which you want to retrieve changes. Defaults to all columns. Retrieve column names from SYS_TABLECOLUMNS and provide them as comma-separated values.
SELECT * FROM LeadChangesAttributes WHERE LeadFields = 'mobilePhone'
SELECT * FROM LeadChangesAttributes WHERE LeadId = 4 AND LeadFields = 'mobilePhone'
| Name | Type | Operators | Description |
| ActivityId | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| ActivityTypeId | Int | Id of the activity type. | |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| AttributeAPIName | String | API Name of the attribute | |
| AttributeName | String | Name of the attribute | |
| AttributeValue | String | Value of the attribute | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| LeadFields | String | Mirror column used to specify Lead columns for which you want to retrieve changes for. Defaults to all columns. Column names can be retrieved from SYS_TABLECOLUMNS. SELECT [ColumnName] FROM SYS_TABLECOLUMNS WHERE TableName='leads' and should be provided as comma separated values. |
Query fields of lead changes.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM LeadChangesFields WHERE ActivityDate = '2024-02-02 08:15:10.0'
SELECT * FROM LeadChangesFields WHERE ActivityDate > '2024-01-17T14:32:21'
SELECT * FROM LeadChangesFields WHERE ActivityDate >= '2024-01-17T14:32:21'
SELECT * FROM LeadChangesFields WHERE ActivityDate > '2024-01-17T14:32:21' AND ActivityDate < '2024-02-17T14:32:21'
SELECT * FROM LeadChangesFields WHERE LeadId IN (4, 14454)
SELECT * FROM LeadChangesFields WHERE ListId = 1014
SELECT * FROM LeadChangesFields WHERE ListId = 1014 AND ActivityDate > '2023-06-14T14:13:27Z'
SELECT * FROM LeadChangesFields WHERE LeadId = 9 AND ActivityDate > '2023-06-14T14:13:27Z'
Use LeadFields to specify the Lead columns from which you want to retrieve changes. Defaults to all columns. Retrieve column names from SYS_TABLECOLUMNS and provide them as comma-separated values.
SELECT * FROM LeadChangesFields WHERE LeadFields = 'mobilePhone'
SELECT * FROM LeadChangesFields WHERE LeadId = 4 AND LeadFields = 'mobilePhone'
| Name | Type | Operators | Description |
| ActivityId | String | Unique id of the activity. | |
| ActivityDate | Datetime | >,>=,=,<,<= | Datetime of the activity. |
| ActivityTypeId | Int | Id of the activity type. | |
| LeadId | Int | =,IN | Id of the lead associated to the activity. |
| LeadChangeFieldId | Int | Unique integer id of the change record. | |
| LeadChangeFieldName | String | Name of the field which was changed. | |
| LeadChangeFieldNewValue | String | New value after the change. | |
| LeadChangeFieldOldValue | String | Old value before the change. | |
| ListId | Int | = | Mirror column that can be used only as a filter. Will retrieve activities for all leads that are members of this static list. Not available when UseBulkAPI=true. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| LeadFields | String | Mirror column used to specify Lead columns for which you want to retrieve changes for. Defaults to all columns. Column names can be retrieved from SYS_TABLECOLUMNS. SELECT [ColumnName] FROM SYS_TABLECOLUMNS WHERE TableName='leads' and should be provided as comma separated values. |
Query Lead Partitions for a Marketo organization.
UpdateLeadPartition can be used to update the partition of a lead.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM LeadPartitions WHERE Id=123
| Name | Type | Operators | Description |
| Id [KEY] | Int | The unique, Marketo-assigned identifier of the lead partition. | |
| Name | String | The name of the partition. | |
| Description | String | The description of the partition. |
Query program membership for leads.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
If no LeadId filter is specified, this table queries all available LeadIds. This process is time-consuming because querying the Leads table is resource-intensive.
SELECT * FROM LeadPrograms WHERE LeadId=4
| Name | Type | Operators | Description |
| LeadId [KEY] | Int | = | The Marketo lead id. |
| ProgramId [KEY] | Int | Unique integer id of a program record. | |
| ProgressionStatus | String | Program status of the lead in the parent program. | |
| ProgressionStatusType | String | Program status Type of the lead in the parent program. | |
| IsExhausted | Bool | Whether the lead is currently exhausted in the stream, if applicable. | |
| AcquiredBy | Bool | Whether the lead was acquired by the parent program. | |
| ReachedSuccess | Bool | Whether the lead is in a success-status in the parent program. | |
| MembershipDate | Datetime | Date the lead first became a member of the program. | |
| UpdatedAt | Datetime | Datetime when the program was most recently updated. |
Query Static Lists for a Marketo organization from the Leads API.
This table contains the same records as StaticLists, however it has different columns and server-side filters that might be of use since the tables are retrieved from differnt API endpoints.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Lists WHERE Id=1556
SELECT * FROM Lists WHERE Id IN (1556, 1057)
SELECT * FROM Lists WHERE Name='test0319'
SELECT * FROM Lists WHERE ProgramName='ImportTest0407'
SELECT * FROM Lists WHERE WorkspaceName='Default' AND Id=1014
| Name | Type | Operators | Description |
| Id [KEY] | Int | =,IN | Id of the static list. |
| Name | String | =,IN | Name of the static list. |
| Description | String | Description of the static list. | |
| ProgramName | String | =,IN | Name of the program. |
| WorkspaceId | Int | WorkspaceId of the static list. | |
| WorkspaceName | String | =,IN | Name of the workspace the static list is part of. |
| CreatedAt | Datetime | Datetime the static list was created. | |
| UpdatedAt | Datetime | Datetime the static list was most recently updated. |
Query leads of a static list in Marketo.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
Tip: This table uses server-side projection. Performance can be improved by minimizing the number of columns in projection.
SELECT * FROM ListStaticMemberShip WHERE ListId=123
| Name | Type | Operators | Description |
| ListId [KEY] | Int | = | Id of the static list. |
| Id [KEY] | Int | The lead Id. | |
| AcmeAccessCode | String | =,IN | |
| AcquisitionProgramId | Int | ||
| Address | String | ||
| AnnualRevenue | Decimal | ||
| AnonymousIP | String | ||
| BillingCity | String | ||
| BillingCountry | String | ||
| BillingPostalCode | String | ||
| BillingState | String | ||
| BillingStreet | String | ||
| BlackListed | Bool | ||
| BlackListedCause | String | ||
| City | String | ||
| Company | String | ||
| ContactCompany | Int | ||
| Cookies | String | =,IN | |
| Country | String | ||
| CreatedAt | Datetime | ||
| Cstmfdtest1 | String | =,IN | |
| Cstmfdtest2 | String | =,IN | |
| DateOfBirth | Date | ||
| Department | String | =,IN | |
| DoNotCall | Bool | ||
| DoNotCallReason | String | ||
| Ecids | String | ||
| String | =,IN | ||
| EmailInvalid | Bool | ||
| EmailInvalidCause | String | ||
| EmailSuspended | Bool | ||
| EmailSuspendedAt | Datetime | ||
| EmailSuspendedCause | String | =,IN | |
| ExternalCompanyId | String | =,IN | |
| ExternalSalesPersonId | String | =,IN | |
| Fax | String | ||
| FirstName | String | ||
| FirstUTMCampaign | String | ||
| FirstUTMContent | String | ||
| FirstUTMMedium | String | ||
| FirstUTMSource | String | ||
| FirstUTMTerm | String | ||
| GdprMailableStatus | String | ||
| Industry | String | ||
| InferredCity | String | ||
| InferredCompany | String | ||
| InferredCountry | String | ||
| InferredMetropolitanArea | String | ||
| InferredPhoneAreaCode | String | ||
| InferredPostalCode | String | ||
| InferredStateRegion | String | ||
| IsAnonymous | Bool | ||
| IsLead | Bool | ||
| LastName | String | ||
| LatestUTMCampaign | String | ||
| LatestUTMContent | String | ||
| LatestUTMMedium | String | ||
| LatestUTMSource | String | ||
| LatestUTMterm | String | ||
| LeadPartitionId | Int | =,IN | |
| LeadPerson | Int | ||
| LeadRevenueCycleModelId | Int | ||
| LeadRevenueStageId | Int | ||
| LeadRole | String | ||
| LeadScore | Int | ||
| LeadSource | String | ||
| LeadStatus | String | ||
| MainPhone | String | ||
| MarketingSuspended | Bool | ||
| MarketingSuspendedCause | String | ||
| MiddleName | String | ||
| MktoAcquisitionDate | Datetime | ||
| MktoCompanyNotes | String | ||
| MktoDoNotCallCause | String | ||
| MktoIsCustomer | Bool | ||
| MktoIsPartner | Bool | ||
| MktoName | String | =,IN | |
| MktoPersonNotes | String | ||
| MobilePhone | String | ||
| NumberOfEmployees | Int | ||
| NumberofEmployeesProspect | String | ||
| OriginalReferrer | String | ||
| OriginalSearchEngine | String | ||
| OriginalSearchPhrase | String | ||
| OriginalSourceInfo | String | ||
| OriginalSourceType | String | ||
| PersonLevelEngagementScore | Int | =,IN | |
| PersonPrimaryLeadInterest | Int | ||
| PersonTimeZone | String | ||
| PersonType | String | ||
| Phone | String | ||
| PostalCode | String | ||
| Priority | Int | ||
| Rating | String | ||
| RegistrationSourceInfo | String | ||
| RegistrationSourceType | String | ||
| RelativeScore | Int | ||
| RelativeUrgency | Int | ||
| Salutation | String | ||
| SicCode | String | ||
| Site | String | ||
| State | String | ||
| Test | String | =,IN | |
| Test1 | Bool | ||
| Test98 | String | =,IN | |
| TestBoolean | Bool | ||
| TestCustomfieldEmail | String | =,IN | |
| TestFieldText1 | String | =,IN | |
| TestInteger | Bool | ||
| TestInteger_cf | Int | =,IN | |
| TestKpQA | String | =,IN | |
| Title | String | ||
| Unsubscribed | Bool | ||
| UnsubscribeDateFoFS | String | ||
| UnsubscribeDateUnleashed | String | ||
| UnsubscribedReason | String | ||
| UnsubscribeFoFS | String | ||
| UnsubscribeMarketing | String | ||
| UnsubscribeSales | String | ||
| UnsubscribeUnleashed | String | ||
| UpdatedAt | Datetime | ||
| Urgency | Double | ||
| UTMTerm | String | =,IN | |
| Website | String |
Query, insert and delete program cost relations for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM ProgramCosts WHERE ProgramId='6205'
| Name | Type | Operators | Description |
| ProgramId | Int | = | The unique, Marketo-assigned identifier of the program. |
| Cost | Int | Amount of the cost. | |
| CostNote | String | Note of the cost. | |
| CostStartDate | Datetime | Start datetime of the period cost. |
Query tags relations for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM ProgramTags WHERE tagType='test' AND tagValue='asd1'
SELECT * FROM ProgramTags WHERE ProgramId=6138
| Name | Type | Operators | Description |
| ProgramId [KEY] | Int | = | The unique, Marketo-assigned identifier of the program. |
| TagType [KEY] | String | = | The tag type associated with the program. Each TagType has a value associated with it which is returned via the TagValue column. |
| TagValue | String | = | Value of the tag type. |
Query roles. Requires permissions: 'Access User Management Api' and 'Access Users'.
This view does not support server-side filtering.
SELECT * FROM Roles;
| Name | Type | Operators | Description |
| Id [KEY] | Integer | The unique, Marketo-assigned identifier of the role. | |
| Name | String | The name of the role. | |
| Description | String | The description of the role. | |
| Type | String | The type of the role. | |
| IsHidden | Boolean | Whether the role is hidden. | |
| IsOnlyAllZones | Boolean | Whether the role is all zones. | |
| CreatedAt | Datetime | The date and time the role was created. | |
| UpdatedAt | Datetime | The date and time the role was last updated. |
Query segmentations for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Segmentations WHERE Status='draft'
| Name | Type | Operators | Description |
| Id [KEY] | Int | Id of the segmentation. | |
| Status [KEY] | String | = | Status of the segmentation, draft or approved. |
| Name | String | Name of the segmentation. | |
| Description | String | Description of the segmentation. | |
| URL | String | Url of the segmentation in the Marketo UI. | |
| FolderId | Int | The unique, Marketo-assigned identifier of the parent folder/program. | |
| FolderName | String | The name of the folder | |
| FolderType | String | The type of folder (Folder,Program) | |
| WorkspaceName | String | Workspace Name of the asset. | |
| CreatedAt | Datetime | Datetime the segmentation was created. | |
| UpdatedAt | Datetime | Datetime the segmentation was most recently updated. |
Query segments for a Marketo organization.
Note: This table uses the draft/approved versioning API. By default both versions are retrieved/modified. To interact with a specific version use the filter Status='draft' or Status='approved'.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Segments WHERE SegmentationId=1001 AND Status='draft'
SELECT * FROM Segments WHERE SegmentationId=1001
| Name | Type | Operators | Description |
| Id [KEY] | Int | Id of the segment. | |
| Status [KEY] | String | = | Status of the segment, draft or approved. |
| SegmentationId | Int | = | Id of the segmentation. |
| Name | String | Name of the segment. | |
| Description | String | Description of the segmentation. | |
| URL | String | Url of the segmentation in the Marketo UI. | |
| CreatedAt | Datetime | Datetime segment form was created. | |
| UpdatedAt | Datetime | Datetime the segment was most recently updated. |
Query filters of smart lists in a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM SmartListFilterConditions WHERE SmartListId='1093'
| Name | Type | Operators | Description |
| FilterId | Int | Id of the smart list filter. | |
| SmartListId | Int | = | Id of the smart list. |
| ActivityAttributeId | String | Id of activity attribute. | |
| ActivityAttributeName | String | Name of activity attribute. | |
| AttributeId | String | Id of attribute. | |
| AttributeName | String | Name of attribute. | |
| Operator | String | Value of operator. | |
| Values | String | List of values. | |
| IsPrimary | String | Whether the condition is primary or not (first condition of the smart list). | |
| IsError | String | Whether the condition is error. | |
| ErrorMessage | String | The error message if IsError=true. |
Query filters of smart lists in a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM SmartListFilters WHERE SmartListId='3560'
| Name | Type | Operators | Description |
| Id [KEY] | Int | Id of the smart list filter. | |
| SmartListId | Int | = | Id of the smart list. |
| Name | String | The name of the smart list rule filter. | |
| Operator | String | The operator used in the filter. | |
| RuleType | String | The type of the rule. | |
| RuleTypeId | Int | The Id of the rule type. | |
| FilterMatchType | String | The rule filter match type | |
| Conditions | String | JSON aggregate of smart list filter conditions. |
Query rules of smart lists in a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM SmartListTriggers WHERE SmartListId='3560'
| Name | Type | Operators | Description |
| SmartListId | Int | = | Id of the smart list. |
| Trigger | String | Smart list trigger. |
Query allowed values for tags in a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM TagAllowedValues WHERE TagType='test'
| Name | Type | Operators | Description |
| TagType [KEY] | String | = | The name/type of the tag. |
| AllowableValues | String | The acceptable values for the tag type. |
Query tags for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM Tags WHERE TagType='test'
| Name | Type | Operators | Description |
| TagType [KEY] | String | = | The name/type of the tag. |
| Required | Bool | Whether the tag is required for its applicable program types. | |
| ApplicableProgramTypes | String | The types of program that the tag is used for. |
Query form thank you pages for a Marketo organization.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM ThankYouList WHERE FormId=1
| Name | Type | Operators | Description |
| FormId | Int | = | Id of the form. |
| FollowupType | String | The follow up type. | |
| FollowupValue | String | The follow up value. | |
| Default | Bool | If this is the default ThankYouPage. | |
| Operator | String | The operator for the ThankYouPage. | |
| SubjectField | String | The subject field of the ThankYouPage. | |
| Values | String | JSON array of values. |
Retrieve the count of each error users have encountered in the past 7 days.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM WeeklyErrorStatistics WHERE ErrorCode='610'
| Name | Type | Operators | Description |
| Date | Date | The date when the error was encountered. | |
| ErrorCode | String | The error code. | |
| Count | Int | The error count for the particular error code. |
Retrieve the number of API calls that specific users have consumed in the past 7 days.
Note: Filters provided with one of the supported operators listed in the "Operators" column are processed server-side, all the other filters are processed client-side.
SELECT * FROM WeeklyUsageStatistics WHERE UserId='User123'
| Name | Type | Operators | Description |
| Date | Date | The date when the API Calls were made. | |
| UserId | String | The ID of the user. | |
| Count | Int | The individual count for the user. |
Retrieve workspaces. Requires permissions: 'Access User Management Api' and 'Access Users'.
This view does not support server-side filtering.
SELECT * FROM Workspaces;
| Name | Type | Operators | Description |
| Id [KEY] | Integer | The unique, Marketo-assigned identifier of the workspace. | |
| Name | String | The name of the workspace. | |
| Description | String | The description of the workspace. | |
| Status | String | The status of the workspace. | |
| GlobalVisualization | String | The global visualization of the workspace. | |
| CurrencyInfo | String | The currency info of the workspace. | |
| CreatedAt | Datetime | The date and time the workspace was created. | |
| UpdatedAt | Datetime | The date and time the workspace was last updated. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Marketo.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Marketo, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| ActivateSmartCampaign | Activates a trigger smart campaign. |
| ApproveAsset | Approves the asset based on the given asset type and id. |
| AssociateLead | Associates a known Marketo lead record to a munchkin cookie and its associated web activity history. |
| BulkExportActivities | A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile. |
| BulkExportCustomObjects | A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile. |
| BulkExportLeads | A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile. |
| BulkExportProgramMembers | A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile. |
| BulkImportCustomObjects | Imports the custom object records from the provided file, waits for the job to finish and returns the job completion details. |
| BulkImportLeads | Imports the lead records from the provided file, waits for the job to finish and returns the job completion details. |
| BulkImportProgramMembers | Imports the program member records from the provided file, waits for the job to finish and returns the job completion details. |
| CancelExportJob | Cancel a bulk export job. |
| CreateActivitiesExportJob | Create an activities export job based on the given filters. |
| CreateCustomObjectsExportJob | Create a custom object export job based on the given filters. Only 1 filter type can be specified. |
| CreateCustomObjectsImportJob | Imports the program custom object records from the provided file. |
| CreateEmailTemplate | Creates a new email template. |
| CreateExportJob | Create an export job for the search criteria defined via the filter aggregate input. Returns the 'JobId' which can be passed as a parameter in subsequent calls to Bulk Export Activities. Use EnqueueExportJob to queue the export job for processing. Use GetExportJobStatus to retrieve status of export job. |
| CreateFile | Creates a new file from the included payload. |
| CreateLeadsExportJob | Create a leads export job based on the given filters. Only 1 filter type can be specified. |
| CreateLeadsImportJob | Imports the lead records from the provided file. |
| CreateProgramMembersExportJob | Create a program members export job based on the given filters. |
| CreateProgramMembersImportJob | Imports the program member records from the provided file. |
| DeactivateSmartCampaign | Deactivates a trigger smart campaign. |
| DeleteInvitedUser | Delete pending user. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users. |
| EnqueueExportJob | Puts an export job in queue and starts the job when computing resources become available. |
| GetEmailFullContent | Returns the serialized HTML version of the email. |
| GetEmailTemplateContent | Returns the content for a given email template. |
| GetExportJobFile | Returns the file generated by the bulk job with the given Id. |
| GetExportJobStatus | Returns the status of an export job. Job status is available for 30 days after Completed or Failed status was reached. |
| GetImportJobFailures | Returns the list of failures for the import batch job |
| GetImportJobStatus | Returns the status of an import job. |
| GetImportJobWarnings | Returns the list of warnings for the import batch job |
| GetInvitedUserById | Retrieve a single pending user record through its Id. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users. |
| GetSnippetContent | Returns the content for a given snippet. |
| InviteUser | Send an email invitation to new user. Requires permissions: Access User Management Api and Access Users. |
| MergeLeads | Merges two or more known lead records into a single lead record. |
| PollExportJobStatus | Continuously polls the bulk API for the status of the export job until one of the following statuses is returned: Completed, Cancelled, Failed. |
| PollImportJobStatus | Will continuously poll the bulk API for the status of the import job until one of the following statuses is returned: Complete, Failed. |
| ScheduleCampaign | Passes a set of leads to a trigger campaign to run through the campaign's flow. |
| SendEmailSample | Sends a sample email to the given email address. Leads may be impersonated to populate data for tokens and dynamic content. |
| TriggerCampaign | Remotely schedules a batch campaign to run at a given time. |
| UnApproveAsset | Revokes approval based on the given asset type and id. |
| UpdateEmailContent | Updates the content of an email. |
| UpdateEmailFullContent | Replaces the HTML of an Email that has had its relationship broken from its template. |
| UpdateEmailTemplateContent | Updates the content of the given email template. |
| UpdateFile | Updates the content of the given file. |
| UpdateLandingPageTemplateContent | Updates the content for the target landing page template. |
| UpdateLeadPartition | Update the lead partition for a list of leads. |
| UpdateLeadProgramStatus | Changes the program status for a list of leads in a target program. Only existing members of the program may have their status changed with this procedure. |
| UpdateSnippetContent | Updates the content of a snippet. |
Activates a trigger smart campaign.
EXECUTE ActivateSmartCampaign Id=1
| Name | Type | Required | Description |
| Id | String | True | Id of the trigger smart campaign to activate. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Approves the asset based on the given asset type and id.
EXECUTE ApproveAsset Id=1005, Type='LandingPage'
| Name | Type | Required | Description |
| Id | String | True | Id of the asset. |
| Type | String | True | Type of the asset.
The allowed values are EmailTemplate, Email, Form, LandingPageTemplate, LandingPage, Snippet. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Associates a known Marketo lead record to a munchkin cookie and its associated web activity history.
EXECUTE AssociateLead LeadId='1755', Cookie='id:063-GJP-217&token:_mch-marketo.com-1594662481190-60776'
| Name | Type | Required | Description |
| LeadId | Integer | True | Id of the Lead to associate |
| Cookie | String | True | The cookie value to associate |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
EXECUTE BulkExportActivities CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z'
EXECUTE BulkExportActivities CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='C:/Users/cdata/export.csv'
EXECUTE BulkExportActivities CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='/tmp/export.csv'
EXECUTE BulkExportActivities ActivityTypeIds='1', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
EXECUTE BulkExportActivities ActivityTypeIds='1,2,23', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
EXECUTE BulkExportActivities ActivityTypeIds='1', PrimaryAttributeValueIds='1,2,3', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
EXECUTE BulkExportActivities ActivityTypeIds='1', PrimaryAttributeValues='value1,value2', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
| Name | Type | Required | Description |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| CreatedAtStartAt | Datetime | False | Inclusive lower bound filter for the activity creation datetime. |
| CreatedAtEndAt | Datetime | False | Inclusive upper bound filter for the activity creation datetime. |
| ActivityTypeIds | Integer | False | The id of a the activity type. Available activity types can be queried from the view ActivityTypes. |
| PrimaryAttributeValueIds | Integer | False | Filter based on the id of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValues. |
| PrimaryAttributeValues | String | False | Filter based on the values of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValueIds. |
| PollingInterval | Integer | False | The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| ChunkSize | Long | False | The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once. |
| MaxThreads | Integer | False | The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z'
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='C:/Users/cdata/export.csv'
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z', LocalPath='/tmp/export.csv'
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-02-25T00:00:00Z', Columns='lead=LeadId,*'
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', SmartListName='CDataSmartList'
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', SmartListId=12
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', StaticListName='ImportTest0407_csv'
EXECUTE BulkExportCustomObjects Table='CustomObject_cdatajp3', StaticListId=13
| Name | Type | Required | Description |
| Table | String | True | Name of the custom object to export data for. Matches the name of custom objects listed in sys_tables. |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| UpdatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead update datetime. |
| UpdatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead update datetime. |
| StaticListId | Integer | False | The id of a static list you want to use as a filter. |
| StaticListName | String | False | The name of a static list you want to use as a filter. |
| SmartListId | Integer | False | The id of a smart list you want to use as a filter. |
| SmartListName | String | False | The name of a smart list you want to use as a filter. |
| PollingInterval | Integer | False | The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| ChunkSize | Long | False | The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once. |
| MaxThreads | Integer | False | The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z'
EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z', LocalPath='C:/Users/cdata/export.csv'
EXECUTE BulkExportLeads CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z', LocalPath='/tmp/export.csv'
EXECUTE BulkExportLeads CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-02-25T00:00:00Z', Columns='Id'
EXECUTE BulkExportLeads CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-01-10T00:00:00Z', Columns='id=LeadID,*'
EXECUTE BulkExportLeads SmartListName='CDataSmartList'
EXECUTE BulkExportLeads StaticListName='ImportTest0407_csv'
EXECUTE BulkExportLeads SmartListId=12
EXECUTE BulkExportLeads StaticListId=13
| Name | Type | Required | Description |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| CreatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead creation datetime. |
| CreatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead creation datetime. |
| UpdatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead update datetime. |
| UpdatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead update datetime. |
| StaticListId | Integer | False | The id of a static list you want to use as a filter. |
| StaticListName | String | False | The name of a static list you want to use as a filter. |
| SmartListId | Integer | False | The id of a smart list you want to use as a filter. |
| SmartListName | String | False | The name of a smart list you want to use as a filter. |
| PollingInterval | Integer | False | The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| ChunkSize | Long | False | The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once. |
| MaxThreads | Integer | False | The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
A combination of CreateExportJob, EnqueueExportJob, PollExportJobStatus and GetExportJobFile.
EXECUTE BulkExportProgramMembers ProgramId='6117'
EXECUTE BulkExportProgramMembers ProgramId='6117,6182'
EXECUTE BulkExportProgramMembers ProgramId='6117', Columns='acquiredBy=acqBy,*'
EXECUTE BulkExportProgramMembers ProgramId='6117', LocalPath='/tmp/export.csv'
EXECUTE BulkExportProgramMembers ProgramId='6117', LocalPath='C:/Users/cdata/export.csv'
EXECUTE BulkExportProgramMembers ProgramId='6117,6182', UpdatedAtStartAt='2024-01-01', UpdatedAtEndAt='2024-01-30', IsExhausted='false', NurtureCadence='paus', StatusNames='Not in Program'
| Name | Type | Required | Description |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| UpdatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead update datetime. |
| UpdatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead update datetime. |
| ProgramId | String | True | Comma separated list of up to 10 program ids for which program members will be retrieved. |
| IsExhausted | Boolean | False | Boolean used to filter program membership records for people who have exhausted content. |
| NurtureCadence | String | False | Used to filter program membership records for a given nurture cadence.
The allowed values are paus, norm. |
| StatusNames | String | False | Comma separated list of program member status names to filter by. |
| PollingInterval | Integer | False | The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| ChunkSize | Long | False | The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once. |
| MaxThreads | Integer | False | The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Imports the custom object records from the provided file, waits for the job to finish and returns the job completion details.
EXECUTE BulkImportCustomObjects Table='CustomObject_customObject_cdatajp', LocalPath='C:/users/cdata/file.csv'
EXECUTE BulkImportCustomObjects Table='CustomObject_customObject_cdatajp', LocalPath='/tmp/file.csv'
EXECUTE BulkImportCustomObjects Table='CustomObject_customObject_cdatajp', FileData='bWFpbEFkZHJlc3MsbmFtZQpzdXBwb3J0X2NkYXRhLmNvLmpwMUBjZHRhLmNvbSxjZGF0YTE3CnN1cHBvcnRfY2RhdGEuY28uanAyQGNkdGEuY29tLGNkYXRhMTg='
| Name | Type | Required | Description |
| Table | String | True | The custom object table name. |
| Format | String | False | Format of the import file. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| LocalPath | String | False | The absolute path of the file to import. |
| FileData | String | False | Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import process. |
| RowsProcessed | Integer | The number of rows processed so far. |
| RowsFailed | Integer | The number of rows failed so far. |
| RowsWithWarning | Integer | The number of rows with a warning so far. |
| Message | String | The status message of the batch. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Imports the lead records from the provided file, waits for the job to finish and returns the job completion details.
EXECUTE BulkImportLeads LocalPath='C:/users/cdata/file.csv'
EXECUTE BulkImportLeads LocalPath='/tmp/file.csv'
EXECUTE BulkImportLeads LookupField='testCustomfieldEmail', ListId=1570, PartitionName='testPartition', LocalPath='/tmp/file.csv'
EXECUTE BulkImportLeads FileData='ZW1haWwsZmlyc3ROYW1lLGxhc3ROYW1lLHRlc3RDdXN0b21maWVsZEVtYWlsCnRlc3RAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdEB0ZXN0Q3VzdG9tZmllbGRFbWFpbC5jZGF0YS5jb20KdGVzdDEyMzFAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdDFAdGVzdEN1c3RvbWZpZWxkRW1haWwuY2RhdGEuY29t'
| Name | Type | Required | Description |
| LookupField | String | False | 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. You can use id for update only operations. |
| PartitionName | String | False | Name of the lead partition to import to. |
| ListId | Integer | False | Id of the static list to import into. |
| Format | String | False | Format of the import file. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| LocalPath | String | False | The absolute path of the file to import. |
| FileData | String | False | Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import process. |
| RowsProcessed | Integer | The number of rows processed so far. |
| RowsFailed | Integer | The number of rows failed so far. |
| RowsWithWarning | Integer | The number of rows with a warning so far. |
| Message | String | The status message of the batch. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Imports the program member records from the provided file, waits for the job to finish and returns the job completion details.
EXECUTE BulkImportProgramMembers ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='C:/users/cdata/file.csv'
EXECUTE BulkImportProgramMembers ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='/tmp/file.csv'
EXECUTE BulkImportProgramMembers ProgramId=6145, ProgramMemberStatus='Influenced', FileData='Zmlyc3ROYW1lLGxhc3ROYW1lLGVtYWlsLHRpdGxlLGNvbXBhbnksbGVhZFNjb3JlCkpvYW5uYSxMYW5uaXN0ZXIsSm9hbm5hQExhbm5pc3Rlci5jb20sTGFubmlzdGVyLEhvdXNlIExhbm5pc3RlciwwClR5d2luLExhbm5pc3RlcixUeXdpbkBMYW5uaXN0ZXIuY29tLExhbm5pc3RlcixIb3VzZSBMYW5uaXN0ZXIsMA=='
| Name | Type | Required | Description |
| ProgramId | Integer | True | Id of the program to add members to. |
| ProgramMemberStatus | String | True | Program member status for members being added. |
| Format | String | False | Format of the import file. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| LocalPath | String | False | The absolute path of the file to import. |
| FileData | String | False | Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import process. |
| RowsProcessed | Integer | The number of rows processed so far. |
| RowsFailed | Integer | The number of rows failed so far. |
| RowsWithWarning | Integer | The number of rows with a warning so far. |
| Message | String | The status message of the batch. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Cancel a bulk export job.
EXECUTE CancelExportJob Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE CancelExportJob Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE CancelExportJob Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE CancelExportJob Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE CancelExportJob Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
| Name | Type | Required | Description |
| Id | String | True | The id of the export job. |
| Table | String | True | The table to export. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Status | String | The status of the export process. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| QueuedAt | Datetime | The date when the export job was queued. |
| StartedAt | Datetime | The date when the export job was started. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Create an activities export job based on the given filters.
EXECUTE CreateActivitiesExportJob CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-01-10T00:00:00Z'
EXECUTE CreateActivitiesExportJob ActivityTypeIds='1', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
EXECUTE CreateActivitiesExportJob ActivityTypeIds='1,2,23', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
EXECUTE CreateActivitiesExportJob ActivityTypeIds='1', PrimaryAttributeValueIds='1,2,3', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
EXECUTE CreateActivitiesExportJob ActivityTypeIds='1', PrimaryAttributeValues='value1,value2', CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtStartAt='2023-02-25T00:00:00Z'
| Name | Type | Required | Description |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| CreatedAtStartAt | Datetime | False | Inclusive lower bound filter for the activity creation datetime. |
| CreatedAtEndAt | Datetime | False | Inclusive upper bound filter for the activity creation datetime. |
| ActivityTypeIds | Integer | False | The id of a the activity type. Available activity types can be queried from the view ActivityTypes. |
| PrimaryAttributeValueIds | Integer | False | Filter based on the id of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValues. |
| PrimaryAttributeValues | String | False | Filter based on the values of the primary attribute of the activity. When used, the activityTypeIds filter must be present and only contain activity ids that match the corresponding asset group. Cannot be combined with PrimaryAttributeValueIds. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| Status | String | The status of the export process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Create a custom object export job based on the given filters. Only 1 filter type can be specified.
EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-01-10T00:00:00Z'
EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', UpdatedAtStartAt='2023-01-01T00:00:00Z', UpdatedAtStartAt='2023-02-25T00:00:00Z', Columns='lead=LeadId,*'
EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', SmartListName='CDataSmartList'
EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', SmartListId=12
EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', StaticListName='ImportTest0407_csv'
EXECUTE CreateCustomObjectsExportJob Table='CustomObject_cdatajp3', StaticListId=13
| Name | Type | Required | Description |
| Table | String | True | Name of the custom object to export data for. Matches the name of custom objects listed in sys_tables. |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| UpdatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead update datetime. |
| UpdatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead update datetime. |
| StaticListId | Integer | False | The id of a static list you want to use as a filter. |
| StaticListName | String | False | The name of a static list you want to use as a filter. |
| SmartListId | Integer | False | The id of a smart list you want to use as a filter. |
| SmartListName | String | False | The name of a smart list you want to use as a filter. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| Status | String | The status of the export process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Imports the program custom object records from the provided file.
EXECUTE CreateCustomObjectsImportJob Table='CustomObject_customObject_cdatajp', LocalPath='C:/users/cdata/file.csv'
EXECUTE CreateCustomObjectsImportJob Table='CustomObject_customObject_cdatajp', LocalPath='/tmp/file.csv'
EXECUTE CreateCustomObjectsImportJob Table='CustomObject_customObject_cdatajp', FileData='bWFpbEFkZHJlc3MsbmFtZQpzdXBwb3J0X2NkYXRhLmNvLmpwMUBjZHRhLmNvbSxjZGF0YTE3CnN1cHBvcnRfY2RhdGEuY28uanAyQGNkdGEuY29tLGNkYXRhMTg='
| Name | Type | Required | Description |
| Table | String | True | The custom object table name. |
| Format | String | False | Format of the import file. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| LocalPath | String | False | The absolute path of the file to import. |
| FileData | String | False | Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set. |
| PollingInterval | Integer | False | In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Creates a new email template.
EXECUTE CreateEmailTemplate Name='TestTemplateNewDriver_', FileData='PGh0bWw+Cjxib2R5Pgo8aDE+VEVTVCBIVE1MPC9oMT4KPC9ib2R5Pgo8L2h0bWw+', Description='Test Create Email Template', FolderId=27, FolderType='Folder'
EXECUTE CreateEmailTemplate Name='TestTemplateNewDriver_', LocalPath='C:/users/cdata/file.txt', Description='Test Create Email Template', FolderId=27, FolderType='Folder'
EXECUTE CreateEmailTemplate Name='TestTemplateNewDriver_', LocalPath='/tmp/file.txt', Description='Test Create Email Template', FolderId=27, FolderType='Folder'
| Name | Type | Required | Description |
| Name | String | True | Name of the Email Template. Must be unique under the parent folder. |
| Description | String | False | Description of the email template. |
| FolderId | Integer | True | Id of the folder where the template will be created. |
| FolderType | String | True | Type of the folder where the template will be created. |
| LocalPath | String | False | The absolute path to a file where data is read from. |
| FileData | String | False | Base64 string representation of the file content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| Id | Integer | Id of the created email template. |
| URL | String | Url of the created email template. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Create an export job for the search criteria defined via the filter aggregate input. Returns the 'JobId' which can be passed as a parameter in subsequent calls to Bulk Export Activities. Use EnqueueExportJob to queue the export job for processing. Use GetExportJobStatus to retrieve status of export job.
EXECUTE CreateExportJob Table='Leads', FiltersAggregate='{"createdAt": {endAt": "2023-12-01", startAt": "2023-11-01"}}'
EXECUTE CreateExportJob Table='Leads', Columns='Id,test98,updatedAt,*', FiltersAggregate='{"createdAt": {endAt": "2023-12-01", startAt": "2023-11-01"}}'
| Name | Type | Required | Description |
| Table | String | True | The table to export. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
| Format | String | False | Format of export file to be generated.
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that you want to retrieve. Defaults to * (all columns). You can specify different header names for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. The exported file headers will be built using API names. Exported file column names can be changed using the Columns input. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| FiltersAggregate | String | False | JSON aggregate for the filters required in the request body. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| Status | String | The status of the export process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Creates a new file from the included payload.
EXECUTE CreateFile FileData='aGVsbG8gd29ybGQ=', Description='Test Create File', Name='newFile_0', FolderId=35, FolderType='Folder'
EXECUTE CreateFile LocalPath='C:/users/cdata/file.txt', Description='Test Create File', Name='newFile_0', FolderId=35, FolderType='Folder'
EXECUTE CreateFile LocalPath='/tmp/file.txt', Description='Test Create File', Name='newFile_0', FolderId=35, FolderType='Folder'
| Name | Type | Required | Description |
| Name | String | True | Name of the file. Must be unique under the parent folder. |
| Description | String | False | Description of the file. |
| FolderId | Integer | True | Id of the folder where the file will be created. |
| FolderType | String | True | Type of the folder where the file will be created. |
| InsertOnly | Boolean | False | Indicates whether the call should fail if there is already an existing file with the same name. |
| LocalPath | String | False | The absolute path to a file where data is read from. |
| FileData | String | False | Base64 string representation of the file content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| Id | Integer | Id of the created file. |
| URL | String | URL of the created file. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Create a leads export job based on the given filters. Only 1 filter type can be specified.
EXECUTE CreateLeadsExportJob CreatedAtStartAt='2024-02-02T00:00:00Z', CreatedAtEndAt='2024-02-02T00:00:00Z'
EXECUTE CreateLeadsExportJob CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-02-25T00:00:00Z', Columns='Id'
EXECUTE CreateLeadsExportJob CreatedAtStartAt='2023-01-01T00:00:00Z', CreatedAtEndAt='2023-01-10T00:00:00Z', Columns='id=LeadID,*'
EXECUTE CreateLeadsExportJob SmartListName='CDataSmartList'
EXECUTE CreateLeadsExportJob StaticListName='ImportTest0407_csv'
EXECUTE CreateLeadsExportJob SmartListId=12
EXECUTE CreateLeadsExportJob StaticListId=13
| Name | Type | Required | Description |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| CreatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead creation datetime. |
| CreatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead creation datetime. |
| UpdatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead update datetime. |
| UpdatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead update datetime. |
| StaticListId | Integer | False | The id of a static list you want to use as a filter. |
| StaticListName | String | False | The name of a static list you want to use as a filter. |
| SmartListId | Integer | False | The id of a smart list you want to use as a filter. |
| SmartListName | String | False | The name of a smart list you want to use as a filter. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| Status | String | The status of the export process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Imports the lead records from the provided file.
EXECUTE CreateLeadsImportJob LocalPath='C:/users/cdata/file.csv'
EXECUTE CreateLeadsImportJob LocalPath='/tmp/file.csv'
EXECUTE CreateLeadsImportJob LookupField='testCustomfieldEmail', ListId=1570, PartitionName='testPartition', LocalPath='/tmp/file.csv'
EXECUTE CreateLeadsImportJob FileData='ZW1haWwsZmlyc3ROYW1lLGxhc3ROYW1lLHRlc3RDdXN0b21maWVsZEVtYWlsCnRlc3RAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdEB0ZXN0Q3VzdG9tZmllbGRFbWFpbC5jZGF0YS5jb20KdGVzdDEyMzFAZXhhbXBsZS5jb20sSm9obixEb2UsdGVzdDFAdGVzdEN1c3RvbWZpZWxkRW1haWwuY2RhdGEuY29t'
| Name | Type | Required | Description |
| LookupField | String | False | 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. You can use id for update only operations. |
| PartitionName | String | False | Name of the lead partition to import to. |
| ListId | Integer | False | Id of the static list to import into. |
| Format | String | False | Format of the import file. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| LocalPath | String | False | The absolute path of the file to import. |
| FileData | String | False | Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set. |
| PollingInterval | Integer | False | In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Create a program members export job based on the given filters.
EXECUTE CreateProgramMembersExportJob ProgramId='6117'
EXECUTE CreateProgramMembersExportJob ProgramId='6117,6182'
EXECUTE CreateProgramMembersExportJob ProgramId='6117', Columns='acquiredBy=acqBy,*'
EXECUTE CreateProgramMembersExportJob ProgramId='6117,6182', UpdatedAtStartAt='2024-01-01', UpdatedAtEndAt='2024-01-30', IsExhausted='false', NurtureCadence='paus', StatusNames='Not in Program'
| Name | Type | Required | Description |
| Format | String | False | Format of export file to be generated. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| Columns | String | False | Comma separated list of columns that will be retrieved. Defaults to * (all columns). Different header names can be specified for each column using this syntax: columnName=csvHeaderName i.e.:leadRole=Role,marketingSuspendedCause=SuspendedCause,*
The default value is *. |
| UseAPINames | Boolean | False | If set to true, you must specify fields in the columns input based on their name in the Marketo API. Defaults to false, meaning you can provided column names based on the drivers metadata (sys_tablecolumns).
The default value is false. |
| UpdatedAtStartAt | Datetime | False | Inclusive lower bound filter for the lead update datetime. |
| UpdatedAtEndAt | Datetime | False | Inclusive upper bound filter for the lead update datetime. |
| ProgramId | String | True | Comma separated list of up to 10 program ids for which program members will be retrieved. |
| IsExhausted | Boolean | False | Boolean used to filter program membership records for people who have exhausted content. |
| NurtureCadence | String | False | Used to filter program membership records for a given nurture cadence.
The allowed values are paus, norm. |
| StatusNames | String | False | Comma separated list of program member status names to filter by. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| Status | String | The status of the export process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Imports the program member records from the provided file.
EXECUTE CreateProgramMembersImportJob ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='C:/users/cdata/file.csv'
EXECUTE CreateProgramMembersImportJob ProgramId=6145, ProgramMemberStatus='Influenced', LocalPath='/tmp/file.csv'
EXECUTE CreateProgramMembersImportJob ProgramId=6145, ProgramMemberStatus='Influenced', FileData='Zmlyc3ROYW1lLGxhc3ROYW1lLGVtYWlsLHRpdGxlLGNvbXBhbnksbGVhZFNjb3JlCkpvYW5uYSxMYW5uaXN0ZXIsSm9hbm5hQExhbm5pc3Rlci5jb20sTGFubmlzdGVyLEhvdXNlIExhbm5pc3RlciwwClR5d2luLExhbm5pc3RlcixUeXdpbkBMYW5uaXN0ZXIuY29tLExhbm5pc3RlcixIb3VzZSBMYW5uaXN0ZXIsMA=='
| Name | Type | Required | Description |
| ProgramId | Integer | True | Id of the program to add members to. |
| ProgramMemberStatus | String | True | Program member status for members being added. |
| Format | String | False | Format of the import file. Available values are: CSV, TSV, SSV
The allowed values are CSV, TSV, SSV. The default value is CSV. |
| LocalPath | String | False | The absolute path of the file to import. |
| FileData | String | False | Base64 string representation of the CSV content. Only used if LocalPath and InputStream are not set. |
| PollingInterval | Integer | False | In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import process. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Deactivates a trigger smart campaign.
EXECUTE DeActivateSmartCampaign Id=1
| Name | Type | Required | Description |
| Id | String | True | Id of the trigger smart campaign to deactivate. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Delete pending user. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users.
EXECUTE DeleteInvitedUser UserId='[email protected]'
| Name | Type | Required | Description |
| UserId | String | True | The user id in the form of an email address. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Puts an export job in queue and starts the job when computing resources become available.
EXECUTE EnqueueExportJob Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE EnqueueExportJob Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE EnqueueExportJob Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE EnqueueExportJob Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE EnqueueExportJob Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
| Name | Type | Required | Description |
| Id | String | True | The id of the export job. |
| Table | String | True | The table to export. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
| PollingInterval | Integer | False | In case the job queue is full Marketo will throw an error. We will keep trying to enqueue the job until the queue is freed. This value specifies the time in milliseconds between each poll. Set to -1 to simply throw the error instead of retrying. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Status | String | The status of the export process. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| QueuedAt | Datetime | The date when the export job was queued. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the serialized HTML version of the email.
EXECUTE GetEmailFullContent Id=23685
EXECUTE GetEmailFullContent Id=23685, EmailContentType='Text'
| Name | Type | Required | Description |
| Id | String | True | The Id of the email. |
| Status | String | False | Status filter for draft or approved versions. Defaults to approved if asset is approved, draft if not.
The allowed values are approved, draft. |
| LeadId | String | False | The lead id to impersonate. Email is rendered as though it was received by this lead. |
| EmailContentType | String | False | Email content type to return. Default is HTML.
The allowed values are HTML, Text. |
| Name | Type | Description |
| Id | String | The Id of the email. |
| Content | String | The content of the email. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the content for a given email template.
EXECUTE GetEmailTemplateContent Id=1054
| Name | Type | Required | Description |
| Id | Integer | True | Id of the email template. |
| Status | String | False | The status of the email template to retrieve the content from.
The allowed values are draft, approved. |
| Name | Type | Description |
| Id | Integer | Id of the email template. |
| Content | String | Content of the email template. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the file generated by the bulk job with the given Id.
EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d', LocalPath='C:/users/cdata/file.txt'
EXECUTE GetExportJobFile Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d', LocalPath='/tmp/file.txt'
| Name | Type | Required | Description |
| Id | String | True | The id of the export job. |
| Table | String | True | The exported table. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| ChunkSize | Long | False | The chunk size based on which the CSV file will be downloaded. Defaults to the value of the connection property 'ChunkSize'. Set to -1 to download the whole file at once. |
| DownloadSize | Long | False | The size in bytes to download. Can be retrieved from the field fileSize of the /status.json endpoint. If not set it will be automatically resolved and the whole file will be downloaded. |
| MaxThreads | Integer | False | The number of threads used to download the file. Defaults to the value specified in the connection string property 'MaxThreads'. |
| Name | Type | Description |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the status of an export job. Job status is available for 30 days after Completed or Failed status was reached.
EXECUTE GetExportJobStatus Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobStatus Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobStatus Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobStatus Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE GetExportJobStatus Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
| Name | Type | Required | Description |
| Id | String | True | The id of the export job. |
| Table | String | True | The exported table. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Status | String | The status of the export job. Applicable values: Created, Queued, Processing, Cancelled, Completed, Failed. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| QueuedAt | Datetime | The date when the export job was queued. |
| StartedAt | Datetime | The date when the export job was started. |
| FinishedAt | Datetime | The date when the export job was finished. |
| NumberOfRecords | Long | The number of records contained within the generated file. |
| FileSize | Long | The size in bytes of the generated file. |
| FileChecksum | String | The checksum of the generated file. |
| ErrorMessage | String | The error message in case of failed status. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the list of failures for the import batch job
EXECUTE GetImportJobFailures Id=1612, Table='Leads'
EXECUTE GetImportJobFailures Id=1612, Table='CustomObject_cdata', LocalPath='C:/users/cdata/file.txt'
EXECUTE GetImportJobFailures Id=1612, Table='ProgramMembers ', LocalPath='/tmp/file.txt'
| Name | Type | Required | Description |
| Id | String | True | The id of the import job. |
| Table | String | True | The table that data was imported to. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| Name | Type | Description |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the status of an import job.
EXECUTE GetImportJobStatus Id=1608, Table='Leads'
EXECUTE GetImportJobStatus Id=1609, Table='CustomObject_cdata'
EXECUTE GetImportJobStatus Id=1610, Table='ProgramMembers'
| Name | Type | Required | Description |
| Id | String | True | The id of the import job. |
| Table | String | True | The table that data was imported to. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import job. Applicable values: Queued, Importing, Complete, Failed. |
| RowsProcessed | Integer | The number of rows processed so far. |
| RowsFailed | Integer | The number of rows failed so far. |
| RowsWithWarning | Integer | The number of rows with a warning so far. |
| Message | String | The status message of the batch. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the list of warnings for the import batch job
EXECUTE GetImportJobWarnings Id=1612, Table='Leads'
EXECUTE GetImportJobWarnings Id=1612, Table='CustomObject_cdata', LocalPath='C:/users/cdata/file.txt'
EXECUTE GetImportJobWarnings Id=1612, Table='ProgramMembers ', LocalPath='/tmp/file.txt'
| Name | Type | Required | Description |
| Id | String | True | The id of the import job. |
| Table | String | True | The table that data was imported to. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object. |
| LocalPath | String | False | The absolute path where the file will be saved. |
| Name | Type | Description |
| FileData | String | If the LocalPath and FileStream inputs are empty, file data will be output as BASE64. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Retrieve a single pending user record through its Id. A pending user is a user that has not yet accepted invitation. Requires permissions: Access User Management Api and Access Users.
EXECUTE GetInvitedUserById UserId='[email protected]'
| Name | Type | Required | Description |
| UserId | String | True | The user id in the form of an email address. |
| Name | Type | Description |
| UserId | String | The user id in the form of an email address. |
| Id | Integer | The user identifier. |
| EmailAddress | String | The user's email address. |
| FirstName | String | The user's first name. |
| LastName | String | The user's last name. |
| SubscriptionId | String | The subscription id. |
| Status | String | The user status. |
| CreatedAt | Datetime | The date and time when the user login was created. |
| UpdatedAt | Datetime | The date and time when the user login was last updated. |
| ExpiresAt | Datetime | The date and time when the user login expires. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Returns the content for a given snippet.
EXECUTE GetSnippetContent SnippetId=1054
EXECUTE GetSnippetContent SnippetId=1054, Status='draft'
| Name | Type | Required | Description |
| SnippetId | Integer | True | Id of the snippet. |
| Status | String | False | The status of the snippet to retrieve the content from.
The allowed values are draft, approved. |
| Name | Type | Description |
| Content | String | Content of the snippet. |
| Type | String | Type of the snippet content. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Send an email invitation to new user. Requires permissions: Access User Management Api and Access Users.
EXECUTE InviteUser EmailAddress='[email protected]', FirstName='insert', LastName='api', UserWorkspaceRoles='[{"accessRoleId": 103, "workspaceId": 0}]
EXECUTE InviteUser EmailAddress='[email protected]', FirstName='insert', LastName='api', UserWorkspaceRoles='[{"accessRoleId": 103, "workspaceId": 0}]', Reason='test', UserId='[email protected]', ApiOnly=true, ExpiresAt='2024-12-12T00:00:00-01:00'
| Name | Type | Required | Description |
| EmailAddress | String | True | The user's email address. |
| FirstName | String | True | The user's first name. |
| LastName | String | True | The user's last name. |
| UserWorkspaceRoles | String | True | The user roles provided as a json array of objects containing accessRoleId and workspaceId. |
| UserId | String | False | The user id in the form of an email address. If not specified, the emailAddress value is used. |
| Reason | String | False | Reason for user invitation. |
| ApiOnly | Boolean | False | Whether the user is API-Only.
The default value is false. |
| ExpiresAt | Datetime | False | Date and time when user login expires. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Merges two or more known lead records into a single lead record.
EXECUTE MergeLeads WinningLeadId=1657, LosingLeadId='1665,1666,1667'
| Name | Type | Required | Description |
| WinningLeadId | Integer | True | Id of the winning lead record. |
| LosingLeadId | String | True | Ids of losing Lead records. |
| MergeInCRM | Boolean | False | Name of the new status for the program member. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Continuously polls the bulk API for the status of the export job until one of the following statuses is returned: Completed, Cancelled, Failed.
EXECUTE PollExportJobStatus Table='Leads', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE PollExportJobStatus Table='CustomObject_cdata', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE PollExportJobStatus Table='Activities', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE PollExportJobStatus Table='Activities_NewLead', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
EXECUTE PollExportJobStatus Table='ProgramMembers', Id='b4841291-0d27-48bc-8e9a-c639a6f33a0d'
| Name | Type | Required | Description |
| Id | String | True | The id of the export job. |
| Table | String | True | The exported table. Only certain tables support bulk exports, including: Activities, Leads, ProgramMembers and any custom object. |
| PollingInterval | Integer | False | The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| Name | Type | Description |
| Id | String | The Id of the export job. |
| Status | String | The status of the export process. Applicable values: Created, Queued, Processing, Cancelled, Completed, Failed. |
| Format | String | The format of the export job. |
| CreatedAt | Datetime | The date when the export job was created. |
| QueuedAt | Datetime | The date when the export job was queued. |
| StartedAt | Datetime | The date when the export job was started. |
| FinishedAt | Datetime | The date when the export job was finished. |
| NumberOfRecords | Long | The number of records contained within the generated file. |
| FileSize | Long | The size in bytes of the generated file. |
| FileChecksum | String | The checksum of the generated file. |
| ErrorMessage | String | The error message in case of failed status. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Will continuously poll the bulk API for the status of the import job until one of the following statuses is returned: Complete, Failed.
EXECUTE PollImportJobStatus Id=1608, Table='Leads'
EXECUTE PollImportJobStatus Id=1609, Table='CustomObject_cdata'
EXECUTE PollImportJobStatus Id=1610, Table='ProgramMembers'
| Name | Type | Required | Description |
| Id | String | True | The id of the import job. |
| Table | String | True | The table to import. Only certain tables support bulk imports, including: Leads, ProgramMembers and any custom object. |
| PollingInterval | Integer | False | The time in milliseconds between each poll. If not specified the value provided in the connection string will be used. See JobPollingInterval connection property for more information and the default value. |
| Name | Type | Description |
| Id | String | The Id of the import job. |
| Status | String | The status of the import job. Applicable values: Queued, Importing, Complete, Failed. |
| RowsProcessed | Integer | The number of rows processed so far. |
| RowsFailed | Integer | The number of rows failed so far. |
| RowsWithWarning | Integer | The number of rows with a warning so far. |
| Message | String | The status message of the batch. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Passes a set of leads to a trigger campaign to run through the campaign's flow.
EXECUTE ScheduleCampaign CampaignId=1107, RunAt='2024-06-06T01:00:00', CloneToProgramName='Program 1', TokenName='TestingSP', TokenValue='test'
EXECUTE ScheduleCampaign CampaignId=1107, RunAt='2024-06-06T01:00:00', TokenName='TestingSP,testTokenIndritB', TokenValue='\"test,asd\",2024-12-12'
EXECUTE ScheduleCampaign CampaignId=1107, RunAt='2024-06-06T01:00:00', TokenName#1='TestingSP', TokenValue#1='test', TokenName#2='testTokenIndritB', TokenValue#2='2024-12-12'
| Name | Type | Required | Description |
| CampaignId | Integer | True | Id of the campaign to schedule. |
| RunAt | Datetime | False | Datetime to run the campaign at. If unset, the campaign will be run five minutes after the call is made. |
| CloneToProgramName | String | False | Name of the resulting program. When used, this procedure is limited to 20 calls per day. |
| TokenName | String | False | Name of the token. Should be formatted as '{{my.name}}'. |
| TokenValue | String | False | Value of the token. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Sends a sample email to the given email address. Leads may be impersonated to populate data for tokens and dynamic content.
EXECUTE SendEmailSample Id=23685, Email='[email protected]'
| Name | Type | Required | Description |
| Id | String | True | The Id of the email. |
| String | True | Email address to receive the sample email. | |
| LeadId | String | False | Id of a lead to impersonate. Tokens and dynamic content will be populated as though it were sent to the lead. |
| TextOnly | String | False | Set to true to send the text only version along with the HTML version. Default false/ |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Remotely schedules a batch campaign to run at a given time.
EXECUTE TriggerCampaign CampaignId=12
EXECUTE TriggerCampaign CampaignId=12, LeadIds='1'
EXECUTE TriggerCampaign CampaignId=12, LeadIds='1,2,3', TokenName='token1,token2', TokenValue='value1,value2'
| Name | Type | Required | Description |
| CampaignId | Integer | True | Id of the campaign to schedule. |
| LeadIds | String | False | Lead ids to run through the campaign's flow. |
| TokenName | String | False | Name of the token. Should be formatted as '{{my.name}}' |
| TokenValue | String | False | Value of the token |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Revokes approval based on the given asset type and id.
EXECUTE UnApproveAsset Id=1005, Type='LandingPage'
| Name | Type | Required | Description |
| Id | String | True | Id of the asset. |
| Type | String | True | Type of the asset.
The allowed values are EmailTemplate, Email, Form, LandingPageTemplate, LandingPage, Snippet. |
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' contains the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Updates the content of an email.
EXECUTE UpdateEmailContent EmailId=23685, FromEmail='[email protected]', FromName='test', Subject='test subject', ReplyTo='[email protected]'
| Name | Type | Required | Description |
| EmailId | String | True | The Id of the email. |
| Subject | String | False | Subject Line of the Email. |
| FromEmail | String | False | From-address of the Email. |
| FromName | String | False | From-name of the Email. |
| ReplyTo | String | False | Reply-To address of the Email. |
| Name | Type | Description |
| EmailId | String | The Id of the updated email content. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Replaces the HTML of an Email that has had its relationship broken from its template.
EXECUTE UpdateEmailFullContent EmailId=23685, FileData='aGVsbG8gd29ybGQ='
EXECUTE UpdateEmailFullContent EmailId=23685, LocalPath='C:/users/cdata/file.txt'
EXECUTE UpdateEmailFullContent EmailId=23685, LocalPath='/tmp/file.txt'
| Name | Type | Required | Description |
| EmailId | String | True | The Id of the email. |
| LocalPath | String | False | The absolute path to a file where data is read from. |
| FileData | String | False | Base64 string representation of the file content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| EmailId | Integer | Id of the updated email template. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Updates the content of the given email template.
EXECUTE UpdateEmailTemplateContent EmailTemplateId=1054, FileData='PGh0bWw+Cjxib2R5Pgo8aDE+VEVTVCBIVE1MIFVQREFURUQ8L2gxPgo8L2JvZHk+CjwvaHRtbD4='
EXECUTE UpdateEmailTemplateContent EmailTemplateId=1054, LocalPath='C:/users/cdata/file.txt'
EXECUTE UpdateEmailTemplateContent EmailTemplateId=1054, LocalPath='/tmp/file.txt'
| Name | Type | Required | Description |
| EmailTemplateId | Integer | True | Id of the email template to update. |
| LocalPath | String | False | The absolute path to a file where data is read from. |
| FileData | String | False | Base64 string representation of the file content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| EmailTemplateId | Integer | Id of the updated email template. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Updates the content of the given file.
EXECUTE UpdateFile Id=3312, FileData='aGVsbG8gd29ybGQgdXBkYXRlZA=='
EXECUTE UpdateFile LocalPath='C:/users/cdata/file.txt'
EXECUTE UpdateFile LocalPath='/tmp/file.txt'
| Name | Type | Required | Description |
| Id | Integer | True | Id of the file to update. |
| LocalPath | String | False | The absolute path to a file where data is read from. |
| FileData | String | False | Base64 string representation of the file content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| Id | Integer | Id of the updated file. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Updates the content for the target landing page template.
EXECUTE UpdateLandingPageTemplateContent LandingPageTemplateId=1005, FileData='aGVsbG8gd29ybGQgdXBkYXRlZA=='
EXECUTE UpdateLandingPageTemplateContent LandingPageTemplateId=1005, LocalPath='C:/users/cdata/file.txt'
EXECUTE UpdateLandingPageTemplateContent LandingPageTemplateId=1005, LocalPath='/tmp/file.txt'
| Name | Type | Required | Description |
| LandingPageTemplateId | Integer | True | Id of the landing page template. |
| LocalPath | String | False | The absolute path to a file where data is read from. |
| FileData | String | False | Base64 string representation of the file content. Only used if LocalPath and InputStream are not set. |
| Name | Type | Description |
| LandingPageTemplateId | String | Id of the asset. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Update the lead partition for a list of leads.
EXECUTE UpdateLeadPartition LeadId='1557', PartitionName='testPartition'
EXECUTE UpdateLeadPartition LeadId='1557,1558,1559', PartitionName='testPartition'
| Name | Type | Required | Description |
| PartitionName | String | True | Name of the partition. |
| LeadId | String | True | Ids of Lead records to update. |
| Name | Type | Description |
| Id | Integer | Id of the lead. |
| Status | String | Status of update operation. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Changes the program status for a list of leads in a target program. Only existing members of the program may have their status changed with this procedure.
EXECUTE UpdateLeadProgramStatus LeadIds='1557,1558,1559', ProgramId=1001, StatusName='Not in Program'
| Name | Type | Required | Description |
| ProgramId | Integer | True | Id of the program. |
| LeadIds | String | True | Ids of Lead records to update. |
| StatusName | String | True | Name of the new status for the program member. |
| Name | Type | Description |
| Id | Integer | Id of the lead. |
| Status | String | Status of update operation. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
Updates the content of a snippet.
EXECUTE UpdateSnippetContent SnippetId=1054, Content='<h1>test<h1>', Type='HTML'
| Name | Type | Required | Description |
| SnippetId | Integer | True | The Id of the snippet. |
| Content | String | True | The content of the snippet. |
| Type | String | False | The type of the content of the snippet.
The allowed values are DynamicContent, Text, HTML. The default value is Text. |
| Name | Type | Description |
| Id | Integer | The Id of the updated snippet. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Marketo:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Leads table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Leads'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the GetEmailFullContent stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetEmailFullContent' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetEmailFullContent' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Marketo procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Leads table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Leads'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| URL | The URL of the Marketo instance to connect to. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| BulkLeadsSupportsUpdatedAt | If set to true, the updatedAt filter will be marked as server-side supported. |
| BulkProgramMembersSupportsUpdatedAt | If set to true, the updatedAt filter will be marked as server-side supported. |
| DownloadChunkSize | The size of chunks (in bytes) when downloading large files. |
| IsCRMEnabled | Set to true to avoid pushing tables that are not available when CRM is enabled in Marketo. |
| JobPollingInterval | The maxmimum wait time in milliseconds between each job status poll. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Marketo. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UploadChunkSize | The size of chunks (in bytes) when uploading large files. |
| UseBulkAPI | Specifies whether to use the Marketo Bulk API. |
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
| Property | Description |
| URL | The URL of the Marketo instance to connect to. |
The URL of the Marketo instance to connect to.
string
""
The URL of the REST API Service. Can be found in Admin -> Integration -> Web Services -> REST API. Example: https://123-abc-456.mktorest.com/ or https://123-abc-456.mktorest.com/rest.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| BulkLeadsSupportsUpdatedAt | If set to true, the updatedAt filter will be marked as server-side supported. |
| BulkProgramMembersSupportsUpdatedAt | If set to true, the updatedAt filter will be marked as server-side supported. |
| DownloadChunkSize | The size of chunks (in bytes) when downloading large files. |
| IsCRMEnabled | Set to true to avoid pushing tables that are not available when CRM is enabled in Marketo. |
| JobPollingInterval | The maxmimum wait time in milliseconds between each job status poll. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Marketo. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UploadChunkSize | The size of chunks (in bytes) when uploading large files. |
| UseBulkAPI | Specifies whether to use the Marketo Bulk API. |
If set to true, the updatedAt filter will be marked as server-side supported.
string
"Auto"
Only some Marketo instances support the UpdatedAt filter for Leads Bulk Exports. To enable the filter you need to reach out to Marketo support.
| True | The Leads.UpdatedAt filter will be processed server-side. |
| False | The Leads.UpdatedAt filter will be processed client-side. |
| Auto | The driver will execute a probe query to check if the filter is supported or not. |
If set to true, the updatedAt filter will be marked as server-side supported.
string
"Auto"
Only some Marketo instances support the UpdatedAt filter for ProgramMembers Bulk Exports. To enable the filter you need to reach out to Marketo support.
| True | The ProgramMembers.UpdatedAt filter will be processed server-side. |
| False | The ProgramMembers.UpdatedAt filter will be processed client-side. |
| Auto | The driver will execute a probe query to check if the filter is supported or not. |
The size of chunks (in bytes) when downloading large files.
string
"3000000"
The size of chunks (in bytes) to use when downloading large files, defaults to 3MB. To download the entire file in one chunk, set this value to -1.
Set to true to avoid pushing tables that are not available when CRM is enabled in Marketo.
string
"Auto"
| True | Tables that are not available when CRM is enabled in Marketo will not be pushed. |
| False | The driver will push all tables normally. |
| Auto | The driver will execute a probe query to check if CRM is enabled or not. |
The maxmimum wait time in milliseconds between each job status poll.
string
"10000"
Initially the wait time is 5 seconds and doubles until it reaches the given JobPollingInterval.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the number of concurrent requests.
string
"5"
This property allows you to issue multiple requests simultaneously, thereby improving performance.
Specifies the maximum number of records per page the provider returns when requesting data from Marketo.
int
300
When processing a query, instead of requesting all of the queried data at once from Marketo, the Cloud can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Cloud requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
300
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
The size of chunks (in bytes) when uploading large files.
string
"10000000"
The size of chunks (in bytes) to use when uploading large files, defaults to 10MB. To upload the entire file in one chunk, set this value to -1.
Specifies whether to use the Marketo Bulk API.
string
"False"
| True | The Marketo Bulk API will be used to extract or import data where applicable in SELECT/UPSERT statemnts. |
| False | The driver will not make use of the Bulk API. |
| Auto | The driver will make use of the Bulk API only in cases when the REST API is not sufficient such as when querying more than 100_000 records from the ProgramMembers table. |
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.