Marketo REST Python

Python Client that covers the complete Marketo REST API. It handles authentication, error handling and rate limiting to the standard limit of 100 calls in 20 seconds (defined in http_lib module). This is a fork of the project started by Arunim Samat at https://github.com/asamat/python_marketo, which had stalled.

Full Marketo REST API documentation - http://developers.marketo.com/documentation/rest/

Installation

pip install marketorestpython

Unit tests

python setup.py develop
pip install -r requirements-tests.txt
py.test tests/

Usage

from marketorestpython.client import MarketoClient
munchkin_id = "" # fill in Munchkin ID, typical format 000-AAA-000
client_id = "" # enter Client ID from Admin > LaunchPoint > View Details
client_secret= "" # enter Client ID and Secret from Admin > LaunchPoint > View Details
mc = MarketoClient(munchkin_id, client_id, client_secret)

Then use mc.execute(method='') to call the various methods (see documentation below)

Lead, List, Activity and Campaign Objects

Get Lead by Id

API Ref: http://developers.marketo.com/documentation/rest/get-lead-by-id/

lead = mc.execute(method='get_lead_by_id', id=3482141, fields=['firstName', 'middleName', 'lastName', 'department'])

# fields is optional

Get Multiple Leads by Filter Type

API Ref: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-filter-type/

lead = mc.execute(method='get_multiple_leads_by_filter_type', filterType='email', filterValues=['a@b.com','c@d.com'], 
                  fields=['firstName', 'middleName', 'lastName'], batchSize=None)

# fields and batchSize are optional
# max 100 filterValues
# max 1000 results, otherwise you'll get error 1003 ('Too many results match the filter')

Get Multiple Leads by List Id

API Ref: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-list-id/

mc.execute(method='get_multiple_leads_by_list_id', listId='676', 
                fields=['email','firstName','lastName','company','postalCode'], batchSize=None)

# fields and batchSize are optional
# static lists only (does not work with smart lists)

Get Multiple Leads by List Id Yield (Generator)

API Ref: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-list-id/

for leads in mc.execute(method='get_multiple_leads_by_list_id_yield', listId='676', 
                fields=['email','firstName','lastName'], batchSize=None):
    print(len(leads))

# OR: 

leads = mc.execute(method='get_multiple_leads_by_list_id_yield', listId='676', 
                fields=['email','firstName','lastName'], batchSize=None)
lead_chunk = next(leads) # keep calling next until no more Leads

# this is a generator, so it will return chunks of Leads rather that all Leads on the 
#   List at once; therefore, it's useful for Lists with large numbers of Leads 
# fields and batchSize are optional; batchSize defaults to 300, which is the max
# static lists only (does not work with smart lists)

Get Multiple Leads by Program Id

API Ref: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-program-id/

mc.execute(method='get_multiple_leads_by_program_id', programId='1014', 
                fields=['email','firstName','lastName','company','postalCode'], batchSize=None)

# fields and batchSize are optional

Get Multiple Leads by Program Id Yield (Generator)

API Ref: http://developers.marketo.com/documentation/rest/get-multiple-leads-by-program-id/

for leads in mc.execute(method='get_multiple_leads_by_program_id_yield', programId='1014', 
                fields=['email','firstName','lastName','company','postalCode'], batchSize=None):
    print(len(leads))

# this is a generator, so it will return chunks of Leads rather that all Program Members 
#   at once; therefore, it's useful for Programs with large numbers of Members 
# fields and batchSize are optional

Change Lead Program Status

API Ref: http://developers.marketo.com/documentation/rest/change-lead-program-status/

status = mc.execute(method = 'change_lead_program_status', id=1097, leadIds=[51,10,11,24], status="Registered")

Create/Update Leads

API Ref: http://developers.marketo.com/documentation/rest/createupdate-leads/

leads = [{"email":"joe@example.com","firstName":"Joe"},{"email":"jill@example.com","firstName":"Jill"}]
lead = mc.execute(method='create_update_leads', leads=leads, action='createOnly', lookupField='email', 
                asyncProcessing='false', partitionName='Default')

# action, lookupField and asyncProcessing are optional (defaults are 'email' and 'false')
# action can be "createOrUpdate" (default if omitted), "createOnly", "updateOnly" or "createDuplicate"
# partitionName is required if Marketo instance has more than 1 Lead Partition
# max batch size is 300

Associate Lead

API Ref: http://developers.marketo.com/documentation/rest/associate-lead/

lead = mc.execute(method='associate_lead', id=2234, cookie='id:287-GTJ-838%26token:_mch-marketo.com-1396310362214-46169')

Push Lead

API Ref: http://developers.marketo.com/rest-api/endpoint-reference/lead-database-endpoint-reference/#!/Leads/pushToMarketoUsingPOST

leads = [
    {"email":"lead1@example.com","firstName":"Joe", "cookies":"id:662-XAB-092&token:_mch-castelein.net-1487035251303-23757"},
    {"email":"lead2@example.com","firstName":"Jillian"}
]
lead = mc.execute(method='push_lead', leads=leads, lookupField='email', programName='Big Launch Webinar',
                  programStatus='Registered', source='example source', reason='example reason')

# leads, lookupField and programName are required
# all others are optional
# to associate Cookie ID, put it in a field called 'cookies' (see example above)
# to associate mkt_tok, put it in a field called 'mktToken' (see http://developers.marketo.com/rest-api/lead-database/leads/#push_lead_to_marketo)

Merge Lead

API Ref: http://developers.marketo.com/documentation/rest/merge-lead/

lead = mc.execute(method='merge_lead', id=3482183, leadIds=[3482182], mergeInCRM=False)

# mergeInCRM is optional (default is False)
# returns True if successful

Get Lead Partitions

API Ref: http://developers.marketo.com/documentation/rest/get-lead-partitions/

lead = mc.execute(method='get_lead_partitions')

Get List by Id

API Ref: http://developers.marketo.com/documentation/rest/get-list-by-id/

lead = mc.execute(method='get_list_by_id', id=724)

Get Multiple Lists

API Ref: http://developers.marketo.com/documentation/rest/get-multiple-lists/

lead = mc.execute(method='get_multiple_lists', id=[724,725], name=None, programName=None, workspaceName=None, batchSize=300)

# all parameters are optional; no parameters returns all lists

Add Leads to List

API Ref: http://developers.marketo.com/documentation/rest/add-leads-to-list/

lead = mc.execute(method='add_leads_to_list', listId=1, id=[1,2,3])

# max batch size is 300

Remove Leads from List

API Ref: http://developers.marketo.com/documentation/rest/remove-leads-from-list/

lead = mc.execute(method='remove_leads_from_list', listId=1, id=[1,2,3])

# max batch size is 300

Member of List

API Ref: http://developers.marketo.com/documentation/rest/member-of-list/

lead = mc.execute(method='member_of_list', listId=728, id=[3482093,3482095,3482096])

Get Campaign by Id

API Ref: http://developers.marketo.com/documentation/rest/get-campaign-by-id/

lead = mc.execute(method='get_campaign_by_id', id=1170)

Get Multiple Campaigns

API Ref: http://developers.marketo.com/documentation/rest/get-multiple-campaigns/

lead = mc.execute(method='get_multiple_campaigns', id=[1170,1262], name=None, programName=None, workspaceName=None, batchSize=None)

# all parameters are optional

