Skip to main content

Marketo Component

Manage Marketo records

Component key: marketo

Description#

Adobe Marketo allows you to leverage rich behavioral data, built-in intelligence, and sophisticated journey flows to identify, engage, and accelerate your best opportunities to orchestrate your buyer's journeys.

Marketo Connections#

Marketo OAuth 2.0#

InputDefaultNotes
Input
Client ID
string
/ Required
clientId
Default
Notes
Client Identifier of your app for the Marketo API
Input
Client Secret
password
/ Required
clientSecret
Default
Notes
Client Secret of your app for the Marketo API
Input
Scopes
string
Hidden Field
scopes
Default
Notes
Scopes for the Marketo API. The value is supplied by the API based on the authenticated client.
Input
Token URL
string
/ Required
tokenUrl
Default
https://<ACCOUNT_ID>.mktorest.com/identity/oauth/token
Notes
The OAuth 2.0 Token URL for the Marketo API. Replace <ACCOUNT_ID> with your Account Id.

Actions#

Delete Companies#

Delete one or more Companies. | key: deleteCompanies

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Delete By
string
/ Required
deleteBy
Default
dedupeFields
Notes
The type of deletion method
Input
Ids
data
/ Required
ids
Default
Notes
An array of objects that specify the id->value mapping for objects to delete.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "id": 1234,        "status": "deleted"      },      {        "seq": 1,        "id": 56456,        "status": "deleted"      },      {        "seq": 2,        "status": "skipped",        "reasons": [          {            "code": "1013",            "message": "Record not found"          }        ]      }    ]  }}

Delete Custom Objects#

Delete one or more Custom Objects. | key: deleteCustomObjects

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Custom Object Name
string
/ Required
customObjectName
Default
Notes
The name of the Custom Object
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Delete By
string
/ Required
deleteBy
Default
dedupeFields
Notes
The type of deletion method
Input
Ids
data
/ Required
ids
Default
Notes
An array of objects that specify the id->value mapping for objects to delete.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",        "status": "deleted"      },      {        "seq": 1,        "marketoGUID": "da42707c-4dc4-4fc1-9fef-f30a3017240a",        "status": "deleted"      },      {        "seq": 2,        "status": "skipped",        "reasons": [          {            "code": "1013",            "message": "Object not found"          }        ]      }    ]  }}

Delete Leads#

Delete one or more Leads by their Marketo id. | key: deleteLeads

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Ids
string
/ Required
Value List
ids
Default
Notes
The Marketo id(s) of the record(s) to delete.

Output Example Payload#

{  "data": {    "requestId": "3608#16664333670",    "result": [      {        "id": 235,        "status": "deleted"      },      {        "id": 766,        "status": "deleted"      }    ],    "success": true  }}

Delete Named Accounts#

Delete one or more Named Accounts. | key: deleteNamedAccounts

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Delete By
string
/ Required
deleteBy
Default
dedupeFields
Notes
The type of deletion method
Input
Ids
data
/ Required
ids
Default
Notes
An array of objects that specify the id->value mapping for objects to delete.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",        "status": "deleted"      },      {        "seq": 1,        "id": "dff23271-f996-47d7-984f-f2676861b5fc",        "status": "deleted"      },      {        "seq": 2,        "status": "skipped",        "reasons": [          {            "code": "1013",            "message": "Record not found"          }        ]      }    ]  }}

Delete Opportunities#

Delete one or more Opportunities. | key: deleteOpportunities

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Delete By
string
/ Required
deleteBy
Default
dedupeFields
Notes
The type of deletion method
Input
Ids
data
/ Required
ids
Default
Notes
An array of objects that specify the id->value mapping for objects to delete.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",        "status": "deleted"      },      {        "seq": 1,        "marketoGUID": "cff23271-f996-47d7-984f-f2676861b5fb",        "status": "deleted"      }    ]  }}

Delete Sales Persons#

Delete one or more Sales Persons. | key: deleteSalesPersons

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Delete By
string
/ Required
deleteBy
Default
dedupeFields
Notes
The type of deletion method
Input
Ids
data
/ Required
ids
Default
Notes
An array of objects that specify the id->value mapping for objects to delete.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "id": 56343,        "status": "deleted"      },      {        "seq": 1,        "id": 53453,        "status": "deleted"      },      {        "seq": 2,        "status": "skipped",        "reasons": [          {            "code": "1013",            "message": "Record not found"          }        ]      }    ]  }}

