Operations (sample payloads)

Main operations

Add leads to static list

Add a list of leads to a static list Sample Input Sample Output

Approve custom activity type

Approves the current draft of the type, and makes it the live version. This will delete the current live version of the type. Sample Input Sample Output

Check lead list membership

Checks if leads are members of a given static list Sample Input Sample Output

Clone program

Clones the target program. Sample Input Sample Output

Create bulk export activities job

Creates and queues a bulk export activities job. Once completed, you can download the file as a CSV using the "Download Bulk Export Activities Job File" operation. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "quota_wait": false,
    "activity_type_ids": [
        1,
        2,
        3
    ],
    "fields": [
        "marketoGUID",
        "leadId",
        "activityDate",
        "activityTypeId"
    ],
    "min_created_at": "2023-01-01T00:00:00Z",
    "max_created_at": "2023-03-31T23:59:59Z"
\}

Sample Output

Create bulk export leads job

Creates and queues a bulk export leads job. Once completed, you can download the file as a CSV using the "Download Bulk Export Leads Job File" operation. Sample Input

{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "fields": [
        "email",
        "firstName",
        "lastName",
        "company",
        "leadScore"
    ],
    "column_header_names": [
        \{
            "field": "email",
            "column_name": "Email Address"
        \},
        \{
            "field": "firstName",
            "column_name": "First Name"
        \},
        \{
            "field": "lastName",
            "column_name": "Last Name"
        \}
    ],
    "smart_list_id": 1234,
    "min_created_at": "2023-01-01T00:00:00Z",
    "max_created_at": "2023-06-30T23:59:59Z"
}

Sample Output

Create bulk export program members job

Creates and queues a bulk export program members job. Once completed, you can download the file as a CSV using the "Download Bulk Export Program Members Job File" operation. Sample Input

{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "program_id": 1234,
    "fields": [
        "email",
        "firstName",
        "lastName",
        "membershipDate",
        "programStatus"
    ],
    "column_header_names": [
        \{
            "field": "email",
            "column_name": "Email Address"
        \},
        \{
            "field": "firstName",
            "column_name": "First Name"
        \},
        \{
            "field": "lastName",
            "column_name": "Last Name"
        \},
        \{
            "field": "membershipDate",
            "column_name": "Date Joined"
        \},
        \{
            "field": "programStatus",
            "column_name": "Current Status"
        \}
    ]
}

Sample Output

Create bulk import custom object job

Creates and queues a bulk import custom object job. Sample Input Sample Output

Create bulk import leads job

Creates and queues a bulk import leads job. You can poll the status of the import using the Get import lead status operation. Sample Input Sample Output

Create custom activities

This API is used to add custom activity for multiple leads. A maximum of 300 activity records can be submitted at a time. Sample Input Sample Output

Create custom activity type

Creates a new custom activity type draft in the target instance. Sample Input Sample Output

{
    "requestId": "1234a#56b",
    "result": [
        {
            "apiName": "company_webinar_attendance",
            "attributes": [
                \{
                    "apiName": "webinar_name",
                    "dataType": "string",
                    "description": "Name of the webinar attended",
                    "isPrimary": true,
                    "name": "Webinar Name"
                \}
            ],
            "createdAt": "2023-06-15T10:30:00Z",
            "description": "Tracks attendance at company webinars",
            "filterName": "Webinar Attendees",
            "id": 12345,
            "name": "Company Webinar Attendance",
            "primaryAttribute": \{
                "apiName": "webinar_name",
                "dataType": "string",
                "description": "Name of the webinar attended",
                "isPrimary": true,
                "name": "Webinar Name"
            \},
            "status": "draft",
            "triggerName": "Webinar Attendance Trigger",
            "updatedAt": "2023-06-15T10:30:00Z"
        }
    ],
    "success": true
}

Create custom activity type attributes

Adds activity attributes to the target type. These are added to the draft version of the type. Sample Input Sample Output

Create static list

Creates a new Static List. Sample Input Sample Output

Create/update multiple companies

Create or update a list of companies in Marketo. Sample Input Sample Output

Create/update multiple custom objects