Schedule Campaign

API Ref: http://developers.marketo.com/documentation/rest/schedule-campaign/

# date format: 2015-11-08T15:43:12-08:00
from datetime import datetime, timezone, timedelta
now = datetime.now(timezone.utc)
now_no_ms = now.replace(microsecond=0)
now_plus_7 = now_no_ms + timedelta(minutes = 7)
time_as_txt = now_plus_7.astimezone().isoformat()
print(time_as_txt)
lead = mc.execute(method='schedule_campaign', id=1878, runAt=time_as_txt, tokens={'my.Campaign Name': 'new token value'}, cloneToProgramName=None)

# runAt is optional; default is 5 minutes from now; if specified, it needs to be at least 5 minutes from now
# tokens and cloneToProgramName are optional
# returns True

Request Campaign

API Ref: http://developers.marketo.com/documentation/rest/request-campaign/

lead = mc.execute(method='request_campaign', id=1880, leads=[46,38], tokens={'my.increment': '+2'})

# tokens is optional
# returns True

Import Lead

API Ref: http://developers.marketo.com/documentation/rest/import-lead/

lead = mc.execute(method='import_lead', file='../folder/test.csv', format='csv', lookupField='email', listId=None, partitionName='Default')

# lookupField and listId are optional. Email is the default for lookupField.
# partitionName is required when the Marketo instance has more than 1 Lead Partition

Get Import Lead Status

API Ref: http://developers.marketo.com/documentation/rest/get-import-lead-status/

lead = mc.execute(method='get_import_lead_status', id=900)

# specify the batchId that is returned in 'Import Lead'

Get Import Failure File

API Ref: http://developers.marketo.com/documentation/rest/get-import-failure-file/

batch_id = 899
failed_leads = mc.execute(method='get_import_failure_file', id=batch_id)
file_name = "import-failure-for-batch-" + str(batch_id) + ".csv"
if failed_leads is not '':
    f = open(file_name, encoding='utf-8', mode='w')
    f.write(failed_leads)
    f.close()

# specify the batchId that is returned in 'Import Lead'

Get Import Warning File

API Ref: http://developers.marketo.com/documentation/rest/get-import-warning-file/

batch_id = 899
warning_leads = mc.execute(method='get_import_warning_file', id=batch_id)
file_name = "import-warning-for-batch-" + str(batch_id) + ".csv"
if warning_leads is not '':
    f = open(file_name, encoding='utf-8', mode='w')
    f.write(warning_leads)
    f.close()

# specify the batchId that is returned in 'Import Lead'

Describe

API Ref: http://developers.marketo.com/documentation/rest/describe/

lead = mc.execute(method='describe')

Get Activity Types

API Ref: http://developers.marketo.com/documentation/rest/get-activity-types/

mc.execute(method = 'get_activity_types')

Get Paging Token

API Ref: http://developers.marketo.com/documentation/rest/get-paging-token/

mc.execute(method='get_paging_token', sinceDatetime='2014-10-06')

# sinceDatetime format: 2015-10-06T13:22:17-08:00 or 2015-10-06T13:22-0700 or 2015-10-06
# This call is optional, you can directly pass in the datetime into 'Get Lead Activity' and 'Get Lead Changes'
# Returns the paging token

Get Lead Activities

API Ref: http://developers.marketo.com/documentation/rest/get-lead-activities/

mc.execute(method='get_lead_activities', activityTypeIds=['23','22'], nextPageToken=None, 
    sinceDatetime='2015-10-06', untilDatetime='2016-04-30' 
    batchSize=None, listId=None, leadIds=[1,2])

# sinceDatetime format: 2015-10-06T13:22:17-08:00 or 2015-10-06T13:22-0700 or 2015-10-06
# either nextPageToken or sinceDatetime need to be specified
# untilDatetime, batchSize, listId and leadIds are optional; batchsize defaults to 300 (max)
# unless you specify untilDatetime, the function loops until it has all activities until right now, 
#  then returns them (which could potentially be a lot of data)

Get Lead Activities Yield (Generator)

API Ref: http://developers.marketo.com/documentation/rest/get-lead-activities/

for activities in mc.execute(method='get_lead_activities_yield', activityTypeIds=['23','22'], nextPageToken=None, 
                             sinceDatetime='2015-10-06', untilDatetime='2016-04-30' 
                             batchSize=None, listId=None, leadIds=[1,2]):
    print(len(activities))

# sinceDatetime format: 2015-10-06T13:22:17-08:00 or 2015-10-06T13:22-0700 or 2015-10-06
# either nextPageToken or sinceDatetime need to be specified
# untilDatetime, batchSize, listId and leadIds are optional; batchsize defaults to 300 (max)
# this is a generator, so it will return chunks of Leads rather that all Activities 
#   at once; therefore, it's useful for retrieving large numbers of Activities

Get Lead Changes

API Ref: http://developers.marketo.com/documentation/rest/get-lead-changes/

lead = mc.execute(method='get_lead_changes', fields=['firstName','lastName'], nextPageToken=None,
                  sinceDatetime='2015-09-01', untilDatetime='2017-01-01', batchSize=None, listId=None)

# sinceDatetime format: 2015-10-06T13:22:17-08:00 or 2015-10-06T13:22-0700 or 2015-10-06
# either nextPageToken or sinceDatetime need to be specified
# untilDatetime, batchSize and listId are optional; batchsize defaults to 300 (max)
# this will potentially return a lot of records: the function loops until it has all activities, then returns them

Get Lead Changes Yield (Generator)

API Ref: http://developers.marketo.com/documentation/rest/get-lead-changes/

for leads in mc.execute(method='get_lead_changes_yield', fields=['firstName','lastName'], nextPageToken=None,
                  sinceDatetime='2015-09-01', untilDatetime='2017-01-01', batchSize=None, listId=None):
    print(len(leads))

# sinceDatetime format: 2015-10-06T13:22:17-08:00 or 2015-10-06T13:22-0700 or 2015-10-06
# either nextPageToken or sinceDatetime need to be specified
# untilDatetime, batchSize and listId are optional; batchsize defaults to 300 (max)
# this will potentially return a lot of records: the function loops until it has all activities, then returns them

Add Custom Activities

API Ref: http://developers.marketo.com/documentation/rest/add-custom-activities/

custom_activities = [
    {
        "leadId": 46,
        "activityDate": "2016-03-05T09:51:00-08:00",
        "activityTypeId": 100004,
        "primaryAttributeValue":"Blue",
        "attributes":[
            {
                "name": "Attribute 1",
                "value": "First Attribute"
            },
            {
                "name": "Attribute 2",
                "value": "Second Attribute"
            }
        ]
    }
]
result = mc.execute(method = 'add_custom_activities', input=custom_activities)

# Currently, Custom Activities need to be set up by Marketo Technical Support or Consulting Services
# max batch size is 300

Get Daily Usage

API Ref: http://developers.marketo.com/documentation/rest/get-daily-usage/

lead = mc.execute(method='get_daily_usage')

Get Last 7 Days Usage

API Ref: http://developers.marketo.com/documentation/rest/get-last-7-days-usage/

lead = mc.execute(method='get_last_7_days_usage')

Get Daily Errors

API Ref: http://developers.marketo.com/documentation/rest/get-daily-errors/

lead = mc.execute(method='get_daily_errors')

Get Last 7 Days Errors

