Go to appAcademyWhat's new?
Back
Artisan IMG > Marketo (marketo) (c383e0e8-7699-47c1-8543-9130b9b0a465)
Marketo
OverviewNotes on using MarketoError handlingUsing the Raw HTTP Request ('Universal Operation')Example use casesOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Add leads to static list
Copy

Add a list of leads to a static list

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ",
5
    "list_id": "1234",
6
    "leads": [
7
        5678,
8
        9012,
9
        3456,
10
        7890
11
    ]
12
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f8",
3
    "result": [
4
        {
5
            "id": 5678,
6
            "status": "added"
7
        },
8
        {
9
            "id": 9012,
10
            "status": "added"
11
        },
12
        {
13
            "id": 3456,
14
            "status": "added"
15
        },
16
        {
17
            "id": 7890,
18
            "status": "added"
19
        }
20
    ],
21
    "success": true
22
}

Approve custom activity type
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "activity_type_api_name": "custom_webinar_attendance"
6
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": [
4
        {
5
            "id": 1001,
6
            "name": "Custom Webinar Attendance",
7
            "apiName": "custom_webinar_attendance",
8
            "description": "Tracks attendance for custom webinars",
9
            "primaryAttribute": {
10
                "name": "Webinar ID",
11
                "apiName": "webinar_id",
12
                "dataType": "string",
13
                "isPrimary": true,
14
                "description": "Unique identifier for the webinar"
15
            },
16
            "attributes": [
17
                {
18
                    "name": "Webinar ID",
19
                    "apiName": "webinar_id",
20
                    "dataType": "string",
21
                    "isPrimary": true,
22
                    "description": "Unique identifier for the webinar"
23
                },
24
                {
25
                    "name": "Attendance Duration",
26
                    "apiName": "attendance_duration",
27
                    "dataType": "integer",
28
                    "isPrimary": false,
29
                    "description": "Duration of attendance in minutes"
30
                },
31
                {
32
                    "name": "Engagement Score",
33
                    "apiName": "engagement_score",
34
                    "dataType": "float",
35
                    "isPrimary": false,
36
                    "description": "Engagement score based on participation"
37
                }
38
            ],
39
            "filterName": "Custom Webinar Attendance Filter",
40
            "triggerName": "Custom Webinar Attendance Trigger",
41
            "status": "approved",
42
            "createdAt": "2023-06-15T10:30:00Z",
43
            "updatedAt": "2023-06-15T14:45:00Z"
44
        }
45
    ],
46
    "success": true,
47
    "warnings": [],
48
    "errors": []
49
}

Check lead list membership
Copy

Checks if leads are members of a given static list

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEF123456",
5
    "list_id": 1234,
6
    "ids": [
7
        5678,
8
        9012,
9
        3456
10
    ]
11
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "id": 5678,
6
            "status": "memberof"
7
        },
8
        {
9
            "id": 9012,
10
            "status": "notmemberof"
11
        },
12
        {
13
            "id": 3456,
14
            "status": "memberof"
15
        }
16
    ],
17
    "success": true
18
}

Clone program
Copy

Clones the target program.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "program_id": 1234,
6
    "name": "Q2 2023 Email Campaign - Clone",
7
    "folder_id": 5678,
8
    "description": "Cloned version of our successful Q2 2023 Email Campaign"
9
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#16789012345",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 9876,
9
            "name": "Q2 2023 Email Campaign - Clone",
10
            "description": "Cloned version of our successful Q2 2023 Email Campaign",
11
            "createdAt": "2023-06-15T10:30:00Z",
12
            "updatedAt": "2023-06-15T10:30:00Z",
13
            "url": "https://app-abc123.marketo.com/#PR9876A1",
14
            "type": "Email",
15
            "channel": "Email",
16
            "folder": {
17
                "type": "Folder",
18
                "value": 5678,
19
                "folderName": "Email Campaigns"
20
            },
21
            "status": "Draft",
22
            "workspace": "Default",
23
            "tags": [
24
                {
25
                    "tagType": "Program Type",
26
                    "tagValue": "Email"
27
                },
28
                {
29
                    "tagType": "Quarter",
30
                    "tagValue": "Q2"
31
                }
32
            ],
33
            "costs": [
34
                {
35
                    "cost": 5000,
36
                    "note": "Initial budget allocation",
37
                    "startDate": "2023-07-01"
38
                }
39
            ]
40
        }
41
    ]
42
}

Create bulk export activities job
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": false,
6
    "activity_type_ids": [
7
        1,
8
        2,
9
        3
10
    ],
11
    "fields": [
12
        "marketoGUID",
13
        "leadId",
14
        "activityDate",
15
        "activityTypeId"
16
    ],
17
    "min_created_at": "2023-01-01T00:00:00Z",
18
    "max_created_at": "2023-03-31T23:59:59Z"
19
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": [
4
        {
5
            "exportId": "BULK_EXPORT_123456",
6
            "format": "CSV",
7
            "status": "Created",
8
            "createdAt": "2023-04-01T10:30:00Z",
9
            "queuedAt": "2023-04-01T10:30:01Z",
10
            "startedAt": null,
11
            "finishedAt": null,
12
            "numberOfRecords": null,
13
            "fileSize": null
14
        }
15
    ],
16
    "success": true
17
}

Create bulk export leads job
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "fields": [
6
        "email",
7
        "firstName",
8
        "lastName",
9
        "company",
10
        "leadScore"
11
    ],
12
    "column_header_names": [
13
        {
14
            "field": "email",
15
            "column_name": "Email Address"
16
        },
17
        {
18
            "field": "firstName",
19
            "column_name": "First Name"
20
        },
21
        {
22
            "field": "lastName",
23
            "column_name": "Last Name"
24
        }
25
    ],
26
    "smart_list_id": 1234,
27
    "min_created_at": "2023-01-01T00:00:00Z",
28
    "max_created_at": "2023-06-30T23:59:59Z"
29
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "exportId": "MKT_EXPORT_1234567890",
6
            "format": "CSV",
7
            "status": "Created",
8
            "createdAt": "2023-07-01T10:15:30Z",
9
            "queuedAt": "2023-07-01T10:15:31Z"
10
        }
11
    ],
12
    "success": true
13
}

Create bulk export program members job
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "program_id": 1234,
6
    "fields": [
7
        "email",
8
        "firstName",
9
        "lastName",
10
        "membershipDate",
11
        "programStatus"
12
    ],
13
    "column_header_names": [
14
        {
15
            "field": "email",
16
            "column_name": "Email Address"
17
        },
18
        {
19
            "field": "firstName",
20
            "column_name": "First Name"
21
        },
22
        {
23
            "field": "lastName",
24
            "column_name": "Last Name"
25
        },
26
        {
27
            "field": "membershipDate",
28
            "column_name": "Date Joined"
29
        },
30
        {
31
            "field": "programStatus",
32
            "column_name": "Current Status"
33
        }
34
    ]
35
}

Sample Output

1
{
2
    "requestId": "1a2b3#4567",
3
    "result": [
4
        {
5
            "exportId": "MKT_EXPORT_12345678",
6
            "format": "CSV",
7
            "status": "Created",
8
            "createdAt": "2023-06-15T10:30:00Z",
9
            "queuedAt": "2023-06-15T10:30:01Z"
10
        }
11
    ],
12
    "success": true
13
}

Create bulk import custom object job
Copy

Creates and queues a bulk import custom object job.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": false,
6
    "file": {
7
        "name": "custom_objects.csv",
8
        "content": "base64_encoded_file_content_here"
9
    },
10
    "api_name": "My_Custom_Object__c"
11
}

Sample Output

1
{
2
    "requestId": "1234#5678",
3
    "result": [
4
        {
5
            "batchId": 1001,
6
            "status": "Importing",
7
            "objectApiName": "My_Custom_Object__c"
8
        }
9
    ],
10
    "success": true
11
}

Create bulk import leads job
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "file": {
6
        "content": "First Name,Last Name,Email,Company\nJohn,Doe,john.doe@example.com,Acme Inc.\nJane,Smith,jane.smith@example.com,XYZ Corp.",
7
        "filename": "leads.csv"
8
    },
9
    "lookup_field": "email",
10
    "partition_name": "Default",
11
    "list_id": 1234
12
}

Sample Output

1
{
2
    "requestId": "12345#67890abcde",
3
    "result": [
4
        {
5
            "batchId": 1234567,
6
            "importId": "import_abcdefghijklmno",
7
            "status": "Queued"
8
        }
9
    ],
10
    "success": true
11
}

Create custom activities
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": true,
6
    "input": [
7
        {
8
            "lead_id": 12345,
9
            "activity_date": "2023-05-15T10:30:00Z",
10
            "activity_type_id": 1001,
11
            "primary_attribute_value": "Webinar Attendance",
12
            "attributes": [
13
                {
14
                    "name": "Duration",
15
                    "value": 60
16
                },
17
                {
18
                    "name": "Topic",
19
                    "value": "Marketing Automation"
20
                }
21
            ]
22
        },
23
        {
24
            "lead_id": 67890,
25
            "activity_date": 1684147800,
26
            "activity_type_id": 1002,
27
            "primary_attribute_value": "Product Demo",
28
            "attributes": [
29
                {
30
                    "name": "Product",
31
                    "value": "CRM Software"
32
                },
33
                {
34
                    "name": "Interested",
35
                    "value": true
36
                }
37
            ]
38
        }
39
    ]
40
}

Sample Output

1
{
2
    "requestId": "1a2b3c#4d5e6f",
3
    "success": true,
4
    "result": [
5
        {
6
            "id": 12345,
7
            "status": "created"
8
        },
9
        {
10
            "id": 67890,
11
            "status": "created"
12
        }
13
    ]
14
}

Create custom activity type
Copy

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

Sample Input

1
{
2
    "activity_type_api_name": "company_webinar_attendance",
3
    "filter_name": "Webinar Attendees",
4
    "display_name": "Company Webinar Attendance",
5
    "trigger_name": "Webinar Attendance Trigger",
6
    "attribute_data": {
7
        "attribute_api_name": "webinar_name",
8
        "attribute_description": "Name of the webinar attended",
9
        "is_primary": true,
10
        "attribute_name": "Webinar Name"
11
    },
12
    "activity_type_description": "Tracks attendance at company webinars"
13
}

Sample Output

1
{
2
    "requestId": "1234a#56b",
3
    "result": [
4
        {
5
            "apiName": "company_webinar_attendance",
6
            "attributes": [
7
                {
8
                    "apiName": "webinar_name",
9
                    "dataType": "string",
10
                    "description": "Name of the webinar attended",
11
                    "isPrimary": true,
12
                    "name": "Webinar Name"
13
                }
14
            ],
15
            "createdAt": "2023-06-15T10:30:00Z",
16
            "description": "Tracks attendance at company webinars",
17
            "filterName": "Webinar Attendees",
18
            "id": 12345,
19
            "name": "Company Webinar Attendance",
20
            "primaryAttribute": {
21
                "apiName": "webinar_name",
22
                "dataType": "string",
23
                "description": "Name of the webinar attended",
24
                "isPrimary": true,
25
                "name": "Webinar Name"
26
            },
27
            "status": "draft",
28
            "triggerName": "Webinar Attendance Trigger",
29
            "updatedAt": "2023-06-15T10:30:00Z"
30
        }
31
    ],
32
    "success": true
33
}

Create custom activity type attributes
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "activity_type_api_name": "custom_webinar_attendance",
6
    "attributes": [
7
        {
8
            "api_name": "webinar_name",
9
            "data_type": "string",
10
            "description": "Name of the webinar attended",
11
            "is_primary": true,
12
            "name": "Webinar Name"
13
        },
14
        {
15
            "api_name": "attendance_duration",
16
            "data_type": "integer",
17
            "description": "Duration of attendance in minutes",
18
            "is_primary": false,
19
            "name": "Attendance Duration"
20
        },
21
        {
22
            "api_name": "registration_date",
23
            "data_type": "date",
24
            "description": "Date of webinar registration",
25
            "is_primary": false,
26
            "name": "Registration Date"
27
        }
28
    ]
29
}

Sample Output