Create or update custom object data in Marketo. Sample Input

{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "name": "CustomObject_Contacts",
    "action": "createOrUpdate",
    "input": [
        \{
            "id": "CO-001",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "company": "Acme Inc.",
            "jobTitle": "Software Engineer"
        \},
        \{
            "id": "CO-002",
            "firstName": "Jane",
            "lastName": "Smith",
            "email": "jane.smith@example.com",
            "company": "Tech Solutions",
            "jobTitle": "Product Manager"
        \}
    ]
}

Sample Output

Create/update multiple leads

Create or update a list of leads in Marketo. Sample Input

{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123abc456def",
    "client_secret": "secret_789ghi101112",
    "action": "createOrUpdate",
    "lookup_field": "email",
    "leads": [
        \{
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "company": "Acme Inc.",
            "title": "Software Engineer",
            "phone": "+1 (555) 123-4567",
            "country": "United States",
            "leadSource": "Website",
            "leadStatus": "New",
            "leadScore": 50
        \},
        \{
            "email": "jane.smith@example.com",
            "firstName": "Jane",
            "lastName": "Smith",
            "company": "Tech Solutions Ltd.",
            "title": "Marketing Manager",
            "phone": "+1 (555) 987-6543",
            "country": "Canada",
            "leadSource": "Webinar",
            "leadStatus": "Marketing Qualified Lead",
            "leadScore": 75
        \}
    ],
    "stop_on_errors": false
}

Sample Output

Create/update multiple opportunities

Create or update a list of opportunities in Marketo. Sample Input Sample Output

Create/update multiple opportunity roles

Create or update a list of opportunity roles in Marketo. Sample Input Sample Output

Create/update multiple sales persons

Create or update a list of sales persons in Marketo. Sample Input Sample Output

Create/update token

Creates or updates a token in the parent folder. Sample Input Sample Output

{
    "success": true,
    "errors": [],
    "requestId": "1a2b3c4d#1234567890",
    "warnings": [],
    "result": [
        {
            "folder": \{
                "type": "Program",
                "value": 1234
            \},
            "tokens": [
                {
                    "name": "WebinarDate",
                    "type": "date",
                    "value": "2023-09-15",
                    "computedUrl": "\{\{my.WebinarDate\}\}",
                    "sortOrder": "1",
                    "lastModiFied": "2023-05-20T14:30:45Z"
                }
            ]
        }
    ]
}

Delete companies

Delete multiple companies for a given criteria. Sample Input Sample Output

Delete custom activity type

Deletes the target custom activity type. The type must first be removed from use by any assets, such as triggers or filters. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "activity_type_api_name": "custom_webinar_attendance"
\}

Sample Output

{
    "errors": [],
    "moreResult": false,
    "requestId": "1234a#56789b",
    "result": [
        {
            "apiName": "custom_webinar_attendance",
            "attributes": [
                \{
                    "apiName": "webinar_name",
                    "dataType": "string",
                    "description": "Name of the webinar",
                    "isPrimary": true,
                    "name": "Webinar Name"
                \},
                \{
                    "apiName": "attendance_duration",
                    "dataType": "integer",
                    "description": "Duration of attendance in minutes",
                    "isPrimary": false,
                    "name": "Attendance Duration"
                \}
            ],
            "createdAt": "2023-01-15T10:30:00Z",
            "description": "Custom activity type for tracking webinar attendance",
            "filterName": "Webinar Attendance Filter",
            "id": 12345,
            "name": "Webinar Attendance",
            "primaryAttribute": \{
                "apiName": "webinar_name",
                "dataType": "string",
                "description": "Name of the webinar",
                "isPrimary": true,
                "name": "Webinar Name"
            \},
            "status": "deleted",
            "triggerName": "Webinar Attendance Trigger",
            "updatedAt": "2023-06-01T14:45:00Z"
        }
    ],
    "success": true,
    "warnings": []
}

Delete invited user

Delete a pending user. A pending user is a user that has not yet accepted an invitation. Sample Input Sample Output

Delete leads

Delete multiple leads given their ID. Sample Input Sample Output

Delete leads from static list