API Ref: http://developers.marketo.com/documentation/rest/get-last-7-days-errors/

lead = mc.execute(method='get_last_7_days_errors')

Delete Lead

API Ref: http://developers.marketo.com/documentation/rest/delete-lead/

lead = mc.execute(method='delete_lead', id=[1,2])

# max batch size is 300

Get Deleted Leads

API Ref: http://developers.marketo.com/documentation/rest/get-deleted-leads/

lead = mc.execute(method='get_deleted_leads', nextPageToken=None, sinceDatetime=date.today(), batchSize=None)

# sinceDatetime format: 2015-10-06T13:22:17-08:00 or 2015-10-06T13:22-0700 or 2015-10-06
# either nextPageToken or sinceDatetime need to be specified
# batchSize is optional
# will return first and last name, Marketo ID and time of deletion, but no additional Lead attributes

Update Leads Partition

API Ref: http://developers.marketo.com/documentation/rest/update-leads-partition/

new_partitions = [{'id': 3482156, 'partitionName': 'Default'}, {'id': 3482141, 'partitionName': 'Europe'}]
lead = mc.execute(method='update_leads_partition', input=new_partitions)

Folders

Create Folder

API Ref: http://developers.marketo.com/documentation/asset-api/create-folder/

folder = mc.execute(method='create_folder', name='folder2', parentId=115, parentType="Folder", description='optional')

# parentType is "Folder" or "Program"
# description is optional

Get Folder by Id

API Ref: http://developers.marketo.com/documentation/asset-api/get-folder-by-id/

folder = mc.execute(method='get_folder_by_id', id=3, type='Folder')

# type is 'Folder' or 'Program'; this is required because a Folder and a Program can have the same Id
# will throw KeyError when no folder found

Get Folder by Name

API Ref: http://developers.marketo.com/documentation/asset-api/get-folder-by-name/

folder = mc.execute(method='get_folder_by_name', name='test', type='Folder', root=115, workSpace='Europe')

# type, root and workSpace are optional
# will throw KeyError when no folder found

Get Folder Contents

API Ref: http://developers.marketo.com/documentation/asset-api/get-folder-contents/

assets = mc.execute(method='get_folder_contents', id=1205, type='Program', maxReturn=None)

# type is Folder or Program
# maxReturn is optional; default for maxReturn is 20 and max is 200
# function will loop and return all results

Update Folder

API Ref: http://developers.marketo.com/documentation/asset-api/update-folder/

folder = mc.execute(method='update_folder', id=141, name="New Name", description=None, isArchive=None)

# name, description and isArchive are optional
# use the id as returned by 'Browse Folders' or 'Get Folder by Name
# can only be used to update Folders, not Programs

Delete Folder

API Ref: http://developers.marketo.com/documentation/asset-api/delete-folder-by-id/

folder = mc.execute(method='delete_folder', id=789)

# can only be used to delete Folders, not Programs

Browse Folders

API Ref: http://developers.marketo.com/documentation/asset-api/browse-folders

lead = mc.execute(method='browse_folders', root=3, maxDepth=5, maxReturn=200, workSpace='Default')

# maxDepth, maxReturn and workSpace are optional; default for maxReturn is 20 and max is 200
# use the id as returned by 'Browse Folders' or 'Get Folder by Name
# function will loop and return all results
# will throw KeyError when no folder found

Tokens

Create Token

API Ref: http://developers.marketo.com/documentation/asset-api/create-token-by-folder-id/

token = mc.execute(method='create_token', id="28", folderType="Folder", name="test", value="testing 2", type="text")

# this can also be used to update the value of a token

Get Tokens

API Ref: http://developers.marketo.com/documentation/asset-api/get-tokens-by-folder-id/

tokens = mc.execute(method='get_tokens', id="28", folderType="Folder")

Delete Tokens

API Ref: http://developers.marketo.com/documentation/asset-api/delete-tokens-by-folder-id/

tokens = mc.execute(method='delete_tokens', id="28", folderType="Folder", name="test", type="text")

Email Templates

Create Email Template

API Ref: http://developers.marketo.com/documentation/asset-api/create-email-template/

template = mc.execute(method='create_email_template', folderId=14, folderType="Folder", name="API Email Template", 
    content="email_template.html", description="Hello Description")

# description is optional
# content should contain path to HTML file

Get Email Template by Id

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-template-by-id/

template = mc.execute(method='get_email_template_by_id', id=41, status='approved')

# status is optional; values are 'draft' or 'approved'; a single email can have both an approved and a draft version

Get Email Template by Name

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-template-by-name/

template = mc.execute(method='get_email_template_by_name', name='API Email Template', status='approved')

# status is optional: values are 'draft' or 'approved'; a single email can have both an approved and a draft version

Update Email Template

API Ref: http://developers.marketo.com/documentation/asset-api/update-email-template/

template = mc.execute(method='update_email_template', id=41, name='API Email Template', description=None)

# name and description are optional, but - of course - you want to pass in at least 1 of them
# this is only to update name and description, use 'Update Email Template Content' to update the HTML

Delete Email Template

API Ref: http://developers.marketo.com/documentation/asset-api/delete-email-template-by-id/

template = mc.execute(method='delete_email_template', id=41)

Get Email Templates

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-templates/

template = mc.execute(method='get_email_templates', status='draft', maxReturn=None)

# status and maxReturn are optional; status is 'draft' or 'approved'; default for maxReturn is 20 and max is 200
# if you specify status, it will return an approved email with a draft for both status='draft' AND status='approved'

Get Email Template Content

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-template-content-by-id/

template = mc.execute(method='get_email_template_content', id=39, status='approved')
with open('email-template-content.html', 'w', encoding='utf-8') as f:
    f.write(template[0]['content'])

# status is optional: values are 'draft' or 'approved'

Update Email Template Content

API Ref: http://developers.marketo.com/documentation/asset-api/update-email-template-content-by-id/

template = mc.execute(method='update_email_template_content', id=42, content='email-template-content.html')

# 'content' points to a file

Approve Email Template

API Ref: http://developers.marketo.com/documentation/asset-api/approve-email-template-by-id/

template = mc.execute(method='approve_email_template', id=42)

Unapprove Email Template

API Ref: http://developers.marketo.com/documentation/asset-api/unapprove-email-template-by-id/

template = mc.execute(method='unapprove_email_template', id=42)

Discard Email Template Draft

API Ref: http://developers.marketo.com/documentation/asset-api/discard-email-template-draft-by-id/

template = mc.execute(method='discard_email_template_draft', id=42)

Clone Email Template

API Ref: http://developers.marketo.com/documentation/asset-api/clone-email-template/

template = mc.execute(method='clone_email_template', id=42, name='cloned template', folderId=14, folderType='Folder')

# folderId 14 is the Email Templates folder in the Default workspace

Emails

Create Email

API Ref: http://developers.marketo.com/documentation/asset-api/create-email/

email = mc.execute(method='create_email', folderId=13, folderType="Folder", name="API Email", template=30,
                      description='Hello Description', subject='Subject for API Email', fromName='Info',
                      fromEmail='info@example.com', replyEmail=None, operational=None)

# description, subject, fromName, fromEmail, replyEmail and operational are optional
# without subject, fromName and fromEmail you can't approve the email
# this is where you create the email shell, in 'Update Email Content in Editable Section' you specify the email body