1
{
2
    "errors": [],
3
    "moreResult": false,
4
    "requestId": "1234a#56789b",
5
    "result": [
6
        {
7
            "apiName": "custom_webinar_attendance",
8
            "attributes": [
9
                {
10
                    "apiName": "webinar_name",
11
                    "dataType": "string",
12
                    "description": "Name of the webinar attended",
13
                    "isPrimary": true,
14
                    "name": "Webinar Name"
15
                },
16
                {
17
                    "apiName": "attendance_duration",
18
                    "dataType": "integer",
19
                    "description": "Duration of attendance in minutes",
20
                    "isPrimary": false,
21
                    "name": "Attendance Duration"
22
                },
23
                {
24
                    "apiName": "registration_date",
25
                    "dataType": "date",
26
                    "description": "Date of webinar registration",
27
                    "isPrimary": false,
28
                    "name": "Registration Date"
29
                }
30
            ],
31
            "createdAt": "2023-06-15T10:30:00Z",
32
            "description": "Custom activity type for tracking webinar attendance",
33
            "filterName": "custom_webinar_attendance_f",
34
            "id": 12345,
35
            "name": "Custom Webinar Attendance",
36
            "primaryAttribute": {
37
                "apiName": "webinar_name",
38
                "dataType": "string",
39
                "description": "Name of the webinar attended",
40
                "isPrimary": true,
41
                "name": "Webinar Name"
42
            },
43
            "status": "draft",
44
            "triggerName": "custom_webinar_attendance_t",
45
            "updatedAt": "2023-06-15T10:30:00Z"
46
        }
47
    ],
48
    "success": true,
49
    "warnings": []
50
}

Create static list
Copy

Creates a new Static List.

Sample Input

1
{
2
    "name": "New Customer List Q2 2023",
3
    "folder_type": "Folder",
4
    "folder_id": 1234,
5
    "description": "A static list of new customers acquired in Q2 2023"
6
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#5e6f7g8h",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 5678,
9
            "name": "New Customer List Q2 2023",
10
            "createdAt": "2023-06-15T14:30:00Z",
11
            "updatedAt": "2023-06-15T14:30:00Z",
12
            "folder": {
13
                "id": 1234,
14
                "type": "Folder"
15
            },
16
            "computedUrl": "https://app-ab12.marketo.com/#ST5678A1"
17
        }
18
    ]
19
}

Create/update multiple companies
Copy

Create or update a list of companies in Marketo.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com/rest",
3
    "client_id": "client_id_123456",
4
    "client_secret": "client_secret_abcdef",
5
    "action": "createOrUpdate",
6
    "companies": [
7
        {
8
            "company": "Acme Corporation",
9
            "externalCompanyId": "ACME001",
10
            "companyNotes": "Global leader in innovative solutions",
11
            "annualRevenue": 5000000,
12
            "numberOfEmployees": 500,
13
            "billingCity": "San Francisco",
14
            "billingCountry": "USA",
15
            "billingPostalCode": "94105",
16
            "billingState": "CA",
17
            "billingStreet": "123 Market St",
18
            "industry": "Technology",
19
            "mainPhone": "+1 (415) 555-1234",
20
            "website": "https://www.acmecorp.com"
21
        },
22
        {
23
            "company": "Global Enterprises",
24
            "externalCompanyId": "GLOBAL002",
25
            "externalSalesPersonId": "SP789",
26
            "annualRevenue": 10000000,
27
            "numberOfEmployees": 1000,
28
            "billingCity": "New York",
29
            "billingCountry": "USA",
30
            "billingPostalCode": "10001",
31
            "billingState": "NY",
32
            "billingStreet": "456 Broadway",
33
            "industry": "Finance",
34
            "mainPhone": "+1 (212) 555-5678",
35
            "sicCode": "6021",
36
            "website": "https://www.globalenterprises.com"
37
        }
38
    ],
39
    "stop_on_errors": false
40
}

Sample Output

1
{
2
    "requestId": "1a2b3c#4d5e6f",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "id": 12345,
7
            "status": "created"
8
        },
9
        {
10
            "seq": 1,
11
            "id": 67890,
12
            "status": "updated"
13
        }
14
    ],
15
    "success": true
16
}

Create/update multiple custom objects
Copy

Create or update custom object data in Marketo.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "name": "CustomObject_Contacts",
6
    "action": "createOrUpdate",
7
    "input": [
8
        {
9
            "id": "CO-001",
10
            "firstName": "John",
11
            "lastName": "Doe",
12
            "email": "john.doe@example.com",
13
            "company": "Acme Inc.",
14
            "jobTitle": "Software Engineer"
15
        },
16
        {
17
            "id": "CO-002",
18
            "firstName": "Jane",
19
            "lastName": "Smith",
20
            "email": "jane.smith@example.com",
21
            "company": "Tech Solutions",
22
            "jobTitle": "Product Manager"
23
        }
24
    ]
25
}

Sample Output

1
{
2
    "requestId": "1234a#56b",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "marketoGUID": "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8",
7
            "status": "created"
8
        },
9
        {
10
            "seq": 1,
11
            "marketoGUID": "o9p8q7r6-s5t4-3210-u1v2-w3x4y5z6a7b8",
12
            "status": "updated"
13
        }
14
    ],
15
    "success": true
16
}

Create/update multiple leads
Copy

Create or update a list of leads in Marketo.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123abc456def",
4
    "client_secret": "secret_789ghi101112",
5
    "action": "createOrUpdate",
6
    "lookup_field": "email",
7
    "leads": [
8
        {
9
            "email": "john.doe@example.com",
10
            "firstName": "John",
11
            "lastName": "Doe",
12
            "company": "Acme Inc.",
13
            "title": "Software Engineer",
14
            "phone": "+1 (555) 123-4567",
15
            "country": "United States",
16
            "leadSource": "Website",
17
            "leadStatus": "New",
18
            "leadScore": 50
19
        },
20
        {
21
            "email": "jane.smith@example.com",
22
            "firstName": "Jane",
23
            "lastName": "Smith",
24
            "company": "Tech Solutions Ltd.",
25
            "title": "Marketing Manager",
26
            "phone": "+1 (555) 987-6543",
27
            "country": "Canada",
28
            "leadSource": "Webinar",
29
            "leadStatus": "Marketing Qualified Lead",
30
            "leadScore": 75
31
        }
32
    ],
33
    "stop_on_errors": false
34
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e",
3
    "successes": [
4
        {
5
            "id": 12345,
6
            "status": "created"
7
        },
8
        {
9
            "id": 67890,
10
            "status": "updated"
11
        }
12
    ],
13
    "errors": []
14
}

Create/update multiple opportunities
Copy

Create or update a list of opportunities in Marketo.

Sample Input

1
{
2
    "action": "createOrUpdate",
3
    "stop_on_errors": false,
4
    "opportunities": [
5
        {
6
            "externalOpportunityId": "OPP-12345",
7
            "externalSalesPersonId": "SP-789",
8
            "externalCompanyId": "COMP-456",
9
            "externalCreatedDate": "2023-05-15T10:30:00Z",
10
            "name": "New Software Implementation",
11
            "description": "Implementing our enterprise software solution for ABC Corp",
12
            "type": "New business",
13
            "amount": 50000,
14
            "closeDate": "2023-09-30",
15
            "expectedRevenue": 45000,
16
            "fiscal": "Q3",
17
            "fiscalQuarter": 3,
18
            "fiscalYear": 2023,
19
            "forecastCategoryName": "Commit",
20
            "isClosed": false,
21
            "isWon": false,
22
            "lastActivityDate": "2023-05-20T14:45:00Z",
23
            "leadSource": "Partner Referral",
24
            "nextStep": "Schedule product demo",
25
            "probability": 70,
26
            "quantity": 1,
27
            "stage": "Proposal"
28
        }
29
    ]
30
}

Sample Output

1
{
2
    "requestId": "1a2b3c4d#5e6f",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "id": 12345,
7
            "status": "created"
8
        }
9
    ],
10
    "success": true
11
}

Create/update multiple opportunity roles
Copy

Create or update a list of opportunity roles in Marketo.

Sample Input

1
{
2
    "action": "createOrUpdate",
3
    "opportunity_roles": [
4
        {
5
            "externalOpportunityId": "OPP-123456",
6
            "externalCreatedDate": "2023-05-15T10:30:00Z",
7
            "isPrimary": true,
8
            "leadId": 12345,
9
            "role": "Account Executive"
10
        },
11
        {
12
            "externalOpportunityId": "OPP-789012",
13
            "externalCreatedDate": "2023-05-16T14:45:00Z",
14
            "isPrimary": false,
15
            "leadId": 67890,
16
            "role": "Sales Engineer"
17
        }
18
    ],
19
    "stop_on_errors": false
20
}

Sample Output

1
{
2
    "requestId": "1a2b3c4d#5e6f7g8h",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "marketoGUID": "MKTO-ABC-123-XYZ",
7
            "status": "created"
8
        },
9
        {
10
            "seq": 1,
11
            "marketoGUID": "MKTO-DEF-456-UVW",
12
            "status": "updated"
13
        }
14
    ],
15
    "success": true
16
}

Create/update multiple sales persons
Copy

Create or update a list of sales persons in Marketo.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": false,
6
    "action": "createOrUpdate",
7
    "dedupe_by": "dedupeFields",
8
    "salespersons": [
9
        {
10
            "externalSalesPersonId": "SP001",
11
            "email": "john.doe@example.com",
12
            "firstName": "John",
13
            "lastName": "Doe",
14
            "mobilePhone": "+1-555-123-4567",
15
            "phone": "+1-555-987-6543",
16
            "title": "Senior Sales Representative",
17
            "fax": "+1-555-246-8135"
18
        },
19
        {
20
            "externalSalesPersonId": "SP002",
21
            "email": "jane.smith@example.com",
22
            "firstName": "Jane",
23
            "lastName": "Smith",
24
            "mobilePhone": "+1-555-234-5678",
25
            "phone": "+1-555-876-5432",
26
            "title": "Sales Manager",
27
            "fax": "+1-555-135-7924"
28
        }
29
    ],
30
    "stop_on_errors": false
31
}

Sample Output

1
{
2
    "requestId": "1234a#56b",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "id": 12345,
7
            "status": "created"
8
        },
9
        {
10
            "seq": 1,
11
            "id": 12346,
12
            "status": "updated"
13
        }
14
    ],
15
    "success": true
16
}

Create/update token
Copy

Creates or updates a token in the parent folder.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "folder_id": 1234,
6
    "folder_type": "Program",
7
    "name": "WebinarDate",
8
    "type": "date",
9
    "value": "2023-09-15"
10
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#1234567890",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "folder": {
9
                "type": "Program",
10
                "value": 1234
11
            },
12
            "tokens": [
13
                {
14
                    "name": "WebinarDate",
15
                    "type": "date",
16
                    "value": "2023-09-15",
17
                    "computedUrl": "{{my.WebinarDate}}",
18
                    "sortOrder": "1",
19
                    "lastModiFied": "2023-05-20T14:30:45Z"
20
                }
21
            ]
22
        }
23
    ]
24
}

Delete companies
Copy

Delete multiple companies for a given criteria.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "delete_by": "dedupeFields",
6
    "companies": [
7
        {
8
            "id": 1001,
9
            "externalCompanyId": "COMP001"
10
        },
11
        {
12
            "id": 1002,
13
            "externalCompanyId": "COMP002"
14
        },
15
        {
16
            "id": 1003,
17
            "externalCompanyId": "COMP003"
18
        }
19
    ]
20
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "id": 1001,
7
            "status": "deleted"
8
        },
9
        {
10
            "seq": 1,
11
            "id": 1002,
12
            "status": "deleted"
13
        },
14
        {
15
            "seq": 2,
16
            "id": 1003,
17
            "status": "deleted"
18
        }
19
    ],
20
    "success": true
21
}

Delete custom activity type
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "activity_type_api_name": "custom_webinar_attendance"
6
}

Sample Output