Removes a given set of person records from a target static list. Sample Input Sample Output

Delete opportunities

Delete multiple opportunities for a given criteria. Sample Input Sample Output

Delete opportunity roles

Delete multiple opportunity roles for a given criteria. Sample Input Sample Output

Delete sales persons

Delete multiple sales persons for a given criteria. Sample Input

{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "quota_wait": true,
    "delete_by": "idField",
    "salespersons": [
        \{
            "id": 1001,
            "externalCompanyId": "COMP001"
        \},
        \{
            "id": 1002,
            "externalCompanyId": "COMP002"
        \},
        \{
            "id": 1003,
            "externalCompanyId": "COMP003"
        \}
    ]
}

Sample Output

Delete static list

Deletes the designated Static List. Sample Input Sample Output

{
    "success": true,
    "errors": [],
    "requestId": "1a2b3c#1234567890",
    "warnings": [],
    "result": [
        {
            "id": 1234
        }
    ]
}

Describe custom activity type

Returns metadata for a specific custom activity type. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "api_name": "custom_webinar_attendance"
\}

Sample Output

{
    "requestId": "1234a#56b78cd9",
    "result": [
        {
            "id": 1001,
            "apiName": "custom_webinar_attendance",
            "name": "Webinar Attendance",
            "description": "Tracks attendance for custom webinars",
            "triggerName": "webinarAttended",
            "filterName": "Attended Webinar",
            "status": "active",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-05-15T10:30:00Z",
            "primaryAttribute": \{
                "apiName": "webinarId",
                "name": "Webinar ID",
                "description": "Unique identifier for the webinar",
                "dataType": "string"
            \},
            "attributes": [
                \{
                    "apiName": "attendanceDate",
                    "name": "Attendance Date",
                    "description": "Date the webinar was attended",
                    "dataType": "datetime"
                \},
                \{
                    "apiName": "attendanceDuration",
                    "name": "Attendance Duration",
                    "description": "Duration of attendance in minutes",
                    "dataType": "integer"
                \}
            ]
        }
    ],
    "success": true
}

Describe object

Get full details about an object type in Marketo. Sample Input Sample Output

{
    "requestId": "1234a#56789b",
    "result": [
        {
            "id": 1,
            "displayName": "Email Address",
            "dataType": "string",
            "length": 255,
            "soap": \{
                "name": "email",
                "readOnly": false
            \},
            "rest": \{
                "name": "email",
                "readOnly": false
            \}
        },
        {
            "id": 2,
            "displayName": "First Name",
            "dataType": "string",
            "length": 128,
            "soap": \{
                "name": "firstName",
                "readOnly": false
            \},
            "rest": \{
                "name": "firstName",
                "readOnly": false
            \}
        },
        {
            "id": 3,
            "displayName": "Last Name",
            "dataType": "string",
            "length": 128,
            "soap": \{
                "name": "lastName",
                "readOnly": false
            \},
            "rest": \{
                "name": "lastName",
                "readOnly": false
            \}
        }
    ],
    "success": true
}

Download bulk export activities job file

Downloads the CSV file that was exported as part of a bulk activities export job, using the export ID. NOTE: this will only work for jobs that have completed. Sample Input Sample Output

Download bulk export leads job file

Downloads the CSV file that was exported as part of a bulk lead export job, using the export ID. NOTE: this will only work for jobs that have completed. Sample Input Sample Output

Download bulk export program members job file

Downloads the CSV file that was exported as part of a bulk program member export job, using the export ID. NOTE: this will only work for jobs that have completed. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
    "client_secret": "ABCDEfghij1234567890",
    "export_id": "1234567",
    "quota_wait": true
\}

Sample Output

Get activities bulk export job status

Gets the current status of a bulk activities export job. Sample Input Sample Output

Get activity types

This API returns meta data about activity types (except change data value) available in Marketo. Sample Input Sample Output

Get and Create/Update lead

Get a lead in Marketo by their ID. If the lead does not exist, create a new lead. If the lead does exist, update the lead. Sample Input Sample Output

Get custom activity types