Get Email by Id

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-by-id/

email = mc.execute(method='get_email_by_id', id=263, status='draft')

# status is optional: values are 'draft' or 'approved'

Get Email by Name

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-by-name/

email = mc.execute(method='get_email_by_name', name='API Email', status='draft', folderId=None, folderType=None)

# status, folderId and folderType are optional; folderId and folderType need to be specified together

Delete Email

API Ref: http://developers.marketo.com/documentation/asset-api/delete-email-by-id/

email = mc.execute(method='delete_email', id=263)

Update Email

API Ref: http://developers.marketo.com/documentation/asset-api/update-email/

email = mc.execute(method='update_email', id=264, name="API Email 2", description='Hello New Description')

# name and description are optional, but - of course - you want to pass in at least 1 of them

Get Emails

API Ref: http://developers.marketo.com/documentation/asset-api/get-emails/

email = mc.execute(method='get_emails', status='approved', folderId=13, folderType='Folder', maxReturn=None)

# status, folderId, folderType and maxReturn are optional; folderId and folderType need to be specified together
# default for maxReturn is 20 and max is 200
# status can be 'draft' or 'approved'

Get Email Content

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-content-by-id

email = mc.execute(method='get_email_content', id=40, status=None)

# status is optional and can be 'draft' or 'approved'

Update Email Content

API Ref: http://developers.marketo.com/documentation/asset-api/update-email-content-by-id

email = mc.execute(method='update_email_content', id=13, type='Text', subject='New Subject Line',
                   fromEmail='jep@example.com', fromName='Jep', replyTo='jep@example.com')

# subject, fromEmail, fromName and replyTo are optional
# type should be 'Text' or 'DynamicContent'; if you need a combination of text and dynamic, make 2 calls

Update Email Content in Editable Section

API Ref: http://developers.marketo.com/documentation/asset-api/update-email-content-in-editable-section/

html_content = '''<span style="color:#d9930e; font-size:27px;">Dear {{lead.First Name:default=friend}}, Donec 
                  Scelerisque Leosera</span><br /><br /><div style="font-size:18px;">Aliquam nec erat at purus 
                  cursus interdum<br/>vestibulum ligula augue</div><br />'''
email = mc.execute(method='update_email_content_in_editable_section', id=275, htmlId='lt-column', type='Text', 
                   value=html_content, textValue=None)

# textValue is optional
# type can be 'Text', 'DynamicContent' or 'Snippet'

Get Email Dynamic Content

API Ref: http://developers.marketo.com/documentation/asset-api/get-email-dynamic-content-by-id/

email = mc.execute(method='get_email_dynamic_content', id=279, dynamicContentId='RVMtU2VjdGlvbiAx', status=None)

# status is optional and can be 'draft' or 'approved'

Update Email Dynamic Content

API Ref: http://developers.marketo.com/documentation/asset-api/update-email-dynamic-content-by-id/

email = mc.execute(method='update_email_dynamic_content', id=280, dynamicContentId='RVMtY29sdW1uX3N1YnRpdGxl',
                   segment='Dutch', value='<p>Dutch text</p>', type='HTML')

Approve Email

API Ref: http://developers.marketo.com/documentation/asset-api/approve-email-by-id

email = mc.execute(method='approve_email', id=117)

Unapprove Email

API Ref: http://developers.marketo.com/documentation/asset-api/unapprove-email-by-id

email = mc.execute(method='unapprove_email', id=117)

Discard Email Draft

API Ref: http://developers.marketo.com/documentation/asset-api/discard-email-draft-by-id/

email = mc.execute(method='discard_email_draft', id=117)

Clone Email

API Ref: http://developers.marketo.com/documentation/asset-api/clone-email

email = mc.execute(method='clone_email', id=117, name='clone of MHE', folderId=13, folderType='Folder', 
                   description='description', operational=None)

# description and operational are optional; operational defaults to false

Send Sample Email

API Ref: http://developers.marketo.com/documentation/asset-api/send-sample-email/

email = mc.execute(method='send_sample_email', id=117, emailAddress='jep@example.com', textOnly=None, leadId=46)

# textOnly and leadId are optional; textOnly will send the text version of the email in additional to the html version

Landing pages

Get Landing Pages

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-landing-pages/

lp = mc.execute(method='get_landing_pages', maxReturn=None, status=None, folderId=None, folderType=None)

# status, folderId, folderType and maxReturn are optional; folderId and folderType need to be specified together
# default for maxReturn is 20 and max is 200
# status can be 'draft' or 'approved'

Create Landing Page

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/create-landing-page/

lp = mc.execute(method='create_landing_page', name='API LP', folderId=894,
                folderType='Folder', template=42, description=None, title=None, 
                keywords=None, robots=None, customHeadHTML=None, facebookOgTags=None,
                prefillForm=None, mobileEnabled=None)

# description, title, keywords, robots, customHeadHTML, facebookOgTags, 
#  prefillForm and mobileEnabled are optional
# prefillForm and mobileEnabled default to false

Get Landing Page by Id

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-landing-page-by-id/

lp = mc.execute(method='get_landing_page_by_id', id=360, status=None)

# status is optional and can be 'draft' or 'approved'

Get Landing Page by Name

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-landing-page-by-name/

lp = mc.execute(method='get_landing_page_by_name', name='Landing page Demo', status=None)

# status is optional and can be 'draft' or 'approved'

Delete Landing Page

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/delete-landing-page/

lp = mc.execute(method='delete_landing_page', id=411)

Update Landing Page Metadata

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-landing-page-metadata/

lp = mc.execute(method='update_landing_page', id=410, description=None, title=None,
                keywords=None, robots=None, customHeadHTML=None, facebookOgTags=None, 
                prefillForm=None, mobileEnabled=None, styleOverRide=None, urlPageName=None)

# description, title, keywords, robots, customHeadHTML, facebookOgTags, 
#  prefillForm, mobileEnabled, styleOverRide and urlPageName are optional
# urlPageName is used to change the URL of the page

Get Landing Page Content

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-landing-page-content/

lp = mc.execute(method='get_landing_page_content', id=410, status='draft')

# status is optional and can be 'draft' or 'approved'

Create Landing Page Content Section

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/add-landing-page-content-section/

lp = mc.execute(method='create_landing_page_content_section', id=410, type='RichText', value='<p>Subtitle</p>',
                backgroundColor=None, borderColor=None, borderStyle=None, borderWidth=None, height=None,
                layer=None, left=100, opacity=1.0, top=50, width=300, hideDesktop=None, hideMobile=None,
                contentId=None)

# contentId is required for Guided Landing pages
# backgroundColor, borderColor, borderStyle, borderWidth, height, layer, left, opacity, top, width, 
#  hideDesktop and hideMobile are optional
# height defaults to auto; layer defaults to 15; specify opacity as fractional and use 1.0 for 100%
# backgroundColor, borderColor, borderStyle and borderWidth don't seem to do anything at this time

Update Landing Page Content Section

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-landing-page-content-section/

lp = mc.execute(method='update_landing_page_content_section', id=410, contentId=2200, type='RichText',
                value='<p>Updated Title</p>', backgroundColor=None, borderColor=None, borderStyle=None,
                borderWidth=None, height=None, zIndex=15, left=50, opacity=1.0, top=50, width=300, 
                hideDesktop=None, hideMobile=None, imageOpenNewWindow=None, linkUrl=None)