1
{
2
    "errors": [],
3
    "moreResult": false,
4
    "requestId": "1234a#56789b",
5
    "result": [
6
        {
7
            "apiName": "custom_webinar_attendance",
8
            "attributes": [
9
                {
10
                    "apiName": "webinar_name",
11
                    "dataType": "string",
12
                    "description": "Name of the webinar",
13
                    "isPrimary": true,
14
                    "name": "Webinar Name"
15
                },
16
                {
17
                    "apiName": "attendance_duration",
18
                    "dataType": "integer",
19
                    "description": "Duration of attendance in minutes",
20
                    "isPrimary": false,
21
                    "name": "Attendance Duration"
22
                }
23
            ],
24
            "createdAt": "2023-01-15T10:30:00Z",
25
            "description": "Custom activity type for tracking webinar attendance",
26
            "filterName": "Webinar Attendance Filter",
27
            "id": 12345,
28
            "name": "Webinar Attendance",
29
            "primaryAttribute": {
30
                "apiName": "webinar_name",
31
                "dataType": "string",
32
                "description": "Name of the webinar",
33
                "isPrimary": true,
34
                "name": "Webinar Name"
35
            },
36
            "status": "deleted",
37
            "triggerName": "Webinar Attendance Trigger",
38
            "updatedAt": "2023-06-01T14:45:00Z"
39
        }
40
    ],
41
    "success": true,
42
    "warnings": []
43
}

Delete invited user
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "user_id": "mkto_user_12345"
6
}

Sample Output

1
{
2
    "success": true
3
}

Delete leads
Copy

Delete multiple leads given their ID.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": true,
6
    "leads": [
7
        {
8
            "id": 1001
9
        },
10
        {
11
            "id": 1002
12
        },
13
        {
14
            "id": 1003
15
        }
16
    ]
17
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "marketoGUID": "1234abcd-5678-90ef-ghij-klmnopqrstuv",
7
            "status": "deleted"
8
        },
9
        {
10
            "seq": 1,
11
            "marketoGUID": "2345bcde-6789-01fg-hijk-lmnopqrstuvw",
12
            "status": "deleted"
13
        },
14
        {
15
            "seq": 2,
16
            "marketoGUID": "3456cdef-7890-12gh-ijkl-mnopqrstuvwx",
17
            "status": "deleted"
18
        }
19
    ],
20
    "success": true
21
}

Delete leads from static list
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "list_id": 1234,
6
    "ids": [
7
        5678,
8
        9012,
9
        3456
10
    ]
11
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "id": 5678,
6
            "status": "removed"
7
        },
8
        {
9
            "id": 9012,
10
            "status": "removed"
11
        },
12
        {
13
            "id": 3456,
14
            "status": "removed"
15
        }
16
    ],
17
    "success": true
18
}

Delete opportunities
Copy

Delete multiple opportunities for a given criteria.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": true,
6
    "delete_by": "dedupeFields",
7
    "opportunities": [
8
        {
9
            "marketoguid": "1234567890",
10
            "externalOpportunityId": "OPP-001"
11
        },
12
        {
13
            "marketoguid": "0987654321",
14
            "externalOpportunityId": "OPP-002"
15
        }
16
    ]
17
}

Sample Output

1
{
2
    "requestId": "1a2b3c4d#5e6f7g8h",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "marketoGUID": "1234567890",
7
            "status": "deleted"
8
        },
9
        {
10
            "seq": 1,
11
            "marketoGUID": "0987654321",
12
            "status": "deleted"
13
        }
14
    ],
15
    "success": true
16
}

Delete opportunity roles
Copy

Delete multiple opportunity roles for a given criteria.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "delete_by": "dedupeFields",
6
    "opportunity_roles": [
7
        {
8
            "role": "Decision Maker",
9
            "externalOpportunityId": "OPP-001",
10
            "leadId": 12345
11
        },
12
        {
13
            "role": "Influencer",
14
            "externalOpportunityId": "OPP-002",
15
            "leadId": 67890
16
        }
17
    ]
18
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "marketoGUID": "abc123de-f456-7890-ghij-klmnopqrstuv",
7
            "status": "deleted"
8
        },
9
        {
10
            "seq": 1,
11
            "marketoGUID": "def456gh-i789-0123-jklm-nopqrstuvwxy",
12
            "status": "deleted"
13
        }
14
    ],
15
    "success": true
16
}

Delete sales persons
Copy

Delete multiple sales persons for a given criteria.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": true,
6
    "delete_by": "idField",
7
    "salespersons": [
8
        {
9
            "id": 1001,
10
            "externalCompanyId": "COMP001"
11
        },
12
        {
13
            "id": 1002,
14
            "externalCompanyId": "COMP002"
15
        },
16
        {
17
            "id": 1003,
18
            "externalCompanyId": "COMP003"
19
        }
20
    ]
21
}

Sample Output

1
{
2
    "requestId": "1a2b3c#4d5e6f",
3
    "result": [
4
        {
5
            "seq": 0,
6
            "id": 1001,
7
            "status": "deleted"
8
        },
9
        {
10
            "seq": 1,
11
            "id": 1002,
12
            "status": "deleted"
13
        },
14
        {
15
            "seq": 2,
16
            "id": 1003,
17
            "status": "deleted"
18
        }
19
    ],
20
    "success": true
21
}

Delete static list
Copy

Deletes the designated Static List.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdef",
5
    "quota_wait": false,
6
    "list_id": 1234
7
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c#1234567890",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 1234
9
        }
10
    ]
11
}

Describe custom activity type
Copy

Returns metadata for a specific custom activity type.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "api_name": "custom_webinar_attendance"
6
}

Sample Output

1
{
2
    "requestId": "1234a#56b78cd9",
3
    "result": [
4
        {
5
            "id": 1001,
6
            "apiName": "custom_webinar_attendance",
7
            "name": "Webinar Attendance",
8
            "description": "Tracks attendance for custom webinars",
9
            "triggerName": "webinarAttended",
10
            "filterName": "Attended Webinar",
11
            "status": "active",
12
            "createdAt": "2023-05-15T10:30:00Z",
13
            "updatedAt": "2023-05-15T10:30:00Z",
14
            "primaryAttribute": {
15
                "apiName": "webinarId",
16
                "name": "Webinar ID",
17
                "description": "Unique identifier for the webinar",
18
                "dataType": "string"
19
            },
20
            "attributes": [
21
                {
22
                    "apiName": "attendanceDate",
23
                    "name": "Attendance Date",
24
                    "description": "Date the webinar was attended",
25
                    "dataType": "datetime"
26
                },
27
                {
28
                    "apiName": "attendanceDuration",
29
                    "name": "Attendance Duration",
30
                    "description": "Duration of attendance in minutes",
31
                    "dataType": "integer"
32
                }
33
            ]
34
        }
35
    ],
36
    "success": true
37
}

Describe object
Copy

Get full details about an object type in Marketo.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com/rest",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "quota_wait": false,
6
    "type": "leads"
7
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": [
4
        {
5
            "id": 1,
6
            "displayName": "Email Address",
7
            "dataType": "string",
8
            "length": 255,
9
            "soap": {
10
                "name": "email",
11
                "readOnly": false
12
            },
13
            "rest": {
14
                "name": "email",
15
                "readOnly": false
16
            }
17
        },
18
        {
19
            "id": 2,
20
            "displayName": "First Name",
21
            "dataType": "string",
22
            "length": 128,
23
            "soap": {
24
                "name": "firstName",
25
                "readOnly": false
26
            },
27
            "rest": {
28
                "name": "firstName",
29
                "readOnly": false
30
            }
31
        },
32
        {
33
            "id": 3,
34
            "displayName": "Last Name",
35
            "dataType": "string",
36
            "length": 128,
37
            "soap": {
38
                "name": "lastName",
39
                "readOnly": false
40
            },
41
            "rest": {
42
                "name": "lastName",
43
                "readOnly": false
44
            }
45
        }
46
    ],
47
    "success": true
48
}

Download bulk export activities job file
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretKey987654321",
5
    "export_id": "MKT_ACTIVITY_EXPORT_1234567",
6
    "quota_wait": true
7
}

Sample Output

1
{
2
    "file": {
3
        "name": "activity_export_1234567.csv",
4
        "url": "https://example.com/downloads/activity_export_1234567.csv",
5
        "mime_type": "text/csv",
6
        "expires": 1623456789
7
    }
8
}

Download bulk export leads job file
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "export_id": "1234567",
6
    "quota_wait": true
7
}

Sample Output

1
{
2
    "file": {
3
        "name": "lead_export_1234567.csv",
4
        "url": "https://example.com/downloads/lead_export_1234567.csv",
5
        "mime_type": "text/csv",
6
        "expires": 1623456789
7
    }
8
}

Download bulk export program members job file
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "export_id": "1234567",
6
    "quota_wait": true
7
}

Sample Output

1
{
2
    "file": {
3
        "name": "program_members_export_1234567.csv",
4
        "url": "https://example.com/downloads/program_members_export_1234567.csv",
5
        "mime_type": "text/csv",
6
        "expires": 1623456789
7
    }
8
}

Get activities bulk export job status
Copy

Gets the current status of a bulk activities export job.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ",
5
    "export_id": "MKT_ACTIVITY_EXPORT_1234567890",
6
    "quota_wait": false
7
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f8",
3
    "result": {
4
        "exportId": "MKT_ACTIVITY_EXPORT_1234567890",
5
        "format": "CSV",
6
        "status": "Completed",
7
        "createdAt": "2023-06-15T10:30:00Z",
8
        "queuedAt": "2023-06-15T10:30:05Z",
9
        "startedAt": "2023-06-15T10:31:00Z",
10
        "finishedAt": "2023-06-15T10:35:30Z",
11
        "numberOfRecords": 5000,
12
        "fileSize": 1048576
13
    },
14
    "success": true
15
}

Get activity types
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "quota_wait": false
6
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f8",
3
    "result": [
4
        {
5
            "id": 1,
6
            "name": "Visit Webpage",
7
            "description": "User visited a web page",
8
            "primaryAttribute": {
9
                "name": "Webpage ID",
10
                "dataType": "integer"
11
            },
12
            "attributes": [
13
                {
14
                    "name": "Webpage URL",
15
                    "dataType": "string"
16
                },
17
                {
18
                    "name": "Referrer URL",
19
                    "dataType": "string"
20
                }
21
            ]
22
        },
23
        {
24
            "id": 2,
25
            "name": "Fill Out Form",
26
            "description": "User submitted a form",
27
            "primaryAttribute": {
28
                "name": "Form ID",
29
                "dataType": "integer"
30
            },
31
            "attributes": [
32
                {
33
                    "name": "Form Name",
34
                    "dataType": "string"
35
                },
36
                {
37
                    "name": "Form Fields",
38
                    "dataType": "array"
39
                }
40
            ]
41
        }
42
    ],
43
    "success": true
44
}

Get and Create/Update lead
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com/rest",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "lead_id": "12345",
6
    "stop_on_errors": false,
7
    "lead": {
8
        "firstName": "John",
9
        "lastName": "Doe",
10
        "email": "johndoe@example.com",
11
        "company": "Acme Corp",
12
        "title": "Marketing Manager",
13
        "phone": "+1 (555) 123-4567",
14
        "country": "United States",
15
        "leadStatus": "Qualified",
16
        "leadScore": 80
17
    }
18
}

Sample Output

1
{
2
    "requestId": "1a2b3c#4d5e6f",
3
    "successes": [
4
        {
5
            "id": 12345,
6
            "status": "updated"
7
        }
8
    ],
9
    "errors": []
10
}

Get custom activity types
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": [
4
        {
5
            "id": 1001,
6
            "apiName": "product_demo",
7
            "name": "Product Demo",
8
            "description": "Tracks when a customer attends a product demonstration",
9
            "triggerName": "productDemoAttended",
10
            "filterName": "Product Demo Attended",
11
            "status": "active",
12
            "createdAt": "2023-05-15T10:30:00Z",
13
            "updatedAt": "2023-05-15T10:30:00Z"
14
        },
15
        {
16
            "id": 1002,
17
            "apiName": "webinar_attendance",
18
            "name": "Webinar Attendance",
19
            "description": "Tracks when a lead attends a webinar",
20
            "triggerName": "webinarAttended",
21
            "filterName": "Webinar Attended",
22
            "status": "active",
23
            "createdAt": "2023-05-16T14:45:00Z",
24
            "updatedAt": "2023-05-16T14:45:00Z"
25
        }