This API returns meta data about custom activity types (except change data value) available in Marketo. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
    "quota_wait": true
\}

Sample Output

{
    "requestId": "1234a#56789b",
    "result": [
        \{
            "id": 1001,
            "apiName": "product_demo",
            "name": "Product Demo",
            "description": "Tracks when a customer attends a product demonstration",
            "triggerName": "productDemoAttended",
            "filterName": "Product Demo Attended",
            "status": "active",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-05-15T10:30:00Z"
        \},
        \{
            "id": 1002,
            "apiName": "webinar_attendance",
            "name": "Webinar Attendance",
            "description": "Tracks when a lead attends a webinar",
            "triggerName": "webinarAttended",
            "filterName": "Webinar Attended",
            "status": "active",
            "createdAt": "2023-05-16T14:45:00Z",
            "updatedAt": "2023-05-16T14:45:00Z"
        \}
    ],
    "success": true
}

Get folder by ID

Retrieve a folder from its ID. Sample Input Sample Output

{
    "success": true,
    "errors": [],
    "requestId": "1a2b3c#4d5e6f7g8h",
    "warnings": [],
    "result": [
        {
            "name": "Marketing Campaigns",
            "description": "Folder containing all marketing campaign assets",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-06-01T14:45:00Z",
            "url": "https://app.marketo.com/#FO1234A1",
            "folderId": \{
                "id": 1234,
                "type": "Folder"
            \},
            "folderType": "Program",
            "parent": \{
                "id": 1000,
                "type": "Folder"
            \},
            "path": "Marketing\\Campaigns",
            "isArchive": false,
            "isSystem": false,
            "accessZoneId": 1,
            "workspace": "Default",
            "id": 1234
        }
    ]
}

Get folder by name

Retrieve a folder from its name. Sample Input Sample Output

Get lead activities

Get a list of lead activities. Sample Input Sample Output

Get lead bulk export job status

Gets the current status of a bulk lead export job. Sample Input Sample Output

{
    "requestId": "1234a#56789b",
    "result": \{
        "exportId": "bulk_export_12345",
        "format": "CSV",
        "status": "Completed",
        "createdAt": "2023-06-15T10:30:00Z",
        "queuedAt": "2023-06-15T10:30:05Z",
        "startedAt": "2023-06-15T10:31:00Z",
        "finishedAt": "2023-06-15T10:35:30Z",
        "numberOfRecords": 5000,
        "fileSize": 1048576
    \},
    "success": true
}

Get lead by ID

Get a lead in Marketo by their ID. Sample Input Sample Output

{
    "requestId": "1a2b3#4c5d6e7f8",
    "success": true,
    "result": [
        \{
            "id": 12345,
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "company": "Acme Corporation",
            "phone": "+1 (555) 123-4567",
            "title": "Marketing Manager",
            "createdAt": "2023-04-15T10:30:00Z",
            "updatedAt": "2023-05-20T14:45:00Z"
        \}
    ]
}

Get lead changes

This API retrieves change data value for leads. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secret_abcdefghijklmno",
    "list_id": "12345",
    "fields": [
        "email",
        "firstName",
        "lastName",
        "company",
        "title"
    ],
    "batch_size": 100,
    "next_page_token": "SOME_TOKEN_123"
\}

Sample Output

Get lead import failures

Returns the list of failures for the import batch job in CSV format. Sample Input Sample Output

Get lead import warnings

Returns the list of warnings for the import batch job in CSV format. Sample Input Sample Output

{
    "file": \{
        "name": "lead_import_warnings_1234567.csv",
        "url": "https://app-ab12.marketo.com/rest/v1/leads/import/1234567/warnings.csv",
        "mime_type": "text/csv",
        "expires": 1623456789
    \}
}

Get leads bulk import status

Returns the status of a leads import batch job. Sample Input Sample Output

Get paging token

This API returns a token for a given date. Sample Input Sample Output

Get program by ID

Get a program in your Marketo account, using its unique ID. Sample Input Sample Output

Get program by name

Get a program in your Marketo account, using its unique name. Sample Input Sample Output

Get program members bulk export job status