# make section dynamic: 
lp = mc.execute(method='update_landing_page_content_section', id=410, contentId=2218,
                                  type='DynamicContent', value=1003)

# backgroundColor, borderColor, borderStyle, borderWidth, height, layer, left, opacity, top, width, 
#  hideDesktop and hideMobile are optional
# height defaults to auto; layer defaults to 15; specify opacity as fractional and use 1.0 for 100%
# contentId changes when the page is approved
# in case of type=DynamicContent, the value is the id of the Segmentation
# backgroundColor, borderColor, borderStyle and borderWidth don't seem to do anything

Delete Landing Page Content Section

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/delete-landing-page-content-section/

lp = mc.execute(method='delete_landing_page_content_section', id=410, contentId=2215)

# use 'Get Landing page Content' to find the contentId (which changes when page is approved)

Get Landing Page Dynamic Content

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-dynamic-content-section/

lp = mc.execute(method='get_landing_page_dynamic_content', id=410, ...)

Update Landing Page Dynamic Content

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-dynamic-content-section/

lp = mc.execute(method='update_landing_page_dynamic_content', id=410, ...)

Approve Landing Page

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/discard-landing-page-draft/

lp = mc.execute(method='approve_landing_page', id=410)

Unapprove Landing Page

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/unapprove-landing-page/

lp = mc.execute(method='unapprove_landing_page', id=410)

Discard Landing Page Draft

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/discard-landing-page-draft/

lp = mc.execute(method='discard_landing_page_draft', id=410)

Clone Landing Page

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/clone-landing-page/

lp = mc.execute(method='clone_landing_page', id=410, name='cloned landing page', folderId=894, 
                folderType='Folder', description=None, template=42)
                
# description is optional
# template should be optional but is currently required

Forms

Get Forms:

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-forms/

forms = mc.execute(method='get_forms', status=None, folderId=None, folderType=None, maxReturn=None)

# status, folderId, folderType and maxReturn are optional

Get Form by Id

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-form-by-id/

form = mc.execute(method='get_form_by_id', id=50, status=None)

# status is optional and can be 'draft' or 'approved'

Get Form by Name

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-form-by-name/

form = mc.execute(method='get_form_by_name', name='Form Demo', status=None)

# status is optional and can be 'draft' or 'approved'

Get Form Fields List

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-form-fields-list/

fields = mc.execute(method='get_form_fields', id=50, status=None)

# status is optional and can be 'draft' or 'approved'

Add Field to Form

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/add-field-to-form/

field = mc.execute(method='create_form_field', id=104, fieldId='AnnualRevenue', label='Rev', labelWidth=200, 
                   fieldWidth=200, instructions='fill out this field',
                   required=True, formPrefill=True, initiallyChecked=None, values=None, labelToRight=None,
                   hintText='hint', defaultValue=100, minValue=100, maxValue=1000000, multiSelect=None,
                   maxLength=None, maskInput=None, visibleLines=None)

# only id and fieldId are required, all others are optional

Create Form

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/create-form/

form = mc.execute(method='create_form', name='API Form 4', folderId=140, folderType='Folder',
                  description='optional description', language='Dutch', locale='nl_NL', progressiveProfiling=True,
                  labelPosition='above', fontFamily='Droid Sans Mono', fontSize='12px', knownVisitor=None)

# description, language, locale, progressiveProfiling, labelPosition, fontFamily, fontSize, knownVisitor, theme are optional
# locale examples: en_US, en_UK, fr_FR, de_DE, zh_CN, ja_JP, hi_IN, nl_NL, nl_BE
# fontFamily/fontSize and theme are mutually exclusive
# fontFamily doesn't seem to work
# labelPosition is left or above (lower case)
# TODO: knownVisitor needs further explanation

Get Form Thank You Page

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-form-thank-you-page/

not implemented yet

Update Form Thank You Page

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-form-thank-you-page/

not implemented yet

Update Form Metadata

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-form/

form = mc.execute('update_form', id=50, name=None, description=None, language=None, locale=None, progressiveProfiling=None,
                    labelPosition=None, fontFamily=None, fontSize=None, knownVisitor=None, formTheme=None,
                    customcss=None)

# id is required, all others are optional

Discard Form Draft

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/discard-form-draft/

form = mc.execute(method='discard_form_draft', id)

Approve Form

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/approve-form/

form = mc.execute(method='approve_form', id)

Unapprove Form

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/unapprove-form/

form = mc.execute(method='unapprove_form', id)

Clone Form

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/clone-form/

form = mc.execute(method='clone_form', id=50, name='new form name', folderId=12, folderType='Folder', description=None)

Delete Form

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/delete-form/

form = mc.execute(method='delete_form', id=50)

Update Form Field

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-form-field/

field = mc.execute(method='update_form_field', id=104, fieldId='AnnualRevenue', label='Revenue', labelWidth=150, 
                   fieldWidth=150, instructions='please fill out this field',
                   required=False, formPrefill=True, initiallyChecked=None, values=None, labelToRight=None,
                   hintText='hint', defaultValue=100, minValue=100, maxValue=1000000, multiSelect=None,
                   maxLength=None, maskInput=None, visibleLines=None)

# only id and fieldId are required, all others are optional

Remove Form Field

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/remove-form-field/

field = mc.execute(method='delete_form_field', id=104, fieldId='AnnualRevenue')

Update Form Field Visibility Rules

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-form-field-visibility-rules/

not yet implemented

Add Rich Text Form Field

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/add-rich-text-form-field/

not yet implemented

Add Fieldset

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/add-fieldset/

not yet implemented

Remove Field from Fieldset

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/remove-field-from-fieldset/

not yet implemented

Get Available Form Fields

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/get-available-form-fields/

not yet implemented

Change Form Field Positions

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/change-form-field-positions/

not yet implemented

Update Submit Button

API Ref: http://developers.marketo.com/documentation/marketo-rest-apis-web-page-objects/update-submit-button/

not yet implemented

Files

Create File

API Ref: http://developers.marketo.com/documentation/asset-api/create-a-file/

lead = mc.execute(method='create_file', name='Marketo-Logo.jpg', file='Marketo-Logo.jpg', folder=115, description=None)

# NOTE: the behavior of the call will change; this describes current behavior
# description is optional
# insertOnly is documented in the API Ref but it is non-functional
# 'name' needs to match the 'file' name, otherwise you get error 709 "Upload file name and/or extension is 
#   different from name in parameter"
# in 'file', specify a path if file is not in the same folder as the Python script

Get File by Id

API Ref: http://developers.marketo.com/documentation/asset-api/get-file-by-id/

try:
    file = mc.execute(method='get_file_by_id', id=16837)
except KeyError:
    file = False

Get File by Name

API Ref: http://developers.marketo.com/documentation/asset-api/get-file-by-name/

try:
    file = mc.execute(method='get_file_by_name', name='clogo8.jpg')
except KeyError:
    file = False

List Files

API Ref: http://developers.marketo.com/documentation/asset-api/list-files/

lead = mc.execute(method='list_files', folder=709, maxReturn=None)

# folder and maxReturn are optional; default for maxReturn is 20 and max is 200

Update File Content

API Ref: http://developers.marketo.com/documentation/asset-api/update-file-content/

file = mc.execute(method='update_file_content', id=23307, file='Marketo-Logo-Large.jpg')