26
    ],
27
    "success": true
28
}

Get folder by ID
Copy

Retrieve a folder from its ID.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "folder_id": 1234
6
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c#4d5e6f7g8h",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "name": "Marketing Campaigns",
9
            "description": "Folder containing all marketing campaign assets",
10
            "createdAt": "2023-05-15T10:30:00Z",
11
            "updatedAt": "2023-06-01T14:45:00Z",
12
            "url": "https://app.marketo.com/#FO1234A1",
13
            "folderId": {
14
                "id": 1234,
15
                "type": "Folder"
16
            },
17
            "folderType": "Program",
18
            "parent": {
19
                "id": 1000,
20
                "type": "Folder"
21
            },
22
            "path": "Marketing\\Campaigns",
23
            "isArchive": false,
24
            "isSystem": false,
25
            "accessZoneId": 1,
26
            "workspace": "Default",
27
            "id": 1234
28
        }
29
    ]
30
}

Get folder by name
Copy

Retrieve a folder from its name.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "folder_name": "Marketing Campaigns 2023"
6
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#1234567890",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "name": "Marketing Campaigns 2023",
9
            "description": "Folder containing all marketing campaigns for 2023",
10
            "createdAt": "2023-01-01T09:00:00Z",
11
            "updatedAt": "2023-06-15T14:30:00Z",
12
            "url": "https://app.marketo.com/#FO12345A",
13
            "folderId": {
14
                "id": 12345,
15
                "type": "Folder"
16
            },
17
            "folderType": "Program",
18
            "parent": {
19
                "id": 10000,
20
                "type": "Folder"
21
            },
22
            "path": "Marketing Folders/Campaigns/2023",
23
            "isArchive": false,
24
            "isSystem": false,
25
            "accessZoneId": 1,
26
            "workspace": "Default",
27
            "id": 12345
28
        }
29
    ]
30
}

Get lead activities
Copy

Get a list of lead activities.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "activity_type_ids": [
6
        1,
7
        2,
8
        3
9
    ],
10
    "batch_size": 300,
11
    "lead_ids": [
12
        "12345",
13
        "67890"
14
    ],
15
    "next_page_token": "SOME_TOKEN_123"
16
}

Sample Output

1
{
2
    "requestId": "1a2b3c#14875940",
3
    "success": true,
4
    "nextPageToken": "NEXT_TOKEN_456",
5
    "moreResult": true,
6
    "result": [
7
        {
8
            "id": 1001,
9
            "leadId": 12345,
10
            "activityDate": "2023-06-15T10:30:00Z",
11
            "activityTypeId": 1,
12
            "primaryAttributeValueId": 100,
13
            "primaryAttributeValue": "Visited Webpage",
14
            "attributes": [
15
                {
16
                    "name": "Webpage URL",
17
                    "value": "https://example.com/product"
18
                },
19
                {
20
                    "name": "Referrer",
21
                    "value": "https://google.com"
22
                }
23
            ]
24
        },
25
        {
26
            "id": 1002,
27
            "leadId": 67890,
28
            "activityDate": "2023-06-15T11:45:00Z",
29
            "activityTypeId": 2,
30
            "primaryAttributeValueId": 200,
31
            "primaryAttributeValue": "Form Submitted",
32
            "attributes": [
33
                {
34
                    "name": "Form Name",
35
                    "value": "Contact Us"
36
                },
37
                {
38
                    "name": "Form Fields",
39
                    "value": "Name, Email, Company"
40
                }
41
            ]
42
        }
43
    ]
44
}

Get lead bulk export job status
Copy

Gets the current status of a bulk lead export job.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "export_id": "bulk_export_12345",
6
    "quota_wait": false
7
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": {
4
        "exportId": "bulk_export_12345",
5
        "format": "CSV",
6
        "status": "Completed",
7
        "createdAt": "2023-06-15T10:30:00Z",
8
        "queuedAt": "2023-06-15T10:30:05Z",
9
        "startedAt": "2023-06-15T10:31:00Z",
10
        "finishedAt": "2023-06-15T10:35:30Z",
11
        "numberOfRecords": 5000,
12
        "fileSize": 1048576
13
    },
14
    "success": true
15
}

Get lead by ID
Copy

Get a lead in Marketo by their ID.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com/rest",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "lead_id": 12345,
6
    "fields": [
7
        "email",
8
        "firstName",
9
        "lastName",
10
        "company",
11
        "phone",
12
        "title"
13
    ]
14
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f8",
3
    "success": true,
4
    "result": [
5
        {
6
            "id": 12345,
7
            "email": "john.doe@example.com",
8
            "firstName": "John",
9
            "lastName": "Doe",
10
            "company": "Acme Corporation",
11
            "phone": "+1 (555) 123-4567",
12
            "title": "Marketing Manager",
13
            "createdAt": "2023-04-15T10:30:00Z",
14
            "updatedAt": "2023-05-20T14:45:00Z"
15
        }
16
    ]
17
}

Get lead changes
Copy

This API retrieves change data value for leads.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "list_id": "12345",
6
    "fields": [
7
        "email",
8
        "firstName",
9
        "lastName",
10
        "company",
11
        "title"
12
    ],
13
    "batch_size": 100,
14
    "next_page_token": "SOME_TOKEN_123"
15
}

Sample Output

1
{
2
    "requestId": "1a2b3c4d#15e6f7g8h",
3
    "success": true,
4
    "nextPageToken": "NEXT_TOKEN_456",
5
    "moreResult": true,
6
    "result": [
7
        {
8
            "id": 1001,
9
            "leadId": 54321,
10
            "activityDate": "2023-06-15T14:30:00Z",
11
            "activityTypeId": 12,
12
            "fields": [
13
                {
14
                    "id": 6,
15
                    "name": "email",
16
                    "newValue": "john.doe@example.com",
17
                    "oldValue": "j.doe@oldcompany.com"
18
                },
19
                {
20
                    "id": 8,
21
                    "name": "company",
22
                    "newValue": "New Corp Inc.",
23
                    "oldValue": "Old Company Ltd."
24
                }
25
            ],
26
            "attributes": [
27
                {
28
                    "name": "Source",
29
                    "value": "Website Form"
30
                },
31
                {
32
                    "name": "Last Modified",
33
                    "value": "2023-06-15T14:30:00Z"
34
                }
35
            ]
36
        },
37
        {
38
            "id": 1002,
39
            "leadId": 54322,
40
            "activityDate": "2023-06-15T15:45:00Z",
41
            "activityTypeId": 13,
42
            "fields": [
43
                {
44
                    "id": 7,
45
                    "name": "title",
46
                    "newValue": "Senior Marketing Manager",
47
                    "oldValue": "Marketing Manager"
48
                }
49
            ],
50
            "attributes": [
51
                {
52
                    "name": "Source",
53
                    "value": "Manual Update"
54
                },
55
                {
56
                    "name": "Last Modified",
57
                    "value": "2023-06-15T15:45:00Z"
58
                }
59
            ]
60
        }
61
    ]
62
}

Get lead import failures
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com/rest",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "batch_id": "1234567",
6
    "quota_wait": false
7
}

Sample Output

1
{
2
    "file": {
3
        "name": "lead_import_failures_1234567.csv",
4
        "url": "https://app-abc.marketo.com/download/lead_import_failures_1234567.csv",
5
        "mime_type": "text/csv",
6
        "expires": 1623456789
7
    }
8
}

Get lead import warnings
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "batch_id": "1234567"
6
}

Sample Output

1
{
2
    "file": {
3
        "name": "lead_import_warnings_1234567.csv",
4
        "url": "https://app-ab12.marketo.com/rest/v1/leads/import/1234567/warnings.csv",
5
        "mime_type": "text/csv",
6
        "expires": 1623456789
7
    }
8
}

Get leads bulk import status
Copy

Returns the status of a leads import batch job.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ",
5
    "batch_id": "1234567"
6
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f8",
3
    "result": {
4
        "batchId": 1234567,
5
        "importId": "imp_123456789",
6
        "status": "Completed",
7
        "numOfLeadsProcessed": 1000,
8
        "numOfRowsFailed": 5,
9
        "numOfRowsWithWarning": 10,
10
        "message": "Import job completed successfully"
11
    },
12
    "success": true
13
}

Get paging token
Copy

This API returns a token for a given date.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": false,
6
    "since_date_time": "2023-05-01T00:00:00Z"
7
}

Sample Output

1
{
2
    "requestId": "1234a#178b5c6d789e0f",
3
    "success": true,
4
    "nextPageToken": "ABCDE12345fghij67890"
5
}

Get program by ID
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "program_id": 1234
6
}

Sample Output

1
{
2
    "success": true,
3
    "warnings": [],
4
    "errors": [],
5
    "requestId": "1a2b3#4c5d6e7f",
6
    "result": [
7
        {
8
            "id": 1234,
9
            "name": "Summer Promotion 2023",
10
            "description": "Special discounts for summer products",
11
            "createdAt": "2023-05-01T10:30:00Z",
12
            "updatedAt": "2023-05-15T14:45:00Z",
13
            "url": "https://app.marketo.com/#PR1234A1",
14
            "type": "Event",
15
            "channel": "Online Advertising",
16
            "folder": {
17
                "type": "Folder",
18
                "value": 5678,
19
                "folderName": "Summer Campaigns"
20
            },
21
            "status": "Active",
22
            "workspace": "Marketing",
23
            "tags": [
24
                "summer",
25
                "promotion",
26
                "2023"
27
            ],
28
            "costs": [
29
                {
30
                    "startDate": "2023-06-01",
31
                    "cost": 5000,
32
                    "note": "Initial budget allocation"
33
                },
34
                {
35
                    "startDate": "2023-07-01",
36
                    "cost": 3000,
37
                    "note": "Additional advertising spend"
38
                }
39
            ]
40
        }
41
    ]
42
}

Get program by name
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "program_name": "Summer Promotion 2023",
6
    "program_tags": true,
7
    "program_costs": true
8
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#1234567890",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 1234,
9
            "name": "Summer Promotion 2023",
10
            "description": "Special summer discount campaign for loyal customers",
11
            "createdAt": "2023-05-01T09:00:00Z",
12
            "updatedAt": "2023-05-15T14:30:00Z",
13
            "url": "https://app.marketo.com/m#program/1234",
14
            "type": "Default",
15
            "channel": "Email",
16
            "folder": {
17
                "type": "Folder",
18
                "value": 5678,
19
                "folderName": "Promotional Campaigns"
20
            },
21
            "status": "Active",
22
            "workspace": "Marketing",
23
            "tags": [
24
                {
25
                    "tagType": "Season",
26
                    "tagValue": "Summer"
27
                },
28
                {
29
                    "tagType": "Campaign Type",
30
                    "tagValue": "Promotion"
31
                }
32
            ],
33
            "costs": [
34
                {
35
                    "startDate": "2023-06-01",
36
                    "cost": 5000,
37
                    "notes": "Initial campaign setup and design"
38
                },
39
                {
40
                    "startDate": "2023-07-01",
41
                    "cost": 2500,
42
                    "notes": "Mid-campaign optimization"
43
                }
44
            ]
45
        }
46
    ]
47
}

Get program members bulk export job status
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "export_id": "MKT-12345",
6
    "quota_wait": false
7
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": {
4
        "exportId": "MKT-12345",
5
        "format": "CSV",
6
        "status": "Completed",
7
        "createdAt": "2023-05-15T10:30:00Z",
8
        "queuedAt": "2023-05-15T10:30:05Z",
9
        "startedAt": "2023-05-15T10:31:00Z",
10
        "finishedAt": "2023-05-15T10:35:30Z",
11
        "numberOfRecords": 5000,
12
        "fileSize": 1048576,
13
        "fileChecksum": "a1b2c3d4e5f6g7h8i9j0"
14
    },
15
    "success": true
16
}

Get static list by ID
Copy

Returns a list record by its ID.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "list_id": 1234
6
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c#4d5e6f7g8h",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 1234,
9
            "name": "VIP Customers",
10
            "createdAt": "2023-05-15T10:30:00Z",
11
            "updatedAt": "2023-05-20T14:45:00Z",