Describe Company#

Returns metadata about companies and the fields available for interaction via the API. | key: describeCompany

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "success": true,    "requestId": "5847#14d44113ad7",    "result": [      {        "name": "Company",        "description": "Company object",        "createdAt": "2015-05-11T17:11:32Z",        "updatedAt": "2015-05-11T17:11:32Z",        "idField": "id",        "dedupeFields": [          "externalCompanyId"        ],        "searchableFields": [          [            "externalCompanyId"          ],          [            "id"          ],          [            "company"          ]        ],        "fields": [          {            "name": "createdAt",            "displayName": "Created At",            "dataType": "datetime",            "updateable": false          },          {            "name": "externalCompanyId",            "displayName": "External Company Id",            "dataType": "string",            "length": 100,            "updateable": false          },          {            "name": "id",            "displayName": "Id",            "dataType": "integer",            "updateable": false          },          {            "name": "updatedAt",            "displayName": "Updated At",            "dataType": "datetime",            "updateable": false          },          {            "name": "annualRevenue",            "displayName": "Annual Revenue",            "dataType": "currency",            "updateable": true          },          {            "name": "company",            "displayName": "Company Name",            "dataType": "string",            "length": 255,            "updateable": true          }        ]      }    ]  }}

Describe Custom Object#

Returns metadata regarding a given custom object. | key: describeCustomObject

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Custom Object Name
string
/ Required
customObjectName
Default
Notes
The name of the Custom Object
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "requestId": "185d6#14b51985ff0",    "success": true,    "result": [      {        "name": "Car",        "displayName": "Car",        "description": "Car owner",        "createdAt": "2015-02-03T22:36:23Z",        "updatedAt": "2015-02-03T22:36:24Z",        "idField": "marketoGUID",        "dedupeFields": [          "vin"        ],        "searchableFields": [          [            "vin"          ],          [            "marketoGUID"          ],          [            "siebelId"          ]        ],        "relationships": [          {            "field": "siebelId",            "type": "parent",            "object": {              "name": "Lead",              "field": "siebelId"            }          }        ],        "fields": [          {            "name": "marketoGUID",            "displayName": "Marketo GUID",            "dataType": "string",            "length": 36,            "updateable": false          },          {            "name": "createdAt",            "displayName": "Created At",            "dataType": "datetime",            "updateable": false          },          {            "name": "updatedAt",            "displayName": "Updated At",            "dataType": "datetime",            "updateable": false          },          {            "name": "vin",            "displayName": "VIN",            "description": "Vehicle Identification Number",            "dataType": "string",            "length": 36,            "updateable": false          },          {            "name": "siebelId",            "displayName": "External Id",            "description": "External Id",            "dataType": "string",            "length": 36,            "updateable": true          },          {            "name": "make",            "displayName": "Make",            "dataType": "string",            "length": 36,            "updateable": true          },          {            "name": "model",            "displayName": "Model",            "description": "Vehicle Model",            "dataType": "string",            "length": 255,            "updateable": true          },          {            "name": "year",            "displayName": "Year",            "dataType": "integer",            "updateable": true          },          {            "name": "color",            "displayName": "Color",            "description": "Vehicle color",            "dataType": "String",            "length": 255,            "updateable": true          }        ]      }    ]  }}

Describe Lead#

Returns metadata about lead objects in the target instance, including a list of all fields available for interaction via the APIs. | key: describeLead

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "requestId": "37ca#1475b74e276",    "success": true,    "result": [      {        "id": 2,        "displayName": "Company Name",        "dataType": "string",        "length": 255,        "rest": {          "name": "company",          "readOnly": false        },        "soap": {          "name": "Company",          "readOnly": false        }      }    ]  }}

Describe Named Account#