# in 'file', specify a path if file is not in the same folder as the Python script

Snippets

Create Snippet

API Ref: http://developers.marketo.com/documentation/asset-api/create-snippet/

snippet = mc.execute(method='create_snippet', folderId=132, folderType="Folder", name="API Snippet", description=None)

# description is optional

Get Snippet By Id

API Ref: http://developers.marketo.com/documentation/asset-api/get-snippet-by-id/

snippet = mc.execute(method='get_snippet_by_id', id=9)

Delete Snippet

API Ref: http://developers.marketo.com/documentation/asset-api/delete-snippet-by-id/

snippet = mc.execute(method='delete_snippet', id=9)

Update Snippet

API Ref: http://developers.marketo.com/documentation/asset-api/update-snippet/

snippet = mc.execute(method='update_snippet', id=9, name="API Snippet 2", description='Hello New Description')

Get Snippets

API Ref: http://developers.marketo.com/documentation/asset-api/update-snippet/

snippets = mc.execute(method='get_snippets', maxReturn=None)

# maxReturn is optional; default for maxReturn is 20 and max is 200

Get Snippet Content

API Ref: http://developers.marketo.com/documentation/asset-api/get-snippet-content-by-id/

snippet = mc.execute(method='get_snippet_content', id=9, status=None)

# status is optional and can be 'draft' or 'approved'

Update Snippet Content

API Ref: http://developers.marketo.com/documentation/asset-api/update-snippet-content-by-id/

html_content = '<html><head></head><body><p>Hello World</p></body></html>'
snippet = mc.execute(method='update_snippet_content', id=9, type='HTML', content=html_content)

Approve Snippet

API Ref: http://developers.marketo.com/documentation/asset-api/approve-snippet-by-id/

snippet = mc.execute(method='approve_snippet', id=9)

Unapprove Snippet

API Ref: http://developers.marketo.com/documentation/asset-api/unapprove-snippet-by-id/

snippet = mc.execute(method='unapprove_snippet', id=9)

Discard Snippet Draft

API Ref: http://developers.marketo.com/documentation/asset-api/discard-snippet-draft-by-id/

snippet = mc.execute(method='discard_snippet_draft', id=9)

Clone Snippet

API Ref: http://developers.marketo.com/documentation/asset-api/clone-snippet/

snippet = mc.execute(method='clone_snippet', id=9, name='Cloned Snippet', folderId=132, folderType='Folder', 
                     description=None)

# description is optional

Update Snippet Dynamic Content

API Ref: http://developers.marketo.com/documentation/asset-api/update-snippet-dynamic-content-by-id/

snippet = mc.execute(method='update_snippet_dynamic_content', id=9, segmentId=1008, 
                     value='<p>Text in Dutch</p>', type='HTML')

Get Snippet Dynamic Content

API Ref: http://developers.marketo.com/documentation/asset-api/get-snippet-dynamic-content-by-id/

snippet = mc.execute(method='get_snippet_dynamic_content', id=9)

Segmentations

Get Segmentations

API Ref: http://developers.marketo.com/documentation/asset-api/get-segmentation-by-id/

segmentations = mc.execute(method='get_segmentations', status='approved')

# status is optional; values are 'draft' or 'approved'

Get Segments

API Ref: http://developers.marketo.com/documentation/asset-api/get-segments/

segments = mc.execute(method='get_segments', id=1001, status=None)

# status is optional; values are 'draft' or 'approved'

Landing Page Templates

Create Landing Page Template

API Ref: http://developers.marketo.com/documentation/asset-api/create-landing-page-template/

template = mc.execute(method='create_landing_page_template', name='API LP Template', folderId=11,
                      folderType='Folder', description='Description', templateType='freeForm')

# description and templateType are optional; templateType can be freeForm (default) or guided

Get Landing Page Template by Id

API Ref: http://developers.marketo.com/documentation/asset-api/get-landing-page-template-by-id/

template = mc.execute(method='get_landing_page_template_by_id', id=30, status='approved')

# status is optional; values are 'draft' or 'approved'; a single landing page can have both an approved and a draft 
# version

Get Landing Page Template by Name

API Ref: http://developers.marketo.com/documentation/asset-api/get-landing-page-template-by-name/

template = mc.execute(method='get_landing_page_template_by_name', name='API LP Template', status='draft')

# status is optional: values are 'draft' or 'approved'; a single landing page can have both an approved and a draft 
# version

Update Landing Page Template

API Ref: http://developers.marketo.com/documentation/asset-api/update-landing-page-template/

template = mc.execute(method='update_landing_page_template', id=59, name='API LP Template 2', description=None)

# name and description are optional, but - of course - you want to pass in at least 1 of them
# this is only to update name and description, use 'Update Landing Page Template Content' to update the HTML

Delete Landing Page Template

API Ref: N/A

template = mc.execute(method='delete_landing_page_template', id=64)

Get Landing Page Templates

API Ref: http://developers.marketo.com/documentation/asset-api/get-multiple-landing-page-templates/

template = mc.execute(method='get_landing_page_templates', status='approved', folderId=842, folderType='Folder')

# status, folderId, folderType and maxReturn are optional; status is 'draft' or 'approved'
# default for maxReturn is 20 and max is 200
# if you specify status, it will return an approved landing page with a draft for both status='draft' AND status='approved'

Get Landing Page Template Content

API Ref: http://developers.marketo.com/documentation/asset-api/get-landing-page-template-content/

template = mc.execute(method='get_landing_page_template_content', id=30)
with open('landing-page-template-content-2.html', 'w', encoding='utf-8') as f:
    f.write(template[0]['content'])

# status is optional: values are 'draft' or 'approved'

Update Landing Page Template Content

API Ref: http://developers.marketo.com/documentation/asset-api/update-landing-page-template-content-by-id/

template = mc.execute(method='update_landing_page_template_content', id=59, content='LP-template-content.html')

# 'content' points to a file

Approve Landing Page Template

API Ref: N/A

template = mc.execute(method='approve_landing_page_template', id=61)

Unapprove Landing Page Template

API Ref: N/A

template = mc.execute(method='unapprove_landing_page_template', id=61)

Discard Landing Page Template Draft

API Ref: N/A

template = mc.execute(method='discard_landing_page_template_draft', id=42)

Clone Landing Page Template

API Ref: N/A

template = mc.execute(method='clone_landing_page_template', id=42, name='cloned landing page template', 
                      folderId=11, folderType='Folder')

# folderId 11 is the Landing Page Templates folder in the Default workspace

Programs

Create Program

API Ref: http://developers.marketo.com/documentation/programs/create-a-program/

tags = {'Language': 'English'}
costs = '[{"startDate":"2015-01-01","cost":2000,"note":""}]'
program = mc.execute(method='create_program', folderId=28, folderType='Folder', name='Program Name', 
        description='new Program', type='Default', channel='Operational', tags=tags, costs=costs)

# description, tags and costs are optional
# the 'note' parameter in 'costs' is currently required but will be made optional in a future release

Get Program by Id

API Ref: http://developers.marketo.com/documentation/programs/get-program-by-id/

try:
    lead = mc.execute(method='get_program_by_id', id=1014)
except KeyError:
    lead = False

Get Program by Name

API Ref: http://developers.marketo.com/documentation/programs/get-program-by-name/