12
            "folder": {
13
                "id": 5678,
14
                "type": "Folder"
15
            },
16
            "computedUrl": "https://app-abc123.marketo.com/#ST1234A1"
17
        }
18
    ]
19
}

Get static list by name
Copy

Returns a list record by its name.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "list_name": "VIP Customers"
6
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3#4c5d6e7f8",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 1234,
9
            "name": "VIP Customers",
10
            "createdAt": "2023-05-15T10:30:00Z",
11
            "updatedAt": "2023-05-20T14:45:00Z",
12
            "folder": {
13
                "id": 5678,
14
                "type": "Folder"
15
            },
16
            "computedUrl": "https://app-abc123.marketo.com/#ST1234A1"
17
        }
18
    ]
19
}

Get tokens by folder ID
Copy

Retrieves the list of available My Tokens in the target folder.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "folder_id": 1234,
6
    "folder_type": "Folder",
7
    "quota_wait": false
8
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#16789012345",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "folder": {
9
                "type": "Folder",
10
                "value": 1234
11
            },
12
            "tokens": [
13
                {
14
                    "name": "CompanyName",
15
                    "type": "text",
16
                    "value": "Acme Corporation",
17
                    "computedUrl": "https://app.marketo.com/tokens/CompanyName",
18
                    "section": "General",
19
                    "groupId": 5678,
20
                    "sortOrder": "1",
21
                    "lastModiFied": "2023-05-15T14:30:00Z"
22
                },
23
                {
24
                    "name": "WebsiteURL",
25
                    "type": "text",
26
                    "value": "https://www.acmecorp.com",
27
                    "computedUrl": "https://app.marketo.com/tokens/WebsiteURL",
28
                    "section": "General",
29
                    "groupId": 5678,
30
                    "sortOrder": "2",
31
                    "lastModiFied": "2023-05-15T14:31:00Z"
32
                }
33
            ]
34
        }
35
    ]
36
}

Invite user
Copy

Send an email invitation to a new user.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "email_address": "john.doe@example.com",
6
    "first_name": "John",
7
    "last_name": "Doe",
8
    "roles_and_workspaces": [
9
        {
10
            "accessRoleId": 1,
11
            "workspaceId": 100
12
        },
13
        {
14
            "accessRoleId": 2,
15
            "workspaceId": 200
16
        }
17
    ],
18
    "user_id": "john.doe@example.com",
19
    "api_only": false,
20
    "expires_at": "2023-12-31T23:59:59Z",
21
    "reason": "New marketing team member"
22
}

Sample Output

1
{
2
    "success": true
3
}

List campaigns
Copy

Get a list of campaigns

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "batch_size": 100,
6
    "ids": [
7
        1001,
8
        1002,
9
        1003
10
    ],
11
    "names": [
12
        "Summer Sale",
13
        "Fall Promotion"
14
    ],
15
    "program_names": [
16
        "Email Marketing",
17
        "Social Media"
18
    ],
19
    "workspace_names": [
20
        "Marketing",
21
        "Sales"
22
    ],
23
    "is_triggerable": true
24
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "id": 1001,
6
            "name": "Summer Sale",
7
            "type": "Email",
8
            "workspaceName": "Marketing",
9
            "createdAt": "2023-05-01T10:00:00Z",
10
            "updatedAt": "2023-05-15T14:30:00Z",
11
            "active": true
12
        },
13
        {
14
            "id": 1002,
15
            "name": "Fall Promotion",
16
            "type": "Social",
17
            "workspaceName": "Marketing",
18
            "createdAt": "2023-06-01T09:00:00Z",
19
            "updatedAt": "2023-06-10T11:45:00Z",
20
            "active": true
21
        }
22
    ],
23
    "success": true
24
}

List custom object types
Copy

Get a list of all of the custom object types.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": true,
6
    "names": [
7
        "CustomObject1",
8
        "CustomObject2"
9
    ]
10
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": [
4
        {
5
            "name": "CustomObject1",
6
            "displayName": "Custom Object 1",
7
            "createdAt": "2023-05-15T10:30:00Z",
8
            "updatedAt": "2023-05-15T10:30:00Z",
9
            "idField": "customObject1Id",
10
            "dedupeFields": [
11
                "email",
12
                "companyName"
13
            ],
14
            "searchableFields": [
15
                [
16
                    "email"
17
                ],
18
                [
19
                    "companyName"
20
                ],
21
                [
22
                    "firstName",
23
                    "lastName"
24
                ]
25
            ]
26
        },
27
        {
28
            "name": "CustomObject2",
29
            "displayName": "Custom Object 2",
30
            "createdAt": "2023-05-16T14:45:00Z",
31
            "updatedAt": "2023-05-16T14:45:00Z",
32
            "idField": "customObject2Id",
33
            "dedupeFields": [
34
                "uniqueIdentifier"
35
            ],
36
            "searchableFields": [
37
                [
38
                    "uniqueIdentifier"
39
                ],
40
                [
41
                    "productName"
42
                ]
43
            ]
44
        }
45
    ],
46
    "success": true
47
}

List custom objects
Copy

Get a list of custom objects of a given type.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "name": "my_custom_object",
6
    "filter_type": "id",
7
    "filter_values": [
8
        "1001",
9
        "1002",
10
        "1003"
11
    ],
12
    "fields": [
13
        "id",
14
        "name",
15
        "email",
16
        "company"
17
    ],
18
    "batch_size": 300
19
}

Sample Output

1
{
2
    "requestId": "1a2b3c#4d5e6f",
3
    "result": [
4
        {
5
            "seq": 1,
6
            "marketoGUID": "ABCD1234-5678-90EF-GHIJ-KLMNOPQRSTUV",
7
            "updatedAt": "2023-06-15T10:30:00Z",
8
            "createdAt": "2023-06-01T09:00:00Z",
9
            "id": "1001",
10
            "name": "John Doe",
11
            "email": "john.doe@example.com",
12
            "company": "Acme Corp"
13
        },
14
        {
15
            "seq": 2,
16
            "marketoGUID": "WXYZ9876-5432-10AB-CDEF-GHIJKLMNOPQR",
17
            "updatedAt": "2023-06-14T14:45:00Z",
18
            "createdAt": "2023-06-02T11:30:00Z",
19
            "id": "1002",
20
            "name": "Jane Smith",
21
            "email": "jane.smith@example.com",
22
            "company": "XYZ Inc"
23
        }
24
    ],
25
    "success": true
26
}

List deleted leads
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ",
5
    "quota_wait": false,
6
    "next_page_token": "SOME_TOKEN_12345",
7
    "batch_size": 300
8
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "id": 12345,
6
            "marketoGUID": "MKTO-GUID-12345-ABCDE",
7
            "leadId": 67890,
8
            "activityDate": "2023-05-15T14:30:00Z",
9
            "activityTypeId": 13,
10
            "primaryAttributeValueId": 1001,
11
            "primaryAttributeValue": "john.doe@example.com",
12
            "attributes": [
13
                {
14
                    "name": "First Name",
15
                    "value": "John"
16
                },
17
                {
18
                    "name": "Last Name",
19
                    "value": "Doe"
20
                },
21
                {
22
                    "name": "Company",
23
                    "value": "Acme Inc."
24
                }
25
            ]
26
        }
27
    ],
28
    "success": true,
29
    "nextPageToken": "NEXT_TOKEN_67890",
30
    "moreResult": true
31
}

List folders
Copy

Retrieve a list of child folders within a given root folder.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "root": {
6
        "id": 1001,
7
        "type": "Folder"
8
    },
9
    "max_depth": 3,
10
    "work_space": "Default",
11
    "max_return": 50,
12
    "offset": 0
13
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#16805432901",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "name": "Marketing Campaigns",
9
            "description": "Folder for all marketing campaigns",
10
            "createdAt": "2023-01-15T10:30:00Z",
11
            "updatedAt": "2023-04-02T14:45:00Z",
12
            "url": "https://app.marketo.com/#FO1001A1",
13
            "folderId": {
14
                "id": 1002,
15
                "type": "Folder"
16
            },
17
            "folderType": "Program",
18
            "parent": {},
19
            "path": "Marketing Campaigns",
20
            "isArchive": false,
21
            "isSystem": false,
22
            "accessZoneId": 1,
23
            "workspace": "Default",
24
            "id": 1002
25
        },
26
        {
27
            "name": "Email Templates",
28
            "description": "Folder for email templates",
29
            "createdAt": "2023-01-20T09:15:00Z",
30
            "updatedAt": "2023-03-28T11:20:00Z",
31
            "url": "https://app.marketo.com/#FO1001A2",
32
            "folderId": {
33
                "id": 1003,
34
                "type": "Folder"
35
            },
36
            "folderType": "Asset",
37
            "parent": {},
38
            "path": "Email Templates",
39
            "isArchive": false,
40
            "isSystem": false,
41
            "accessZoneId": 1,
42
            "workspace": "Default",
43
            "id": 1003
44
        }
45
    ]
46
}

List landing pages
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": false,
6
    "status": "approved",
7
    "folder": {
8
        "id": 1234,
9
        "type": "Folder"
10
    },
11
    "offset": 0,
12
    "max_return": 20
13
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#16789012345",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 1001,
9
            "name": "Summer Sale Landing Page",
10
            "description": "Landing page for our summer sale campaign",
11
            "createdAt": "2023-05-15T10:30:00Z",
12
            "updatedAt": "2023-06-01T14:45:00Z",
13
            "folder": {
14
                "type": "Folder",
15
                "value": 1234,
16
                "folderName": "Marketing Campaigns"
17
            },
18
            "workspace": "Default",
19
            "status": "approved",
20
            "template": 5001,
21
            "robots": "index, follow",
22
            "formPrefill": true,
23
            "mobileEnabled": true,
24
            "URL": "/summer-sale",
25
            "computedUrl": "https://go.example.com/summer-sale"
26
        },
27
        {
28
            "id": 1002,
29
            "name": "Product Launch Landing Page",
30
            "description": "Landing page for new product launch",
31
            "createdAt": "2023-05-20T09:15:00Z",
32
            "updatedAt": "2023-05-31T16:20:00Z",
33
            "folder": {
34
                "type": "Folder",
35
                "value": 1234,
36
                "folderName": "Marketing Campaigns"
37
            },
38
            "workspace": "Default",
39
            "status": "approved",
40
            "template": 5002,
41
            "robots": "index, follow",
42
            "formPrefill": true,
43
            "mobileEnabled": true,
44
            "URL": "/new-product-launch",
45
            "computedUrl": "https://go.example.com/new-product-launch"
46
        }
47
    ]
48
}

List lead fields
Copy

Retrieves metadata for all lead fields in the target instance.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "quota_wait": false,
6
    "batch_size": 300,
7
    "next_page_token": ""
8
}

Sample Output

1
{
2
    "errors": [],
3
    "moreResult": true,
4
    "nextPageToken": "ABCDEFGHIJKLMNOP123456789",
5
    "requestId": "1234a#567b#89c0d",
6
    "result": [
7
        {
8
            "displayName": "First Name",
9
            "name": "firstName",
10
            "description": "Lead's first name",
11
            "dataType": "string",
12
            "length": 50,
13
            "isHidden": false,
14
            "isHtmlEncodingInEmail": false,
15
            "isSensitive": false,
16
            "isCustom": false,
17
            "isApiCreated": false
18
        },
19
        {
20
            "displayName": "Last Name",
21
            "name": "lastName",
22
            "description": "Lead's last name",
23
            "dataType": "string",
24
            "length": 50,
25
            "isHidden": false,
26
            "isHtmlEncodingInEmail": false,
27
            "isSensitive": false,
28
            "isCustom": false,
29
            "isApiCreated": false
30
        },
31
        {
32
            "displayName": "Email Address",
33
            "name": "email",
34
            "description": "Lead's email address",
35
            "dataType": "email",
36
            "length": 100,
37
            "isHidden": false,
38
            "isHtmlEncodingInEmail": false,
39
            "isSensitive": true,
40
            "isCustom": false,
41
            "isApiCreated": false
42
        }
43
    ],
44
    "success": true,
45
    "warnings": []
46
}

List leads
Copy