Gets the current status of a bulk program member export job. Sample Input Sample Output

Get static list by ID

Returns a list record by its ID. Sample Input Sample Output

Get static list by name

Returns a list record by its name. Sample Input Sample Output

Get tokens by folder ID

Retrieves the list of available My Tokens in the target folder. Sample Input Sample Output

Invite user

Send an email invitation to a new user. Sample Input Sample Output

List campaigns

Get a list of campaigns Sample Input Sample Output

List custom object types

Get a list of all of the custom object types. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "quota_wait": true,
    "names": [
        "CustomObject1",
        "CustomObject2"
    ]
\}

Sample Output

List custom objects

Get a list of custom objects of a given type. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "name": "my_custom_object",
    "filter_type": "id",
    "filter_values": [
        "1001",
        "1002",
        "1003"
    ],
    "fields": [
        "id",
        "name",
        "email",
        "company"
    ],
    "batch_size": 300
\}

Sample Output

List deleted leads

Return a list of leads deleted after a given date and time. Deletions greater than 14 days old may be pruned. Sample Input Sample Output

List folders

Retrieve a list of child folders within a given root folder. Sample Input Sample Output

List landing pages

Retrieves a list of accessible landing pages from the target instance. Sample Input Sample Output

{
    "success": true,
    "errors": [],
    "requestId": "1a2b3c4d#16789012345",
    "warnings": [],
    "result": [
        {
            "id": 1001,
            "name": "Summer Sale Landing Page",
            "description": "Landing page for our summer sale campaign",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-06-01T14:45:00Z",
            "folder": \{
                "type": "Folder",
                "value": 1234,
                "folderName": "Marketing Campaigns"
            \},
            "workspace": "Default",
            "status": "approved",
            "template": 5001,
            "robots": "index, follow",
            "formPrefill": true,
            "mobileEnabled": true,
            "URL": "/summer-sale",
            "computedUrl": "https://go.example.com/summer-sale"
        },
        {
            "id": 1002,
            "name": "Product Launch Landing Page",
            "description": "Landing page for new product launch",
            "createdAt": "2023-05-20T09:15:00Z",
            "updatedAt": "2023-05-31T16:20:00Z",
            "folder": \{
                "type": "Folder",
                "value": 1234,
                "folderName": "Marketing Campaigns"
            \},
            "workspace": "Default",
            "status": "approved",
            "template": 5002,
            "robots": "index, follow",
            "formPrefill": true,
            "mobileEnabled": true,
            "URL": "/new-product-launch",
            "computedUrl": "https://go.example.com/new-product-launch"
        }
    ]
}

List lead fields

Retrieves metadata for all lead fields in the target instance. Sample Input Sample Output

{
    "errors": [],
    "moreResult": true,
    "nextPageToken": "ABCDEFGHIJKLMNOP123456789",
    "requestId": "1234a#567b#89c0d",
    "result": [
        \{
            "displayName": "First Name",
            "name": "firstName",
            "description": "Lead's first name",
            "dataType": "string",
            "length": 50,
            "isHidden": false,
            "isHtmlEncodingInEmail": false,
            "isSensitive": false,
            "isCustom": false,
            "isApiCreated": false
        \},
        \{
            "displayName": "Last Name",
            "name": "lastName",
            "description": "Lead's last name",
            "dataType": "string",
            "length": 50,
            "isHidden": false,
            "isHtmlEncodingInEmail": false,
            "isSensitive": false,
            "isCustom": false,
            "isApiCreated": false
        \},
        \{
            "displayName": "Email Address",
            "name": "email",
            "description": "Lead's email address",
            "dataType": "email",
            "length": 100,
            "isHidden": false,
            "isHtmlEncodingInEmail": false,
            "isSensitive": true,
            "isCustom": false,
            "isApiCreated": false
        \}
    ],
    "success": true,
    "warnings": []
}

List leads

Get a list of leads. Sample Input Sample Output

List program leads

Get a list of leads belonging to a particular program. Sample Input Sample Output

List programs

Get a list of programs in your Marketo account. Sample Input Sample Output

List roles

Return a list of all role records. Sample Input Sample Output