try:
    lead = mc.execute(method='get_program_by_name', name='Email Program Test')
except KeyError:
    lead = False

Get Program by Tag Type

API Ref: http://developers.marketo.com/documentation/programs/get-programs-by-tag-type/

try:
    program = mc.execute(method='get_program_by_tag_type', tagType='Language', tagValue='English')
except KeyError:
    program = False

Update Program

API Ref: http://developers.marketo.com/documentation/programs/update-program/

tags = {'Language': 'English'}
program = mc.execute(method='update_program', id=1160, name='Updated Name', description='description update', tags=tags)

# the 'costs' and 'costsDestructiveUpdate' parameters as mentioned in the docs are not implemented yet

Delete Program

API Ref: http://developers.marketo.com/documentation/programs/delete-program-by-id/

program = mc.execute(method='delete_program', id=1208)

Browse Programs

API Ref: http://developers.marketo.com/documentation/programs/browse-programs/

lead = mc.execute(method='browse_programs', status='completed', maxReturn=200)

# status and maxReturn are optional; default for maxReturn is 20 and max is 200

Clone Program

API Ref: http://developers.marketo.com/documentation/programs/clone-program/

program = mc.execute(method='clone_program', id=1207, name="Program Clone", folderId=28, folderType='Folder', 
                     description="this is a description")

# description is optional

Approve Program

API Ref: http://developers.marketo.com/documentation/programs/approve-program/

program = mc.execute(method='approve_program', id=1208)

Unapprove Program

API Ref: http://developers.marketo.com/documentation/programs/unapprove-program/

program = mc.execute(method='approve_program', id=1208)

Get Channels

API Ref: http://developers.marketo.com/documentation/programs/get-channels/

channels = mc.execute(method='get_channels', maxReturn=None)

# maxReturn is optional; default for maxReturn is 20 and max is 200

Get Channel by Name

API Ref: http://developers.marketo.com/documentation/programs/get-channel-by-name/

try:
    channel = mc.execute(method='get_channel_by_name', name="Nurture")
except KeyError:
    channel = False

Get Tags

API Ref: http://developers.marketo.com/documentation/programs/get-tags/

tags = mc.execute(method='get_tags', maxReturn=None)

# maxReturn is optional; default for maxReturn is 20 and max is 200

Get Tag by Name

API Ref: http://developers.marketo.com/documentation/programs/get-tag-by-name/

try:
    tag = mc.execute(method='get_tag_by_name', name="Language")
except KeyError:
    tag = False

Custom Objects

Get List of Custom Objects

API Ref: http://developers.marketo.com/documentation/custom-api/get-list-of-custom-objects/

result = mc.execute(method='get_list_of_custom_objects', names=['Order', 'Test'])

# names is optional

Describe Custom Object

API Ref: http://developers.marketo.com/documentation/custom-api/describe-custom-object/

result = mc.execute(method='describe_custom_object', name='Campaigns')

Create/Update Custom Objects

API Ref: http://developers.marketo.com/documentation/custom-api/createupdateupsert-custom-objects/

custom_objects = [{'TK_ID': 'abc123', 'PartNo_1': 'ABC', 'CatalogDescription_1': 'ABC Description'},
                  {'TK_ID': 'abc123', 'PartNo_1': 'DEF', 'CatalogDescription_1': 'DEF Description'}]
result = mc.execute(method='create_update_custom_objects', name='Campaigns', input=custom_objects, action=None, dedupeBy=None)

# action and dedupeBy are optional

Delete Custom Objects

API Ref: http://developers.marketo.com/documentation/custom-api/delete-custom-objects/

custom_objects = [{'TK_ID': 'abc123', 'PartNo_1': 'ABC'}]
result = mc.execute(method='delete_custom_objects', name='Campaigns', input=custom_objects, deleteBy=None)

# dedupeBy is optional
# in the example above there are 2 dedupe fields

Get Custom Objects

API Ref: http://developers.marketo.com/documentation/custom-api/get-custom-objects/

query = [{'TK_ID': 'abc123', 'ListID': 123},{'TK_ID': 'abc123', 'ListID': 12396}]
result = mc.execute(method='get_custom_objects', input=query, name='Campaigns', filterType='dedupeFields', 
         fields=['TK_ID', 'ListID', 'PartNo_1'], batchSize=None)

query2 = [{'marketoGUID': 'eadc92fb-17ef-4e4d-bb20-73aee1a0d57e'}]
result2 = mc.execute(method='get_custom_objects', input=query2, name='Campaigns', filterType='idField')

query3 = [{'TK_ID': 'abc123'}]
result3 = mc.execute(method='get_custom_objects', input=query3, name='Campaigns', filterType='TK_ID')

# fields and batchSize are optional
# in the first example there are two dedupeFields, which is why the dictionary has two keys; the 'link' field is also
#   searchable, but then 'filterType' needs to be the name of that field.

Opportunity Object

Describe Opportunity

API Ref: http://developers.marketo.com/documentation/opportunity-api/describe-opportunity/

result = mc.execute(method='describe_opportunity')

Create/Update Opportunities

API Ref: http://developers.marketo.com/documentation/opportunity-api/createupdateupsert-opportunities/

opportunities = [{'externalOpportunityId': 'O000004', 'externalCompanyId': 'C000003', 'name': 'Test Opportunity',
                  'amount': 5000, 'closeDate': '2016-06-30', 'isClosed': False, 'stage': 'Qualification',
                  'externalSalesPersonId': 'sam@test.com'}]
result = mc.execute(method='create_update_opportunities', input=opportunities, action=None, dedupeBy=None)

# action and dedupeBy are optional 
# action can be createOnly, updateOnly or createOrUpdate (default)
# dedupeBy is dedupeFields (default) or idField

Delete Opportunities

API Ref: http://developers.marketo.com/documentation/opportunity-api/delete-opportunities/

opportunities = [{"externalOpportunityId": "O000004"}]
result = mc.execute(method='delete_opportunities', input=opportunities, deleteBy=None)

# deleteBy is optional; it can be dedupeFields (default) or idField

Get Opportunities

API Ref: http://developers.marketo.com/documentation/opportunity-api/get-opportunities/

result = mc.execute(method='get_opportunities', filterType='externalOpportunityId', filterValues=['O000003'],
                    fields=['name', 'amount', 'closeDate', 'stage'])
#result = mc.execute(method='get_opportunities', filterType='externalCompanyId', filterValues=['C000003'])

# fields and batchSize are optional; default and maximum batch size is 300

Describe Opportunity Roles

API Ref: http://developers.marketo.com/documentation/opportunity-api/describe-opportunity-role/

result = mc.execute(method='describe_opportunity_role')

Create/Update Opportunities Roles

API Ref: http://developers.marketo.com/documentation/opportunity-api/createupdateupsert-opportunities-roles/

opportunities_roles = [{'externalOpportunityId': 'O000004', 'leadId': 2, 'role': 'Technical Buyer', 'isPrimary': False}]
result = mc.execute(method='create_update_opportunities_roles', input=opportunities_roles, action=None, dedupeBy=None)

# action and dedupeBy are optional 
# action can be createOnly, updateOnly or createOrUpdate (default)
# dedupeBy is dedupeFields (default) or idField

Delete Opportunity Roles

API Ref: http://developers.marketo.com/documentation/opportunity-api/delete-opportunity-roles/