Get a list of leads.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "filter_type": "email",
6
    "filter_values": [
7
        "john.doe@example.com",
8
        "jane.smith@example.com"
9
    ],
10
    "fields": [
11
        "id",
12
        "firstName",
13
        "lastName",
14
        "email",
15
        "company",
16
        "title"
17
    ],
18
    "batch_size": 300
19
}

Sample Output

1
{
2
    "requestId": "1234a#56b",
3
    "result": [
4
        {
5
            "id": 12345,
6
            "updatedAt": "2023-05-15T10:30:45Z",
7
            "lastName": "Doe",
8
            "email": "john.doe@example.com",
9
            "createdAt": "2023-01-01T09:00:00Z",
10
            "firstName": "John",
11
            "company": "Acme Corp",
12
            "title": "Software Engineer"
13
        },
14
        {
15
            "id": 67890,
16
            "updatedAt": "2023-05-14T14:20:30Z",
17
            "lastName": "Smith",
18
            "email": "jane.smith@example.com",
19
            "createdAt": "2023-02-15T11:45:00Z",
20
            "firstName": "Jane",
21
            "company": "Tech Solutions Inc",
22
            "title": "Product Manager"
23
        }
24
    ],
25
    "success": true,
26
    "nextPageToken": "ABCDEFGHIJKLMNOP1234567890"
27
}

List program leads
Copy

Get a list of leads belonging to a particular program.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdef",
5
    "program_id": "1234",
6
    "batch_size": 300,
7
    "quota_wait": false
8
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "id": 12345,
6
            "updatedAt": "2023-05-15T14:30:00Z",
7
            "lastName": "Smith",
8
            "email": "john.smith@example.com",
9
            "createdAt": "2023-01-01T10:00:00Z",
10
            "firstName": "John",
11
            "membership": {
12
                "progressionStatus": "Engaged",
13
                "isExhausted": false,
14
                "acquiredBy": true,
15
                "reachedSuccess": false,
16
                "membershipDate": "2023-03-15T09:00:00Z"
17
            }
18
        },
19
        {
20
            "id": 67890,
21
            "updatedAt": "2023-05-14T16:45:00Z",
22
            "lastName": "Doe",
23
            "email": "jane.doe@example.com",
24
            "createdAt": "2023-02-15T11:30:00Z",
25
            "firstName": "Jane",
26
            "membership": {
27
                "progressionStatus": "Completed",
28
                "isExhausted": true,
29
                "acquiredBy": true,
30
                "reachedSuccess": true,
31
                "membershipDate": "2023-04-01T14:00:00Z"
32
            }
33
        }
34
    ],
35
    "success": true,
36
    "nextPageToken": "NEXT_PAGE_TOKEN_123456"
37
}

List programs
Copy

Get a list of programs in your Marketo account.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "filter_type": "workspace",
6
    "filter_values": [
7
        "Marketing"
8
    ],
9
    "earliest_updated_at": "2023-01-01T00:00:00Z",
10
    "last_updated_at": "2023-06-30T23:59:59Z",
11
    "offset": 0,
12
    "max_return": 50
13
}

Sample Output

1
{
2
    "success": true,
3
    "warnings": [],
4
    "errors": [],
5
    "requestId": "1a2b3c4d#16789012345",
6
    "result": [
7
        {
8
            "id": 1001,
9
            "name": "Summer Sale Campaign",
10
            "description": "Promotional campaign for summer products",
11
            "createdAt": "2023-05-15T10:30:00Z",
12
            "updatedAt": "2023-06-01T14:45:00Z",
13
            "url": "https://app.marketo.com/m#PG1001A1",
14
            "type": "Email",
15
            "channel": "Email",
16
            "folder": {
17
                "type": "Folder",
18
                "value": 5001,
19
                "folderName": "Campaigns"
20
            },
21
            "status": "Active",
22
            "workspace": "Marketing"
23
        },
24
        {
25
            "id": 1002,
26
            "name": "Product Launch Webinar",
27
            "description": "Webinar for new product introduction",
28
            "createdAt": "2023-06-10T09:00:00Z",
29
            "updatedAt": "2023-06-20T16:30:00Z",
30
            "url": "https://app.marketo.com/m#PG1002A1",
31
            "type": "Event",
32
            "channel": "Webinar",
33
            "folder": {
34
                "type": "Folder",
35
                "value": 5002,
36
                "folderName": "Events"
37
            },
38
            "status": "Planned",
39
            "workspace": "Marketing"
40
        }
41
    ]
42
}

List roles
Copy

Return a list of all role records.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretKey987654321",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 1,
5
            "name": "Marketing Manager",
6
            "description": "Manages marketing campaigns and strategies",
7
            "type": "Standard",
8
            "hidden": false,
9
            "onlyAllZones": false,
10
            "createdAt": "2023-05-15T10:30:00Z",
11
            "updatedAt": "2023-05-15T10:30:00Z"
12
        },
13
        {
14
            "id": 2,
15
            "name": "Sales Representative",
16
            "description": "Handles sales activities and customer relationships",
17
            "type": "Standard",
18
            "hidden": false,
19
            "onlyAllZones": false,
20
            "createdAt": "2023-05-15T11:00:00Z",
21
            "updatedAt": "2023-05-15T11:00:00Z"
22
        },
23
        {
24
            "id": 3,
25
            "name": "Administrator",
26
            "description": "Manages system settings and user permissions",
27
            "type": "Admin",
28
            "hidden": false,
29
            "onlyAllZones": true,
30
            "createdAt": "2023-05-15T09:00:00Z",
31
            "updatedAt": "2023-05-15T09:00:00Z"
32
        }
33
    ]
34
}

List smart campaigns
Copy

Retrieve a list of smart campaigns.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdef",
5
    "quota_wait": true,
6
    "earliest_updated_at": "2023-01-01T00:00:00Z",
7
    "last_updated_at": "2023-06-30T23:59:59Z",
8
    "folder": {
9
        "id": 1234,
10
        "type": "Folder"
11
    },
12
    "offset": 0,
13
    "max_return": 50,
14
    "is_active": true
15
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3c4d#1234567890",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 1001,
9
            "name": "Summer Promotion Campaign",
10
            "description": "Campaign for summer product promotions",
11
            "createdAt": "2023-05-15T10:30:00Z",
12
            "updatedAt": "2023-06-01T14:45:00Z",
13
            "status": "Active",
14
            "type": "Trigger",
15
            "isSystem": false,
16
            "isActive": true,
17
            "isRequestable": false,
18
            "isCommunicationLimitEnabled": true,
19
            "recurrence": {
20
                "weekdayOnly": true
21
            },
22
            "qualificationRuleType": "Continuous",
23
            "qualificationRuleInterval": 1,
24
            "qualificationRuleUnit": "Day",
25
            "workspace": "Marketing",
26
            "smartListId": 5001,
27
            "flowId": 6001,
28
            "computedUrl": "https://app-ab12.marketo.com/#SC1001A1"
29
        },
30
        {
31
            "id": 1002,
32
            "name": "New Customer Onboarding",
33
            "description": "Automated onboarding process for new customers",
34
            "createdAt": "2023-04-01T09:00:00Z",
35
            "updatedAt": "2023-06-15T11:20:00Z",
36
            "status": "Active",
37
            "type": "Batch",
38
            "isSystem": false,
39
            "isActive": true,
40
            "isRequestable": true,
41
            "isCommunicationLimitEnabled": false,
42
            "recurrence": {
43
                "weekdayOnly": false
44
            },
45
            "qualificationRuleType": "Batch",
46
            "qualificationRuleInterval": 7,
47
            "qualificationRuleUnit": "Days",
48
            "workspace": "Customer Success",
49
            "smartListId": 5002,
50
            "flowId": 6002,
51
            "computedUrl": "https://app-ab12.marketo.com/#SC1002A1"
52
        }
53
    ]
54
}

List static lists
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "batch_size": 300,
6
    "ids": [
7
        1001,
8
        1002,
9
        1003
10
    ],
11
    "names": [
12
        "VIP Customers",
13
        "Newsletter Subscribers"
14
    ],
15
    "program_names": [
16
        "Summer Campaign",
17
        "Fall Promotion"
18
    ],
19
    "workspace_names": [
20
        "Marketing",
21
        "Sales"
22
    ]
23
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e",
3
    "result": [
4
        {
5
            "id": 1001,
6
            "name": "VIP Customers",
7
            "workspaceName": "Marketing",
8
            "createdAt": "2023-05-01T10:30:00Z",
9
            "updatedAt": "2023-05-15T14:45:00Z",
10
            "programName": "Summer Campaign"
11
        },
12
        {
13
            "id": 1002,
14
            "name": "Newsletter Subscribers",
15
            "workspaceName": "Marketing",
16
            "createdAt": "2023-04-15T09:00:00Z",
17
            "updatedAt": "2023-05-20T11:20:00Z",
18
            "programName": "Fall Promotion"
19
        },
20
        {
21
            "id": 1003,
22
            "name": "High-Value Leads",
23
            "workspaceName": "Sales",
24
            "createdAt": "2023-05-10T13:15:00Z",
25
            "updatedAt": "2023-05-22T16:30:00Z",
26
            "programName": null
27
        }
28
    ],
29
    "success": true
30
}

List user roles and workspaces
Copy

Return a list of user role and workspace records.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdef",
5
    "user_id": "mkto_1234567"
6
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "accessRoleId": 1,
5
            "accessRoleName": "Marketing User",
6
            "workspaceId": 101,
7
            "workspaceName": "Main Workspace"
8
        },
9
        {
10
            "accessRoleId": 2,
11
            "accessRoleName": "Admin",
12
            "workspaceId": 102,
13
            "workspaceName": "Analytics Workspace"
14
        },
15
        {
16
            "accessRoleId": 3,
17
            "accessRoleName": "Content Editor",
18
            "workspaceId": 103,
19
            "workspaceName": "Content Management Workspace"
20
        }
21
    ]
22
}

List users
Copy

Retrieve a list of all user records.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP123456789",
5
    "quota_wait": false
6
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "userid": "user123",
5
            "firstName": "John",
6
            "lastName": "Doe",
7
            "emailAddress": "john.doe@example.com",
8
            "id": 1001,
9
            "apiOnly": false
10
        },
11
        {
12
            "userid": "user456",
13
            "firstName": "Jane",
14
            "lastName": "Smith",
15
            "emailAddress": "jane.smith@example.com",
16
            "id": 1002,
17
            "apiOnly": true
18
        },
19
        {
20
            "userid": "user789",
21
            "firstName": "Mike",
22
            "lastName": "Johnson",
23
            "emailAddress": "mike.johnson@example.com",
24
            "id": 1003,
25
            "apiOnly": false
26
        }
27
    ]
28
}

List workspaces
Copy

Retrieve a list of workspace records.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 1001,
5
            "name": "Marketing Workspace",
6
            "description": "Main workspace for marketing campaigns",
7
            "globalViz": "true",
8
            "status": "active",
9
            "currencyInfo": "USD",
10
            "createdAt": "2023-01-15T09:30:00Z",
11
            "updatedAt": "2023-05-20T14:45:00Z"
12
        },
13
        {
14
            "id": 1002,
15
            "name": "Sales Workspace",
16
            "description": "Workspace for sales team activities",
17
            "globalViz": "false",
18
            "status": "active",
19
            "currencyInfo": "EUR",
20
            "createdAt": "2023-02-01T11:00:00Z",
21
            "updatedAt": "2023-05-18T16:20:00Z"
22
        }
23
    ]
24
}

Push lead
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_id_123456",
4
    "client_secret": "client_secret_abcdef",
5
    "program_name": "Summer Marketing Campaign",
6
    "source": "Website Form",
7
    "reason": "New Lead",
8
    "lookup_field": "email",
9
    "leads": [
10
        {
11
            "firstName": "John",
12
            "lastName": "Doe",
13
            "email": "john.doe@example.com",
14
            "phone": "+1-555-123-4567",
15
            "title": "Marketing Manager",
16
            "company": "Acme Corp",
17
            "address": "123 Main St",
18
            "city": "San Francisco",
19
            "state": "CA",
20
            "country": "USA",
21
            "postalCode": "94105",
22
            "industry": "Technology",
23
            "leadSource": "Website",
24
            "leadStatus": "New",
25
            "leadScore": 50
26
        }
27
    ]