Returns metadata about Named Accounts and the fields available for interaction via the API. | key: describeNamedAccount

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "requestId": "d65e#156c27ac57d",    "result": [      {        "name": "Named Account",        "description": "Marketo standard account attribute map",        "createdAt": "2016-08-18T20:16:41Z",        "updatedAt": "2016-08-18T20:16:41Z",        "idField": "marketoGUID",        "dedupeFields": [          "name"        ],        "searchableFields": [          [            "marketoGUID"          ],          [            "annualRevenue"          ],          [            "city"          ],          [            "country"          ],          [            "domainName"          ],          [            "industry"          ],          [            "logoUrl"          ],          [            "membershipCount"          ],          [            "name"          ],          [            "numberOfEmployees"          ],          [            "opptyAmount"          ],          [            "opptyCount"          ],          [            "score1"          ],          [            "score2"          ],          [            "score3"          ],          [            "score4"          ],          [            "score5"          ],          [            "sicCode"          ],          [            "state"          ]        ],        "fields": [          {            "name": "marketoGUID",            "displayName": "Marketo GUID",            "dataType": "string",            "length": 36,            "updateable": false          },          {            "name": "annualRevenue",            "displayName": "annualRevenue",            "dataType": "currency",            "updateable": true          },          {            "name": "city",            "displayName": "city",            "dataType": "string",            "length": 255,            "updateable": true          },          {            "name": "country",            "displayName": "country",            "dataType": "string",            "length": 255,            "updateable": true          }        ]      }    ],    "success": true  }}

Describe Opportunities#

Returns metadata about Opportunities and the fields available for interaction via the API. | key: describeOpportunities

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "requestId": "185d6#14b51985ff0",    "success": true,    "result": [      {        "name": "opportunity",        "displayName": "Opportunity",        "createdAt": "2015-02-03T22:36:23Z",        "updatedAt": "2015-02-03T22:36:24Z",        "idField": "marketoGUID",        "dedupeFields": [          "externalOpportunityId"        ],        "searchableFields": [          [            "externalOpportunityId"          ],          [            "marketoGUID"          ]        ],        "fields": [          {            "name": "marketoGUID",            "displayName": "Marketo GUID",            "dataType": "string",            "length": 36,            "updateable": false          },          {            "name": "createdAt",            "displayName": "Created At",            "dataType": "datetime",            "updateable": false          },          {            "name": "updatedAt",            "displayName": "Updated At",            "dataType": "datetime",            "updateable": false          },          {            "name": "externalOpportunityId",            "displayName": "External Opportunity Id",            "dataType": "string",            "length": 50,            "updateable": false          }        ]      }    ]  }}

Describe Sales Person#

Returns metadata about Sales Persons and the fields available for interaction via the API. | key: describeSalesPerson

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "requestId": "185d6#14b51985ff0",    "success": true,    "result": [      {        "name": "SalesPerson",        "createdAt": "2015-02-03T22:36:23Z",        "updatedAt": "2015-02-03T22:36:24Z",        "idField": "id",        "dedupeFields": [          "externalSalesPersonId"        ],        "searchableFields": [          [            "email"          ],          [            "id"          ],          [            "externalSalesPersonId"          ]        ],        "fields": [          {            "name": "id",            "displayName": "Marketo Id",            "dataType": "integer",            "updateable": false          },          {            "name": "createdAt",            "displayName": "Created At",            "dataType": "datetime",            "updateable": false          },          {            "name": "updatedAt",            "displayName": "Updated At",            "dataType": "datetime",            "updateable": false          },          {            "name": "email",            "displayName": "Email",            "dataType": "string",            "length": 255,            "updateable": false          },          {            "name": "externalSalesPersonId",            "displayName": "External Sales Person Id",            "dataType": "string",            "length": 255,            "updateable": false          }        ]      }    ]  }}

Get Companies By Filter#

Retrieves company records from the destination instance based on the submitted filter. | key: getCompaniesByFilter

InputDefaultNotes
Input
Batch Size
string
batchSize
Default
Notes
The batch size to return
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Fields
string
Value List
fields
Default
Notes
List of field names to include
Input
Filter Type
string
/ Required
filterType
Default
Notes
The field to filter on
Input
Filter Values
string
/ Required
Value List
filterValues
Default
Notes
A list of values to filter on for the specified field
Input
Next Page Token
string
nextPageToken
Default
Notes
A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "id": 3433,        "externalCompanyId": "19UYA31581L000000",        "company": "Google"      },      {        "seq": 1,        "id": 5345,        "externalCompanyId": "29UYA31581L000000",        "company": "Yahoo"      }    ]  }}

