Adobe Marketo Engage 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.

The Marketo API does have fairly restrictive rate limits, so care must be taken to stay under those limits. Please see the Best Practices Documentation for more information on rate limits.

Connections

Marketo OAuth 2.0

To make API requests of Marketo on behalf of your customers you need to create a Custom Service using the Marketo Admin Portal. Follow the steps outlined in the Marketo Documentation. Be sure to note the Client ID and Client Secret values, as these will be important when using the Marketo Connection as part of your Integration.

Input	Default	Notes
Client ID string / Required clientId		Client Identifier of your app for the Marketo API
Client Secret password / Required clientSecret		Client Secret of your app for the Marketo API
Scopes string Hidden Field scopes		Scopes for the Marketo API. The value is supplied by the API based on the authenticated client.
Token URL string / Required tokenUrl	https://<ACCOUNT_ID>.mktorest.com/identity/oauth/token	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

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

Example Payload for Delete Companies

{
  "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

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

Example Payload for Delete Custom Objects

{
  "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

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

Example Payload for Delete Leads

{
  "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

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

Example Payload for Delete Named Accounts

{
  "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

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

Example Payload for Delete Opportunities

{
  "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

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

Example Payload for Delete Sales Persons

{
  "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

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

Example Payload for Describe Company

{
  "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

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

Example Payload for Describe Custom Object

{
  "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

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

Example Payload for Describe Lead

{
  "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

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

Example Payload for Describe Named Account

{
  "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

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

Example Payload for Describe Opportunities

{
  "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

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

Example Payload for Describe Sales Person

{
  "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

Input	Default	Notes
Batch Size string batchSize		The batch size to return
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fields string Value List fields		List of field names to include
Filter Type string / Required filterType		The field to filter on
Filter Values string / Required Value List filterValues		A list of values to filter on for the specified field
Next Page Token string nextPageToken		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

Example Payload for Get Companies By Filter

{
  "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

Input	Default	Notes
Batch Size string batchSize		The batch size to return
Connection connection / Required connection
Custom Object Name string / Required customObjectName		The name of the Custom Object
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fields string Value List fields		List of field names to include
Filter Type string / Required filterType		The field to filter on
Filter Values string / Required Value List filterValues		A list of values to filter on for the specified field
Next Page Token string nextPageToken		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

Example Payload for Get Custom Objects By Filter

{
  "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

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

Example Payload for Get Lead By Id

{
  "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

Input	Default	Notes
Batch Size string batchSize		The batch size to return
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fields string Value List fields		List of field names to include
Filter Type string / Required filterType		The field to filter on
Filter Values string / Required Value List filterValues		A list of values to filter on for the specified field
Next Page Token string nextPageToken		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

Example Payload for Get Leads By Filter

{
  "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

Input	Default	Notes
Batch Size string batchSize		The batch size to return
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fields string Value List fields		List of field names to include
Filter Type string / Required filterType		The field to filter on
Filter Values string / Required Value List filterValues		A list of values to filter on for the specified field
Next Page Token string nextPageToken		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

Example Payload for Get Named Accounts By Filter

{
  "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

Input	Default	Notes
Batch Size string batchSize		The batch size to return
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fields string Value List fields		List of field names to include
Filter Type string / Required filterType		The field to filter on
Filter Values string / Required Value List filterValues		A list of values to filter on for the specified field
Next Page Token string nextPageToken		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

Example Payload for Get Opportunities By Filter

{
  "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

Input	Default	Notes
Batch Size string batchSize		The batch size to return
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fields string Value List fields		List of field names to include
Filter Type string / Required filterType		The field to filter on
Filter Values string / Required Value List filterValues		A list of values to filter on for the specified field
Next Page Token string nextPageToken		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

Example Payload for Get Sales Persons By Filter

{
  "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

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

Example Payload for Get Searchable Lead Fields

{
  "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

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

Example Payload for List Custom Objects

{
  "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 HTTP request to Marketo | key: rawRequest

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

Sync Companies (Create, Update, Upsert)

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

Input	Default	Notes
Action string / Required action	createOrUpdate	Type of sync operation to perform
Companies data / Required companies		An array of Company objects to use as input for synchronization.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Dedupe Field string dedupeBy	dedupeFields	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.

Example Payload for Sync Companies (Create, Update, Upsert)

{
  "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

Input	Default	Notes
Action string / Required action	createOrUpdate	Type of sync operation to perform
Connection connection / Required connection
Custom Object Name string / Required customObjectName		The name of the Custom Object
Custom Objects data / Required customObjects		An array of Custom Objects to use as input for synchronization.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Dedupe Field string dedupeBy	dedupeFields	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.

Example Payload for Sync Custom Objects (Create, Update, Upsert)

{
  "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

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

Example Payload for Sync Leads (Create, Update, Upsert)

{
  "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

Input	Default	Notes
Action string / Required action	createOrUpdate	Type of sync operation to perform
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Dedupe Field string dedupeBy	dedupeFields	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.
Named Accounts data / Required namedAccounts		An array of Named Account objects to use as input for synchronization.

Example Payload for Sync Named Accounts (Create, Update, Upsert)

{
  "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

Input	Default	Notes
Action string / Required action	createOrUpdate	Type of sync operation to perform
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Dedupe Field string dedupeBy	dedupeFields	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.
Opportunities data / Required opportunities		An array of Opportunities objects to use as input for synchronization.

Example Payload for Sync Opportunities (Create, Update, Upsert)

{
  "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

Input	Default	Notes
Action string / Required action	createOrUpdate	Type of sync operation to perform
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Dedupe Field string dedupeBy	dedupeFields	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.
Sales Persons data / Required salesPersons		An array of Sales Person objects to use as input for synchronization.

Example Payload for Sync Sales Persons (Create, Update, Upsert)

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

Manage Marketo records

Description​

Connections​

Marketo OAuth 2.0​

Actions​

Delete Companies​

Delete Custom Objects​

Delete Leads​

Delete Named Accounts​

Delete Opportunities​

Delete Sales Persons​

Describe Company​

Describe Custom Object​

Describe Lead​

Describe Named Account​

Describe Opportunities​

Describe Sales Person​

Get Companies By Filter​

Get Custom Objects By Filter​

Get Lead By Id​

Get Leads By Filter​

Get Named Accounts By Filter​

Get Opportunities By Filter​

Get Sales Persons By Filter​

Get Searchable Lead Fields​

List Custom Objects​

Raw Request​

Sync Companies (Create, Update, Upsert)​

Sync Custom Objects (Create, Update, Upsert)​

Sync Leads (Create, Update, Upsert)​

Sync Named Accounts (Create, Update, Upsert)​

Sync Opportunities (Create, Update, Upsert)​

Sync Sales Persons (Create, Update, Upsert)​