28
}

Sample Output

1
{
2
    "requestId": "1234a#56b",
3
    "result": [
4
        {
5
            "id": 12345,
6
            "status": "created"
7
        }
8
    ],
9
    "success": true
10
}

Raw HTTP request (advanced)
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123abc456def",
4
    "client_secret": "secret_789ghi101112",
5
    "method": "GET",
6
    "url": {
7
        "endpoint": "/rest/v1/leads.json"
8
    },
9
    "headers": [
10
        {
11
            "key": "Content-Type",
12
            "value": "application/json"
13
        }
14
    ],
15
    "query_parameters": [
16
        {
17
            "key": "filterType",
18
            "value": "email"
19
        },
20
        {
21
            "key": "filterValues",
22
            "value": "john.doe@example.com"
23
        }
24
    ],
25
    "body": {
26
        "none": null
27
    },
28
    "include_raw_body": false,
29
    "parse_response": "true"
30
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 200,
4
        "headers": {
5
            "Content-Type": "application/json;charset=UTF-8",
6
            "Date": "Mon, 01 May 2023 12:00:00 GMT",
7
            "Server": "Apache-Coyote/1.1"
8
        },
9
        "body": {
10
            "requestId": "1234a#1234567890",
11
            "result": [
12
                {
13
                    "id": 12345,
14
                    "firstName": "John",
15
                    "lastName": "Doe",
16
                    "email": "john.doe@example.com",
17
                    "createdAt": "2023-04-15T10:30:00Z",
18
                    "updatedAt": "2023-04-30T15:45:00Z"
19
                }
20
            ],
21
            "success": true
22
        }
23
    }
24
}

Search companies
Copy

Retrieve multiple companies for a given search criteria.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMN",
5
    "filter_type": "company",
6
    "filter_values": [
7
        "Acme Corp",
8
        "TechSolutions Inc"
9
    ],
10
    "fields": [
11
        "id",
12
        "company",
13
        "industry",
14
        "annualRevenue",
15
        "numberOfEmployees"
16
    ],
17
    "batch_size": 200
18
}

Sample Output

1
{
2
    "requestId": "1a2b3c#4d5e6f",
3
    "result": [
4
        {
5
            "seq": 1,
6
            "id": 12345,
7
            "createdAt": "2023-05-15T10:30:00Z",
8
            "company": "Acme Corp",
9
            "industry": "Manufacturing",
10
            "annualRevenue": 5000000,
11
            "numberOfEmployees": 250,
12
            "updatedAt": "2023-06-01T14:45:00Z"
13
        },
14
        {
15
            "seq": 2,
16
            "id": 67890,
17
            "createdAt": "2023-04-20T09:15:00Z",
18
            "company": "TechSolutions Inc",
19
            "industry": "Information Technology",
20
            "annualRevenue": 10000000,
21
            "numberOfEmployees": 500,
22
            "updatedAt": "2023-05-28T11:20:00Z"
23
        }
24
    ],
25
    "success": true,
26
    "nextPageToken": "NEXT_PAGE_TOKEN_123456"
27
}

Search leads
Copy

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

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secret_abcdefghijklmno",
5
    "filter_type": "email",
6
    "filter_values": [
7
        "john.doe@example.com",
8
        "jane.smith@example.com"
9
    ],
10
    "fields": [
11
        "email",
12
        "firstName",
13
        "lastName",
14
        "company",
15
        "title"
16
    ],
17
    "batch_size": 300
18
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": [
4
        {
5
            "id": 12345,
6
            "email": "john.doe@example.com",
7
            "firstName": "John",
8
            "lastName": "Doe",
9
            "company": "Acme Inc.",
10
            "title": "Software Engineer",
11
            "createdAt": "2023-04-15T10:30:00Z",
12
            "updatedAt": "2023-05-01T14:45:00Z"
13
        },
14
        {
15
            "id": 67890,
16
            "email": "jane.smith@example.com",
17
            "firstName": "Jane",
18
            "lastName": "Smith",
19
            "company": "Tech Solutions Ltd.",
20
            "title": "Marketing Manager",
21
            "createdAt": "2023-03-20T09:15:00Z",
22
            "updatedAt": "2023-04-28T11:20:00Z"
23
        }
24
    ],
25
    "success": true,
26
    "nextPageToken": "ABCDE12345fghij67890"
27
}

Search opportunities
Copy

Retrieve multiple opportunities for a given search criteria.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "filter_type": "dedupeFields",
6
    "filter_values": [
7
        "externalOpportunityId"
8
    ],
9
    "fields": [
10
        "externalOpportunityId",
11
        "marketoGUID",
12
        "createdAt",
13
        "updatedAt"
14
    ],
15
    "batch_size": 100
16
}

Sample Output

1
{
2
    "requestId": "1234a#56789b",
3
    "result": [
4
        {
5
            "seq": 1,
6
            "marketoGUID": "abc123de-f456-7890-ghij-klmnopqrstuv",
7
            "externalOpportunityId": "OPP-001",
8
            "updatedAt": "2023-06-15T14:30:00Z",
9
            "createdAt": "2023-06-01T09:00:00Z"
10
        },
11
        {
12
            "seq": 2,
13
            "marketoGUID": "def456gh-i789-0123-jklm-nopqrstuvwxy",
14
            "externalOpportunityId": "OPP-002",
15
            "updatedAt": "2023-06-16T10:15:00Z",
16
            "createdAt": "2023-06-02T11:30:00Z"
17
        }
18
    ],
19
    "success": true,
20
    "nextPageToken": "ABCDEFGHIJKLMNOP1234567890"
21
}

Search opportunity roles
Copy

Retrieve multiple opportunity roles for a given search criteria.

Sample Input

1
{
2
    "filter_type": "dedupeFields",
3
    "filter_values": [
4
        {
5
            "externalOpportunityId": "OPP-123456",
6
            "leadId": 12345,
7
            "role": "Decision Maker"
8
        }
9
    ],
10
    "fields": [
11
        "marketoGUID",
12
        "leadId",
13
        "createdAt",
14
        "updatedAt",
15
        "role",
16
        "externalOpportunityId"
17
    ],
18
    "batch_size": 300
19
}

Sample Output

1
{
2
    "requestId": "1a2b3c4d#5e6f7g8h",
3
    "result": [
4
        {
5
            "seq": 1,
6
            "marketoGUID": "MKTO-GUID-12345-ABCDE",
7
            "leadId": 12345,
8
            "createdAt": "2023-05-15T10:30:00Z",
9
            "updatedAt": "2023-05-15T14:45:00Z",
10
            "role": "Decision Maker",
11
            "externalOpportunityId": "OPP-123456"
12
        },
13
        {
14
            "seq": 2,
15
            "marketoGUID": "MKTO-GUID-67890-FGHIJ",
16
            "leadId": 67890,
17
            "createdAt": "2023-05-14T09:15:00Z",
18
            "updatedAt": "2023-05-15T11:20:00Z",
19
            "role": "Influencer",
20
            "externalOpportunityId": "OPP-123456"
21
        }
22
    ],
23
    "success": true,
24
    "nextPageToken": "NEXT-PAGE-TOKEN-123ABC"
25
}

Search sales people
Copy

Retrieve multiple companies for a given search criteria.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "filter_type": "email",
6
    "filter_values": [
7
        "john.doe@example.com",
8
        "jane.smith@example.com"
9
    ],
10
    "fields": [
11
        "id",
12
        "firstName",
13
        "lastName",
14
        "email",
15
        "title"
16
    ],
17
    "batch_size": 300
18
}

Sample Output

1
{
2
    "requestId": "1234a#56b",
3
    "result": [
4
        {
5
            "seq": 1,
6
            "id": 12345,
7
            "firstName": "John",
8
            "lastName": "Doe",
9
            "email": "john.doe@example.com",
10
            "title": "Sales Manager",
11
            "createdAt": "2023-05-15T10:30:00Z",
12
            "updatedAt": "2023-05-20T14:45:00Z"
13
        },
14
        {
15
            "seq": 2,
16
            "id": 67890,
17
            "firstName": "Jane",
18
            "lastName": "Smith",
19
            "email": "jane.smith@example.com",
20
            "title": "Account Executive",
21
            "createdAt": "2023-05-16T09:15:00Z",
22
            "updatedAt": "2023-05-21T11:20:00Z"
23
        }
24
    ],
25
    "success": true,
26
    "nextPageToken": "NEXT_PAGE_TOKEN_123"
27
}

Sync program member data
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP",
5
    "program_id": "1234",
6
    "sync_program_member_data_request": [
7
        {
8
            "leadId": 12345,
9
            "programStatus": "Completed",
10
            "acquisitionDate": "2023-05-15",
11
            "successScore": 85
12
        },
13
        {
14
            "leadId": 67890,
15
            "programStatus": "In Progress",
16
            "acquisitionDate": "2023-05-10",
17
            "successScore": 60
18
        }
19
    ]
20
}

Sample Output

1
{
2
    "errors": [],
3
    "moreResult": false,
4
    "requestId": "1a2b3c#4d5e6f",
5
    "result": [
6
        {
7
            "status": "updated",
8
            "leadId": 12345,
9
            "seq": 0
10
        },
11
        {
12
            "status": "updated",
13
            "leadId": 67890,
14
            "seq": 1
15
        }
16
    ],
17
    "success": true,
18
    "warnings": []
19
}

Trigger campaign
Copy

Trigger a campaign with specified input in Marketo.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghij",
5
    "campaign_id": "1234567",
6
    "input": {
7
        "leads": [
8
            1001,
9
            1002,
10
            1003
11
        ],
12
        "tokens": [
13
            {
14
                "name": "FirstName",
15
                "value": "John"
16
            },
17
            {
18
                "name": "CompanyName",
19
                "value": "Acme Corp"
20
            }
21
        ]
22
    }
23
}

Sample Output

1
{
2
    "requestId": "1a2b3#4c5d6e7f",
3
    "result": [
4
        {
5
            "id": 1001
6
        },
7
        {
8
            "id": 1002
9
        },
10
        {
11
            "id": 1003
12
        }
13
    ],
14
    "success": true
15
}

Update static list metadata
Copy

Updates the metadata of a static list asset.

Sample Input

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com/rest",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "list_id": 1234,
6
    "name": "Updated Customer List 2023",
7
    "description": "A comprehensive list of our active customers as of Q2 2023"
8
}

Sample Output

1
{
2
    "success": true,
3
    "errors": [],
4
    "requestId": "1a2b3#4c5d6e7f",
5
    "warnings": [],
6
    "result": [
7
        {
8
            "id": 1234,
9
            "name": "Updated Customer List 2023",
10
            "createdAt": "2023-01-15T10:30:00Z",
11
            "updatedAt": "2023-06-01T14:45:23Z",
12
            "folder": {
13
                "id": 5678,
14
                "type": "Folder"
15
            },
16
            "computedUrl": "https://app-ab12.marketo.com/#ST1234A1"
17
        }
18
    ]
19
}

DDL operations
Copy

Get activity type attributes (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefgh",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "success": true,
3
    "result": [
4
        {
5
            "id": 1,
6
            "name": "Visited Web Page",
7
            "description": "User visited a web page",
8
            "primaryAttribute": {
9
                "name": "Webpage ID",
10
                "dataType": "integer"
11
            },
12
            "attributes": [
13
                {
14
                    "name": "Webpage URL",
15
                    "dataType": "string"
16
                },
17
                {
18
                    "name": "Referrer URL",
19
                    "dataType": "string"
20
                },
21
                {
22
                    "name": "Search Engine",
23
                    "dataType": "string"
24
                },
25
                {
26
                    "name": "Search Query",
27
                    "dataType": "string"
28
                }
29
            ]
30
        },
31
        {
32
            "id": 2,
33
            "name": "Filled Out Form",
34
            "description": "User submitted a form",
35
            "primaryAttribute": {
36
                "name": "Form ID",
37
                "dataType": "integer"
38
            },
39
            "attributes": [
40
                {
41
                    "name": "Form Name",
42
                    "dataType": "string"
43
                },
44
                {
45
                    "name": "Form Fields",
46
                    "dataType": "string"
47
                }
48
            ]
49
        }
50
    ]
51
}