Get Custom Objects By Filter#

Retrieves a list of custom objects records based on filter and set of values. | key: getCustomObjectsByFilter

InputDefaultNotes
Input
Batch Size
string
batchSize
Default
Notes
The batch size to return
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Custom Object Name
string
/ Required
customObjectName
Default
Notes
The name of the Custom Object
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Fields
string
Value List
fields
Default
Notes
List of field names to include
Input
Filter Type
string
/ Required
filterType
Default
Notes
The field to filter on
Input
Filter Values
string
/ Required
Value List
filterValues
Default
Notes
A list of values to filter on for the specified field
Input
Next Page Token
string
nextPageToken
Default
Notes
A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter

Output Example Payload#

{  "data": {    "requestId": "12951#15699db5c97",    "result": [      {        "id": 318581,        "updatedAt": "2016-05-17T22:11:45Z",        "lastName": "Lincoln",        "email": "abe@usa.gov",        "createdAt": "2015-03-17T00:18:40Z",        "firstName": "Abraham"      },      {        "id": 318592,        "updatedAt": "2016-05-17T22:20:51Z",        "lastName": "Washington",        "email": "george@usa.gov",        "createdAt": "2015-04-06T16:29:21Z",        "firstName": "George"      }    ],    "success": true  }}

Get Lead By Id#

Retrieves a single lead record through its Marketo id. | key: getLeadById

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Fields
string
Value List
fields
Default
Notes
List of field names to include
Input
Lead Id
string
/ Required
leadId
Default
Notes
The Marketo lead id

Output Example Payload#

{  "data": {    "requestId": "10226#14d3049e51b",    "success": true,    "result": [      {        "id": 318581,        "updatedAt": "2015-05-07T11:47:30-08:00",        "lastName": "Doe",        "email": "jdoe@marketo.com",        "createdAt": "2015-05-01T16:47:30-08:00",        "firstName": "John"      }    ]  }}

Get Leads By Filter#

Returns a list of up to 300 leads based on a list of values in a particular field. | key: getLeadsByFilter

InputDefaultNotes
Input
Batch Size
string
batchSize
Default
Notes
The batch size to return
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Fields
string
Value List
fields
Default
Notes
List of field names to include
Input
Filter Type
string
/ Required
filterType
Default
Notes
The field to filter on
Input
Filter Values
string
/ Required
Value List
filterValues
Default
Notes
A list of values to filter on for the specified field
Input
Next Page Token
string
nextPageToken
Default
Notes
A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter

Output Example Payload#

{  "data": {    "requestId": "12951#15699db5c97",    "result": [      {        "id": 318581,        "updatedAt": "2016-05-17T22:11:45Z",        "lastName": "Lincoln",        "email": "abe@usa.gov",        "createdAt": "2015-03-17T00:18:40Z",        "firstName": "Abraham"      },      {        "id": 318592,        "updatedAt": "2016-05-17T22:20:51Z",        "lastName": "Washington",        "email": "george@usa.gov",        "createdAt": "2015-04-06T16:29:21Z",        "firstName": "George"      }    ],    "success": true  }}

Get Named Accounts By Filter#

Retrieves Named Account records from the destination instance based on the submitted filter. | key: getNamedAccountsByFilter

InputDefaultNotes
Input
Batch Size
string
batchSize
Default
Notes
The batch size to return
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Fields
string
Value List
fields
Default
Notes
List of field names to include
Input
Filter Type
string
/ Required
filterType
Default
Notes
The field to filter on
Input
Filter Values
string
/ Required
Value List
filterValues
Default
Notes
A list of values to filter on for the specified field
Input
Next Page Token
string
nextPageToken
Default
Notes
A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter

Output Example Payload#

{  "data": {    "requestId": "6dac#157d4ddc9d7",    "result": [      {        "seq": 0,        "marketoGUID": "16efafdd-0148-4ea7-8782-f451d7c6345d",        "createdAt": "2016-10-17T22:49:04Z",        "name": "Google",        "updatedAt": "2016-10-17T22:49:04Z"      },      {        "seq": 1,        "marketoGUID": "44d62353-7f9d-4d43-b9cc-7ef0f7a09137",        "createdAt": "2016-10-17T22:49:04Z",        "name": "Yahoo",        "updatedAt": "2016-10-17T22:49:04Z"      }    ],    "success": true  }}