List smart campaigns

Retrieve a list of smart campaigns. Sample Input Sample Output

{
    "success": true,
    "errors": [],
    "requestId": "1a2b3c4d#1234567890",
    "warnings": [],
    "result": [
        {
            "id": 1001,
            "name": "Summer Promotion Campaign",
            "description": "Campaign for summer product promotions",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-06-01T14:45:00Z",
            "status": "Active",
            "type": "Trigger",
            "isSystem": false,
            "isActive": true,
            "isRequestable": false,
            "isCommunicationLimitEnabled": true,
            "recurrence": {
                "weekdayOnly": true
            },
            "qualificationRuleType": "Continuous",
            "qualificationRuleInterval": 1,
            "qualificationRuleUnit": "Day",
            "workspace": "Marketing",
            "smartListId": 5001,
            "flowId": 6001,
            "computedUrl": "https://app-ab12.marketo.com/#SC1001A1"
        },
        {
            "id": 1002,
            "name": "New Customer Onboarding",
            "description": "Automated onboarding process for new customers",
            "createdAt": "2023-04-01T09:00:00Z",
            "updatedAt": "2023-06-15T11:20:00Z",
            "status": "Active",
            "type": "Batch",
            "isSystem": false,
            "isActive": true,
            "isRequestable": true,
            "isCommunicationLimitEnabled": false,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "Batch",
            "qualificationRuleInterval": 7,
            "qualificationRuleUnit": "Days",
            "workspace": "Customer Success",
            "smartListId": 5002,
            "flowId": 6002,
            "computedUrl": "https://app-ab12.marketo.com/#SC1002A1"
        }
    ]
}

List static lists

Returns a set of static list records based on given filter parameters. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "batch_size": 300,
    "ids": [
        1001,
        1002,
        1003
    ],
    "names": [
        "VIP Customers",
        "Newsletter Subscribers"
    ],
    "program_names": [
        "Summer Campaign",
        "Fall Promotion"
    ],
    "workspace_names": [
        "Marketing",
        "Sales"
    ]
\}

Sample Output

List user roles and workspaces

Return a list of user role and workspace records. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdef",
    "user_id": "mkto_1234567"
\}

Sample Output

List users

Retrieve a list of all user records. Sample Input Sample Output

List workspaces

Retrieve a list of workspace records. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghij1234567890",
    "quota_wait": true
\}

Sample Output

Push lead

Upsert a lead, and generate a Push Lead to Marketo activity. Sample Input Sample Output

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input Sample Output

Search companies

Retrieve multiple companies for a given search criteria. Sample Input Sample Output

Search leads

This API will retrieve multiple leads for a given search criteria. Sample Input Sample Output

Search opportunities

Retrieve multiple opportunities for a given search criteria. Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "client_123456789",
    "client_secret": "secretABCDEFGHIJKLMNOP",
    "filter_type": "dedupeFields",
    "filter_values": [
        "externalOpportunityId"
    ],
    "fields": [
        "externalOpportunityId",
        "marketoGUID",
        "createdAt",
        "updatedAt"
    ],
    "batch_size": 100
\}

Sample Output

{
    "requestId": "1234a#56789b",
    "result": [
        \{
            "seq": 1,
            "marketoGUID": "abc123de-f456-7890-ghij-klmnopqrstuv",
            "externalOpportunityId": "OPP-001",
            "updatedAt": "2023-06-15T14:30:00Z",
            "createdAt": "2023-06-01T09:00:00Z"
        \},
        \{
            "seq": 2,
            "marketoGUID": "def456gh-i789-0123-jklm-nopqrstuvwxy",
            "externalOpportunityId": "OPP-002",
            "updatedAt": "2023-06-16T10:15:00Z",
            "createdAt": "2023-06-02T11:30:00Z"
        \}
    ],
    "success": true,
    "nextPageToken": "ABCDEFGHIJKLMNOP1234567890"
}

Search opportunity roles

Retrieve multiple opportunity roles for a given search criteria. Sample Input Sample Output