opportunities = [{'externalOpportunityId': 'O000004', 'leadId': 2, 'role': 'Technical Buyer'}]
result = mc.execute(method='delete_opportunity_roles', input=opportunities, deleteBy=None)

# deleteBy is optional; it can be dedupeFields (default, all 3 fields shown) or idField

Get Opportunity Roles

API Ref: http://developers.marketo.com/documentation/opportunity-api/get-opportunity-roles/

result = mc.execute(method='get_opportunity_roles', filterType='externalOpportunityId', filterValues=['O000003'])
#result = mc.execute(method='get_opportunity_roles', filterType='marketoGUID', filterValues=['63ea3a3f-1b35-4723-850e-99b41b14a636'])
#result = mc.execute(method='get_opportunity_roles', filterType='leadId', filterValues=['2'])

# fields and batchSize are optional; default and maximum batch size is 300

Company Object

Describe Company

API Ref: http://developers.marketo.com/documentation/company-api/describe-company/

company = mc.execute(method='describe_company')

Create/Update Companies

API Ref: http://developers.marketo.com/documentation/company-api/createupdateupsert-companies/

companies = [{'externalCompanyId': 'C000001', 'company': 'Acme 1', 'website': 'http://www.acme1.com', 
             'numberOfEmployees': 856, 'billingCity': 'San Mateo', 'billingState': 'CA'},
             {'externalCompanyId': 'C000002', 'company': 'Acme 2', 'website': 'http://www.acme2.com', 
             'numberOfEmployees': 114, 'billingCity': 'Redmond', 'billingState': 'WA'}]
company = mc.execute(method='create_update_companies', input=companies, action=None, dedupeBy=None)

# action and dedupeBy are optional

Delete Companies

API Ref: http://developers.marketo.com/documentation/company-api/delete-companies/

companies = [{'externalCompanyId': 'C000003'}]
company = mc.execute(method='delete_companies', input=companies, deleteBy=None)

# deleteBy is optional; values can be dedupeFields (default) or idField

OR:

companies = [{'id': 8}]
company = mc.execute(method='delete_companies', input=companies, deleteBy='idField')

Get Companies

API Ref: http://developers.marketo.com/documentation/company-api/get-companies/

result = mc.execute(method='get_companies', filterType='company', filterValues=['Acme 1', 'Acme 2'],
                    fields=['company', 'billingCity', 'billingState', 'website', 'numberOfEmployees'], batchSize=None)
                    
# fields and batchSize are optional
# filterType can be: externalCompanyId, id, externalSalesPersonId, company

Sales Person Object

Describe Sales Person

API Ref: http://developers.marketo.com/documentation/sales-persons/describe-sales-person/

salesperson = mc.execute(method='describe_sales_person')

Create/Update Sales Persons

API Ref: http://developers.marketo.com/documentation/sales-persons/createupdateupsert-sales-persons/

salespeople = [{"externalSalesPersonId":"sam@test.com", "email":"sam@test.com", "firstName":"Sam", "lastName":"Sanosin"},
    {"externalSalesPersonId":"david@test.com", "email":"david@test.com", "firstName":"David", "lastName":"Aulassak"}]
result = mc.execute(method='create_update_sales_persons', input=salespeople, action=None, dedupeBy=None)

# action and dedupeBy are optional

Delete Sales Persons

API Ref: http://developers.marketo.com/documentation/sales-persons/delete-sales-persons/

salespeople = [{"externalSalesPersonId":"sam@test.com"}]
result = mc.execute(method='delete_sales_persons', input=salespeople, deleteBy=None)

# deleteBy is optional; values can be dedupeFields (default) or idField

Get Sales Persons

API Ref: http://developers.marketo.com/documentation/sales-persons/get-sales-persons/

result = mc.execute(method='get_sales_persons', filterType='externalSalesPersonId', filterValues=['sam@test.com'], 
        fields=None, batchSize=None)

# fields and batchSize are optional
# filterType can be: externalSalesPersonId, id, email

Programming Conventions

Conventions used for functions:

functions mirror as closely as possible how the functions work in the Marketo REST API; exceptions: get_lead_activities, get_lead_changes and get_deleted_leads where you can pass in a datetime directly rather than having to use get_paging_token (which you can still use, if you want to)
name of the function is exactly the same as on the Marketo Developer website, but lowercase with spaces replaced by underscores, and "by Id" removed in case "by Id" is the only option
variables are written exactly the same as in the Marketo REST API, even though they should be lower case according to PEP8
all required variables are checked on whether they're passed in, if not we raise a ValueError
functions return the 'result' node from the Marketo REST API response; if there is no 'result' node, 'success' is returned (which is true/false)
if the Marketo REST API returns an error, it will raise a Python error with error code and details, which can be handled in your code through try/except
the variable in with the API response is loaded is called 'result' also (so result['result'] is what is returned)
the client will loop if the number of results is greater than the batch size; it will then return all results together; this is not always ideal, because large data sets may take lots of processing time and memory;
batchSize is offered as a parameter (if available), but should usually be left blank
calls that support both GET and POST are implemented as POST to handle more data (for example: long lists of fields)
folder IDs are split up in Id and Type parameters
some parameters names shadow build-ins, which is not ideal, but done for consistency with the Marketo API parameters

Name		Name	Last commit message	Last commit date
Latest commit History 121 Commits
marketorestpython		marketorestpython
tests		tests
.gitignore		.gitignore
LICENSE.txt		LICENSE.txt
README		README
README.md		README.md
requirements-tests.txt		requirements-tests.txt
setup.cfg		setup.cfg
setup.py		setup.py
test_script.py		test_script.py

License

bevy/marketo-rest-python

Folders and files

Latest commit

History

Repository files navigation

Marketo REST Python

Installation

Unit tests

Usage

Lead, List, Activity and Campaign Objects

Get Lead by Id

Get Multiple Leads by Filter Type

Get Multiple Leads by List Id

Get Multiple Leads by List Id Yield (Generator)

Get Multiple Leads by Program Id

Get Multiple Leads by Program Id Yield (Generator)

Change Lead Program Status

Create/Update Leads

Associate Lead

Push Lead

Merge Lead

Get Lead Partitions

Get List by Id

Get Multiple Lists

Add Leads to List

Remove Leads from List

Member of List

Get Campaign by Id

Get Multiple Campaigns

Schedule Campaign

Request Campaign

Import Lead

Get Import Lead Status

Get Import Failure File

Get Import Warning File

Describe

Get Activity Types

Get Paging Token

Get Lead Activities

Get Lead Activities Yield (Generator)

Get Lead Changes

Get Lead Changes Yield (Generator)

Add Custom Activities

Get Daily Usage

Get Last 7 Days Usage

Get Daily Errors

Get Last 7 Days Errors

Delete Lead

Get Deleted Leads

Update Leads Partition

Folders

Create Folder

Get Folder by Id

Get Folder by Name

Get Folder Contents

Update Folder

Delete Folder

Browse Folders

Tokens

Create Token

Get Tokens

Delete Tokens

Email Templates

Create Email Template

Get Email Template by Id

Get Email Template by Name

Update Email Template

Delete Email Template

Get Email Templates

Get Email Template Content

Update Email Template Content

Approve Email Template

Unapprove Email Template

Discard Email Template Draft

Clone Email Template

Emails

Create Email

Get Email by Id

Get Email by Name