Get Opportunities By Filter#

Retrieves Opportunity records from the destination instance based on the submitted filter. | key: getOpportunitiesByFilter

InputDefaultNotes
Input
Batch Size
string
batchSize
Default
Notes
The batch size to return
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Fields
string
Value List
fields
Default
Notes
List of field names to include
Input
Filter Type
string
/ Required
filterType
Default
Notes
The field to filter on
Input
Filter Values
string
/ Required
Value List
filterValues
Default
Notes
A list of values to filter on for the specified field
Input
Next Page Token
string
nextPageToken
Default
Notes
A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fa ",        "externalOpportunityId": "19UYA31581L000000",        "name": "Chairs",        "description": "Chairs",        "amount": "1604.47",        "source": "Inbound Sales Call/Email"      },      {        "seq": 1,        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc ",        "externalOpportunityId": "29UYA31581L000000",        "name": "Big Dog Day Care-Phase12",        "description": "Big Dog Day Care-Phase12",        "amount": "1604.47",        "source": "Email"      }    ]  }}

Get Sales Persons By Filter#

Retrieves Sales Person records from the destination instance based on the submitted filter. | key: getSalesPersonsByFilter

InputDefaultNotes
Input
Batch Size
string
batchSize
Default
Notes
The batch size to return
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Fields
string
Value List
fields
Default
Notes
List of field names to include
Input
Filter Type
string
/ Required
filterType
Default
Notes
The field to filter on
Input
Filter Values
string
/ Required
Value List
filterValues
Default
Notes
A list of values to filter on for the specified field
Input
Next Page Token
string
nextPageToken
Default
Notes
A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "id": 53453,        "externalSalesPersonId": "sam@test.com",        "createdAt": "2015-02-03T22:36:23Z",        "updatedAt": "2015-02-03T22:36:23Z"      },      {        "seq": 1,        "id": 53454,        "externalSalesPersonId": "david@test.com",        "createdAt": "2015-02-03T22:36:23Z",        "updatedAt": "2015-02-03T22:36:23Z"      }    ]  }}

Get Searchable Lead Fields#

Returns list of searchable fields on lead objects in the target instance. | key: getSearchableLeadFields

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "requestId": "string",    "result": [      {        "name": "string",        "searchableFields": [          [            "string"          ]        ],        "fields": [          {            "name": "string",            "displayName": "string",            "dataType": "string",            "length": 0,            "updateable": true,            "crmManaged": true          }        ]      }    ]  }}

List Custom Objects#

Returns a list of Custom Object types available in the target instance, along with id and deduplication information for each type. | key: listCustomObjects

InputDefaultNotes
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.

Output Example Payload#

{  "data": {    "requestId": "185d6#14b51985ff0",    "success": true,    "result": [      {        "name": "Car",        "displayName": "Car",        "description": "Car owner",        "createdAt": "2015-02-03T22:36:23Z",        "updatedAt": "2015-02-03T22:36:24Z",        "idField": "marketoGUID",        "dedupeFields": [          "vin"        ],        "searchableFields": [          [            "vin"          ],          [            "marketoGUID"          ],          [            "siebelId"          ]        ],        "relationships": [          {            "field": "siebelId",            "type": "parent",            "relatedTo": {              "name": "Lead",              "field": "siebelId"            }          }        ]      }    ]  }}

Raw Request#

Send Raw Request to Marketo | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Example
 
Input
Data
string
data
Default
Notes
The HTTP body payload to send to the URL.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
fileData
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
formData
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
headers
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
maxRetries
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
method
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
queryParams
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
/ Required
responseType
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
retryAllErrors
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
retryDelayMS
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
timeout
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
url
Default
Notes
This is the URL to call.
Example
/v1/leads.json
Input
Use Exponential Backoff
boolean
useExponentialBackoff
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Sync Companies (Create, Update, Upsert)#

Allows inserting, updating, or upserting of company records into Marketo. | key: syncCompanies