{
    "requestId": "1a2b3c4d#5e6f7g8h",
    "result": [
        \{
            "seq": 1,
            "marketoGUID": "MKTO-GUID-12345-ABCDE",
            "leadId": 12345,
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-05-15T14:45:00Z",
            "role": "Decision Maker",
            "externalOpportunityId": "OPP-123456"
        \},
        \{
            "seq": 2,
            "marketoGUID": "MKTO-GUID-67890-FGHIJ",
            "leadId": 67890,
            "createdAt": "2023-05-14T09:15:00Z",
            "updatedAt": "2023-05-15T11:20:00Z",
            "role": "Influencer",
            "externalOpportunityId": "OPP-123456"
        \}
    ],
    "success": true,
    "nextPageToken": "NEXT-PAGE-TOKEN-123ABC"
}

Search sales people

Retrieve multiple companies for a given search criteria. Sample Input Sample Output

{
    "requestId": "1234a#56b",
    "result": [
        \{
            "seq": 1,
            "id": 12345,
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "title": "Sales Manager",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-05-20T14:45:00Z"
        \},
        \{
            "seq": 2,
            "id": 67890,
            "firstName": "Jane",
            "lastName": "Smith",
            "email": "jane.smith@example.com",
            "title": "Account Executive",
            "createdAt": "2023-05-16T09:15:00Z",
            "updatedAt": "2023-05-21T11:20:00Z"
        \}
    ],
    "success": true,
    "nextPageToken": "NEXT_PAGE_TOKEN_123"
}

Sync program member data

Changes the program member data of a list of leads in a target program. Only existing members of the program may have their data changed with this API. Sample Input Sample Output

Trigger campaign

Trigger a campaign with specified input in Marketo. Sample Input Sample Output

Update static list metadata

Updates the metadata of a static list asset. Sample Input Sample Output

DDL operations

Get activity type attributes (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input Sample Output

Get activity types (DDL)

Sample Input Sample Output

Get smart lists (DDL)

Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghij1234567890",
    "quota_wait": true
\}

Sample Output

Get static lists (DDL)

Sample Input Sample Output

List campaigns (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input Sample Output

{}

List custom activity types (DDL)

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input Sample Output

List custom object fields (DDL)

Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
    "quota_wait": true
\}

Sample Output

List custom object filter types (DDL)

Sample Input Sample Output

List custom object type fields (DDL)

Sample Input Sample Output

{}

List custom object types (DDL)

Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
    "quota_wait": true
\}

Sample Output

List lead attributes (DDL)

Sample Input Sample Output

List lead searchable fields (DDL)

Sample Input Sample Output

{
    "result": [
        \{
            "name": "firstName",
            "displayName": "First Name",
            "dataType": "string",
            "length": 255,
            "updateable": true,
            "searchable": true
        \},
        \{
            "name": "lastName",
            "displayName": "Last Name",
            "dataType": "string",
            "length": 255,
            "updateable": true,
            "searchable": true
        \},
        \{
            "name": "email",
            "displayName": "Email Address",
            "dataType": "email",
            "length": 255,
            "updateable": true,
            "searchable": true
        \},
        \{
            "name": "company",
            "displayName": "Company Name",
            "dataType": "string",
            "length": 255,
            "updateable": true,
            "searchable": true
        \},
        \{
            "name": "phone",
            "displayName": "Phone Number",
            "dataType": "phone",
            "length": 255,
            "updateable": true,
            "searchable": true
        \}
    ],
    "success": true
}

List object fields (DDL)

Sample Input Sample Output

List object filter types (DDL)

Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghij1234567890",
    "quota_wait": true
\}

Sample Output

List program member attributes (DDL)

Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
    "quota_wait": true
\}

Sample Output

List programs (DDL)

Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "qRsTuVwXyZ1234567890aBcDeFgHiJk",
    "quota_wait": true
\}

Sample Output

List roles (DDL)

Sample Input Sample Output

List users (DDL)

Sample Input Sample Output

List workspaces (DDL)

Sample Input

\{
    "endpoint": "https://123-ABC-456.mktorest.com",
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "client_secret": "ABCDEfghij1234567890",
    "quota_wait": true
\}

Sample Output