Get activity types (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOP123456789",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "success": true,
3
    "result": [
4
        {
5
            "id": 1,
6
            "name": "Visit Webpage",
7
            "description": "User visited a web page",
8
            "primaryAttribute": {
9
                "name": "Webpage ID",
10
                "dataType": "integer"
11
            },
12
            "attributes": [
13
                {
14
                    "name": "Client IP Address",
15
                    "dataType": "string"
16
                },
17
                {
18
                    "name": "Query Parameters",
19
                    "dataType": "string"
20
                }
21
            ]
22
        },
23
        {
24
            "id": 2,
25
            "name": "Fill Out Form",
26
            "description": "User submitted a form",
27
            "primaryAttribute": {
28
                "name": "Form ID",
29
                "dataType": "integer"
30
            },
31
            "attributes": [
32
                {
33
                    "name": "Form Name",
34
                    "dataType": "string"
35
                },
36
                {
37
                    "name": "Form Fields",
38
                    "dataType": "string"
39
                }
40
            ]
41
        },
42
        {
43
            "id": 3,
44
            "name": "Click Email",
45
            "description": "User clicked a link in an email",
46
            "primaryAttribute": {
47
                "name": "Link ID",
48
                "dataType": "integer"
49
            },
50
            "attributes": [
51
                {
52
                    "name": "Email ID",
53
                    "dataType": "integer"
54
                },
55
                {
56
                    "name": "Link URL",
57
                    "dataType": "string"
58
                }
59
            ]
60
        }
61
    ]
62
}

Get smart lists (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "smartLists": [
3
        {
4
            "id": 1001,
5
            "name": "High Value Prospects",
6
            "description": "Prospects with high engagement scores",
7
            "folderId": 5,
8
            "folderType": "Folder"
9
        },
10
        {
11
            "id": 1002,
12
            "name": "Recent Website Visitors",
13
            "description": "Contacts who visited the website in the last 7 days",
14
            "folderId": 5,
15
            "folderType": "Folder"
16
        },
17
        {
18
            "id": 1003,
19
            "name": "Unengaged Leads",
20
            "description": "Leads with no activity in the last 30 days",
21
            "folderId": 6,
22
            "folderType": "Folder"
23
        }
24
    ]
25
}

Get static lists (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "staticLists": [
3
        {
4
            "id": 1001,
5
            "name": "VIP Customers"
6
        },
7
        {
8
            "id": 1002,
9
            "name": "Newsletter Subscribers"
10
        },
11
        {
12
            "id": 1003,
13
            "name": "Webinar Attendees"
14
        },
15
        {
16
            "id": 1004,
17
            "name": "Product Beta Testers"
18
        }
19
    ]
20
}

List campaigns (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "abcdefghijklmnopqrstuvwxyz123456",
5
    "quota_wait": true
6
}

Sample Output

1
{}

List custom activity types (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "success": true,
3
    "result": [
4
        {
5
            "id": 1001,
6
            "name": "Webinar Attendance",
7
            "description": "Custom activity for tracking webinar attendance",
8
            "primaryAttribute": {
9
                "name": "webinarId",
10
                "dataType": "integer"
11
            },
12
            "attributes": [
13
                {
14
                    "name": "attendanceDate",
15
                    "dataType": "date"
16
                },
17
                {
18
                    "name": "duration",
19
                    "dataType": "integer"
20
                }
21
            ]
22
        },
23
        {
24
            "id": 1002,
25
            "name": "Product Demo",
26
            "description": "Custom activity for tracking product demonstrations",
27
            "primaryAttribute": {
28
                "name": "demoId",
29
                "dataType": "string"
30
            },
31
            "attributes": [
32
                {
33
                    "name": "productName",
34
                    "dataType": "string"
35
                },
36
                {
37
                    "name": "demoDate",
38
                    "dataType": "datetime"
39
                },
40
                {
41
                    "name": "feedbackScore",
42
                    "dataType": "integer"
43
                }
44
            ]
45
        }
46
    ]
47
}

List custom object fields (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "success": true,
3
    "result": [
4
        {
5
            "name": "customObjectName",
6
            "displayName": "Custom Object Name",
7
            "dataType": "string",
8
            "length": 255,
9
            "updateable": true,
10
            "createdAt": "2023-05-15T10:30:00Z",
11
            "updatedAt": "2023-05-15T10:30:00Z"
12
        },
13
        {
14
            "name": "customField1",
15
            "displayName": "Custom Field 1",
16
            "dataType": "integer",
17
            "updateable": true,
18
            "createdAt": "2023-05-15T10:31:00Z",
19
            "updatedAt": "2023-05-15T10:31:00Z"
20
        },
21
        {
22
            "name": "customField2",
23
            "displayName": "Custom Field 2",
24
            "dataType": "date",
25
            "updateable": true,
26
            "createdAt": "2023-05-15T10:32:00Z",
27
            "updatedAt": "2023-05-15T10:32:00Z"
28
        }
29
    ]
30
}

List custom object filter types (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdef",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "success": true,
3
    "result": [
4
        {
5
            "id": "string",
6
            "name": "String"
7
        },
8
        {
9
            "id": "integer",
10
            "name": "Integer"
11
        },
12
        {
13
            "id": "float",
14
            "name": "Float"
15
        },
16
        {
17
            "id": "boolean",
18
            "name": "Boolean"
19
        },
20
        {
21
            "id": "datetime",
22
            "name": "Date Time"
23
        },
24
        {
25
            "id": "reference",
26
            "name": "Reference"
27
        }
28
    ]
29
}

List custom object type fields (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{}

List custom object types (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "success": true,
3
    "result": [
4
        {
5
            "name": "car_c",
6
            "displayName": "Car",
7
            "description": "Custom object for car information",
8
            "createdAt": "2023-05-15T10:30:00Z",
9
            "updatedAt": "2023-05-15T10:30:00Z",
10
            "idField": "car_id_c",
11
            "dedupeFields": [
12
                "vin_c"
13
            ],
14
            "fields": [
15
                {
16
                    "name": "car_id_c",
17
                    "displayName": "Car ID",
18
                    "dataType": "integer",
19
                    "length": 10
20
                },
21
                {
22
                    "name": "make_c",
23
                    "displayName": "Make",
24
                    "dataType": "string",
25
                    "length": 50
26
                },
27
                {
28
                    "name": "model_c",
29
                    "displayName": "Model",
30
                    "dataType": "string",
31
                    "length": 50
32
                },
33
                {
34
                    "name": "year_c",
35
                    "displayName": "Year",
36
                    "dataType": "integer",
37
                    "length": 4
38
                },
39
                {
40
                    "name": "vin_c",
41
                    "displayName": "VIN",
42
                    "dataType": "string",
43
                    "length": 17
44
                }
45
            ]
46
        },
47
        {
48
            "name": "product_c",
49
            "displayName": "Product",
50
            "description": "Custom object for product information",
51
            "createdAt": "2023-05-16T14:45:00Z",
52
            "updatedAt": "2023-05-16T14:45:00Z",
53
            "idField": "product_id_c",
54
            "dedupeFields": [
55
                "sku_c"
56
            ],
57
            "fields": [
58
                {
59
                    "name": "product_id_c",
60
                    "displayName": "Product ID",
61
                    "dataType": "integer",
62
                    "length": 10
63
                },
64
                {
65
                    "name": "name_c",
66
                    "displayName": "Product Name",
67
                    "dataType": "string",
68
                    "length": 100
69
                },
70
                {
71
                    "name": "sku_c",
72
                    "displayName": "SKU",
73
                    "dataType": "string",
74
                    "length": 20
75
                },
76
                {
77
                    "name": "price_c",
78
                    "displayName": "Price",
79
                    "dataType": "float",
80
                    "length": 10
81
                },
82
                {
83
                    "name": "category_c",
84
                    "displayName": "Category",
85
                    "dataType": "string",
86
                    "length": 50
87
                }
88
            ]
89
        }
90
    ]
91
}

List lead attributes (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "quota_wait": true
6
}

Sample Output

1
{}

List lead searchable fields (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com/rest",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "result": [
3
        {
4
            "name": "firstName",
5
            "displayName": "First Name",
6
            "dataType": "string",
7
            "length": 255,
8
            "updateable": true,
9
            "searchable": true
10
        },
11
        {
12
            "name": "lastName",
13
            "displayName": "Last Name",
14
            "dataType": "string",
15
            "length": 255,
16
            "updateable": true,
17
            "searchable": true
18
        },
19
        {
20
            "name": "email",
21
            "displayName": "Email Address",
22
            "dataType": "email",
23
            "length": 255,
24
            "updateable": true,
25
            "searchable": true
26
        },
27
        {
28
            "name": "company",
29
            "displayName": "Company Name",
30
            "dataType": "string",
31
            "length": 255,
32
            "updateable": true,
33
            "searchable": true
34
        },
35
        {
36
            "name": "phone",
37
            "displayName": "Phone Number",
38
            "dataType": "phone",
39
            "length": 255,
40
            "updateable": true,
41
            "searchable": true
42
        }
43
    ],
44
    "success": true
45
}

List object fields (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4e5f6g7h8i9j0",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "fields": [
3
        {
4
            "name": "id",
5
            "displayName": "Lead ID",
6
            "dataType": "integer",
7
            "length": 10,
8
            "updateable": false,
9
            "creatable": false
10
        },
11
        {
12
            "name": "email",
13
            "displayName": "Email Address",
14
            "dataType": "string",
15
            "length": 255,
16
            "updateable": true,
17
            "creatable": true
18
        },
19
        {
20
            "name": "firstName",
21
            "displayName": "First Name",
22
            "dataType": "string",
23
            "length": 50,
24
            "updateable": true,
25
            "creatable": true
26
        },
27
        {
28
            "name": "lastName",
29
            "displayName": "Last Name",
30
            "dataType": "string",
31
            "length": 50,
32
            "updateable": true,
33
            "creatable": true
34
        },
35
        {
36
            "name": "company",
37
            "displayName": "Company",
38
            "dataType": "string",
39
            "length": 100,
40
            "updateable": true,
41
            "creatable": true
42
        }
43
    ]
44
}

List object filter types (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{}

List program member attributes (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghIJKLMnopQRSTuvwxYZ123456",
5
    "quota_wait": true
6
}

Sample Output

1
{}

List programs (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "qRsTuVwXyZ1234567890aBcDeFgHiJk",
5
    "quota_wait": true
6
}

Sample Output

1
{}

List roles (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretABCDEFGHIJKLMNOPQRSTUVWXYZ",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "roles": [
3
        {
4
            "id": 1,
5
            "name": "Administrator",
6
            "description": "Full access to all Marketo features"
7
        },
8
        {
9
            "id": 2,
10
            "name": "Marketing User",
11
            "description": "Access to marketing campaigns and lead management"
12
        },
13
        {
14
            "id": 3,
15
            "name": "Sales User",
16
            "description": "Access to lead information and sales insights"
17
        },
18
        {
19
            "id": 4,
20
            "name": "Analytics User",
21
            "description": "Access to reporting and analytics features"
22
        }
23
    ]
24
}

List users (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "client_123456789",
4
    "client_secret": "secretKey987654321",
5
    "quota_wait": true
6
}

Sample Output

1
{}

List workspaces (DDL)
Copy

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

1
{
2
    "endpoint": "https://123-ABC-456.mktorest.com",
3
    "client_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
4
    "client_secret": "ABCDEfghij1234567890",
5
    "quota_wait": true
6
}

Sample Output

1
{
2
    "success": true,
3
    "workspaces": [
4
        {
5
            "id": 1001,
6
            "name": "Marketing Workspace",
7
            "description": "Main workspace for marketing campaigns"
8
        },
9
        {
10
            "id": 1002,
11
            "name": "Sales Workspace",
12
            "description": "Workspace for sales team activities"
13
        },
14
        {
15
            "id": 1003,
16
            "name": "Product Workspace",
17
            "description": "Workspace for product team initiatives"
18
        }
19
    ]
20
}
Previous

Example use cases

Next

Operations