InputDefaultNotes
Input
Action
string
/ Required
action
Default
createOrUpdate
Notes
Type of sync operation to perform
Input
Companies
data
/ Required
companies
Default
Notes
An array of Company objects to use as input for synchronization.
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Dedupe Field
string
dedupeBy
Default
dedupeFields
Notes
Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "status": "updated",        "id": 1232      },      {        "seq": 1,        "status": "created",        "id": 1323      }    ]  }}

Sync Custom Objects (Create, Update, Upsert)#

Inserts, updates, or upserts custom object records to the target instance. | key: syncCustomObjects

InputDefaultNotes
Input
Action
string
/ Required
action
Default
createOrUpdate
Notes
Type of sync operation to perform
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Custom Object Name
string
/ Required
customObjectName
Default
Notes
The name of the Custom Object
Input
Custom Objects
data
/ Required
customObjects
Default
Notes
An array of Custom Objects to use as input for synchronization.
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Dedupe Field
string
dedupeBy
Default
dedupeFields
Notes
Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "status": "updated",        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"      },      {        "seq": 1,        "status": "created",        "marketoGUID": "cff23271-f996-47d7-984f-f2676861b5fb"      },      {        "seq": 2,        "status": "skipped",        "reasons": [          {            "code": "1004",            "message": "Lead not found"          }        ]      }    ]  }}

Sync Leads (Create, Update, Upsert)#

Syncs a list of leads to the target instance. | key: syncLeads

InputDefaultNotes
Input
Action
string
/ Required
action
Default
createOrUpdate
Notes
Type of sync operation to perform
Input
Async Processing
boolean
asyncProcessing
Default
false
Notes
If set to true, the call will return immediately
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Leads
data
/ Required
leads
Default
Notes
An array of Lead objects to use as input for synchronization.
Input
Lookup Field
string
lookupField
Default
email
Notes
Field to deduplicate on. The field must be present in each lead record of the input. Defaults to email if unset.
Input
Partition Name
string
partitionName
Default
Notes
Name of the partition to operate on, if applicable. Should be set whenever possible, when interacting with an instance where partitions are enabled.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "id": 50,        "status": "created"      },      {        "id": 51,        "status": "created"      },      {        "id": 52,        "status": "created"      }    ]  }}

Sync Named Accounts (Create, Update, Upsert)#

Allows inserts, updates, or upserts of Named Accounts to the target instance. | key: syncNamedAccounts

InputDefaultNotes
Input
Action
string
/ Required
action
Default
createOrUpdate
Notes
Type of sync operation to perform
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Dedupe Field
string
dedupeBy
Default
dedupeFields
Notes
Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.
Input
Named Accounts
data
/ Required
namedAccounts
Default
Notes
An array of Named Account objects to use as input for synchronization.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "status": "updated",        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"      },      {        "seq": 1,        "status": "created",        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc"      }    ]  }}

Sync Opportunities (Create, Update, Upsert)#

Allows inserts, updates, or upserts of Opportunities to the target instance. | key: syncOpportunities

InputDefaultNotes
Input
Action
string
/ Required
action
Default
createOrUpdate
Notes
Type of sync operation to perform
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Dedupe Field
string
dedupeBy
Default
dedupeFields
Notes
Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.
Input
Opportunities
data
/ Required
opportunities
Default
Notes
An array of Opportunities objects to use as input for synchronization.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "status": "updated",        "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"      },      {        "seq": 1,        "status": "created",        "marketoGUID": "cff23271-f996-47d7-984f-f2676861b5fb"      }    ]  }}

Sync Sales Persons (Create, Update, Upsert)#

Allows inserts, updates, or upserts of Sales Persons to the target instance. | key: syncSalesPersons

InputDefaultNotes
Input
Action
string
/ Required
action
Default
createOrUpdate
Notes
Type of sync operation to perform
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Input
Dedupe Field
string
dedupeBy
Default
dedupeFields
Notes
Field to deduplicate on. If the value in the field for a given record is not unique, an error will be returned for the individual record.
Input
Sales Persons
data
/ Required
salesPersons
Default
Notes
An array of Sales Person objects to use as input for synchronization.

Output Example Payload#

{  "data": {    "requestId": "e42b#14272d07d78",    "success": true,    "result": [      {        "seq": 0,        "status": "updated",        "id": 45232      },      {        "seq": 1,        "status": "created",        "id": 45236      }    ]  }}