# Adobe Marketo Engage Component

![](/docs/img/components/icons/60/bWFya2V0bw==.png)

#### Manage Marketo records

Component key: **marketo**

[Changelog ↓](#changelog)

## Description[​](#description "Direct link to Description")

[Adobe Marketo](https://www.marketo.com/) 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](https://developers.marketo.com/rest-api/marketo-integration-best-practices/) for more information on rate limits.

## Connections[​](#connections "Direct link to Connections")

### Marketo OAuth 2.0[​](#oauth2 "Direct link to Marketo OAuth 2.0")

**key: oauth2**

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](https://developers.marketo.com/rest-api/authentication/). 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         | Notes                                                                                           | Example                                                   |
| ------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| Client ID     | Client Identifier of your app for the Marketo API                                               |                                                           |
| Client Secret | Client Secret of your app for the Marketo API                                                   |                                                           |
| Scopes        | Scopes for the Marketo API. The value is supplied by the API based on the authenticated client. |                                                           |
| Token URL     | The OAuth 2.0 Token URL for the Marketo API. Replace \<ACCOUNT\_ID> with your Account Id.       | https\://\<ACCOUNT\_ID>.mktorest.com/identity/oauth/token |

## Data Sources[​](#data-sources "Direct link to Data Sources")

### Select Company[​](#selectcompany "Direct link to Select Company")

Select a Company from a dropdown menu. | **key: selectCompany** | **type: picklist**

| Input         | Notes                                                 | Example                |
| ------------- | ----------------------------------------------------- | ---------------------- |
| Connection    |                                                       |                        |
| Filter Query  | Filter results by matching this text.                 | Some text to filter by |
| Filter Type   | The field to filter on                                |                        |
| Filter Values | A list of values to filter on for the specified field |                        |

***

### Select Lead[​](#selectlead "Direct link to Select Lead")

Select a Lead field from a dropdown menu. | **key: selectLead** | **type: picklist**

| Input        | Notes                                 | Example                |
| ------------ | ------------------------------------- | ---------------------- |
| Connection   |                                       |                        |
| Filter Query | Filter results by matching this text. | Some text to filter by |

***

## Actions[​](#actions "Direct link to Actions")

### Delete Companies[​](#deletecompanies "Direct link to Delete Companies")

Delete one or more Companies. | **key: deleteCompanies**

| Input      | Notes                                                                         | Example      |
| ---------- | ----------------------------------------------------------------------------- | ------------ |
| Connection |                                                                               |              |
| Delete By  | The type of deletion method                                                   | dedupeFields |
| Ids        | An array of objects that specify the id->value mapping for objects to delete. |              |

### Example Payload for <!-- -->Delete Companies

```json
{
  "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[​](#deletecustomobjects "Direct link to Delete Custom Objects")

Delete one or more Custom Objects. | **key: deleteCustomObjects**

| Input              | Notes                                                                         | Example      |
| ------------------ | ----------------------------------------------------------------------------- | ------------ |
| Connection         |                                                                               |              |
| Custom Object Name | The name of the Custom Object                                                 |              |
| Delete By          | The type of deletion method                                                   | dedupeFields |
| Ids                | An array of objects that specify the id->value mapping for objects to delete. |              |

### Example Payload for <!-- -->Delete Custom Objects

```json
{
  "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[​](#deleteleads "Direct link to Delete Leads")

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

| Input      | Notes                                         | Example |
| ---------- | --------------------------------------------- | ------- |
| Connection |                                               |         |
| Ids        | The Marketo id(s) of the record(s) to delete. |         |

### Example Payload for <!-- -->Delete Leads

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

```

***

### Delete Named Accounts[​](#deletenamedaccounts "Direct link to Delete Named Accounts")

Delete one or more Named Accounts. | **key: deleteNamedAccounts**

| Input      | Notes                                                                         | Example      |
| ---------- | ----------------------------------------------------------------------------- | ------------ |
| Connection |                                                                               |              |
| Delete By  | The type of deletion method                                                   | dedupeFields |
| Ids        | An array of objects that specify the id->value mapping for objects to delete. |              |

### Example Payload for <!-- -->Delete Named Accounts

```json
{
  "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[​](#deleteopportunities "Direct link to Delete Opportunities")

Delete one or more Opportunities. | **key: deleteOpportunities**

| Input      | Notes                                                                         | Example      |
| ---------- | ----------------------------------------------------------------------------- | ------------ |
| Connection |                                                                               |              |
| Delete By  | The type of deletion method                                                   | dedupeFields |
| Ids        | An array of objects that specify the id->value mapping for objects to delete. |              |

### Example Payload for <!-- -->Delete Opportunities

```json
{
  "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[​](#deletesalespersons "Direct link to Delete Sales Persons")

Delete one or more Sales Persons. | **key: deleteSalesPersons**

| Input      | Notes                                                                         | Example      |
| ---------- | ----------------------------------------------------------------------------- | ------------ |
| Connection |                                                                               |              |
| Delete By  | The type of deletion method                                                   | dedupeFields |
| Ids        | An array of objects that specify the id->value mapping for objects to delete. |              |

### Example Payload for <!-- -->Delete Sales Persons

```json
{
  "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[​](#describecompany "Direct link to Describe Company")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->Describe Company

```json
{
  "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[​](#describecustomobject "Direct link to Describe Custom Object")

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

| Input              | Notes                         | Example |
| ------------------ | ----------------------------- | ------- |
| Connection         |                               |         |
| Custom Object Name | The name of the Custom Object |         |

### Example Payload for <!-- -->Describe Custom Object

```json
{
  "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[​](#describelead "Direct link to 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      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->Describe Lead

```json
{
  "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[​](#describenamedaccount "Direct link to Describe Named Account")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->Describe Named Account

```json
{
  "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[​](#describeopportunities "Direct link to Describe Opportunities")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->Describe Opportunities

```json
{
  "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[​](#describesalesperson "Direct link to Describe Sales Person")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->Describe Sales Person

```json
{
  "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[​](#getcompaniesbyfilter "Direct link to Get Companies By Filter")

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

| Input           | Notes                                                                                                                                                    | Example |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Batch Size      | The batch size to return                                                                                                                                 |         |
| Connection      |                                                                                                                                                          |         |
| Fetch All       | Whether to fetch all records or just the first page.                                                                                                     | false   |
| Fields          | List of field names to include                                                                                                                           |         |
| Filter Type     | The field to filter on                                                                                                                                   |         |
| Filter Values   | A list of values to filter on for the specified field                                                                                                    |         |
| Next Page Token | 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

```json
{
  "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[​](#getcustomobjectsbyfilter "Direct link to Get Custom Objects By Filter")

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

| Input              | Notes                                                                                                                                                    | Example |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Batch Size         | The batch size to return                                                                                                                                 |         |
| Connection         |                                                                                                                                                          |         |
| Custom Object Name | The name of the Custom Object                                                                                                                            |         |
| Fields             | List of field names to include                                                                                                                           |         |
| Filter Type        | The field to filter on                                                                                                                                   |         |
| Filter Values      | A list of values to filter on for the specified field                                                                                                    |         |
| Next Page Token    | 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

```json
{
  "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[​](#getleadbyid "Direct link to Get Lead By Id")

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

| Input      | Notes                          | Example |
| ---------- | ------------------------------ | ------- |
| Connection |                                |         |
| Fields     | List of field names to include |         |
| Lead Id    | The Marketo lead id.           |         |

### Example Payload for <!-- -->Get Lead By Id

```json
{
  "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[​](#getleadsbyfilter "Direct link to 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           | Notes                                                                                                                                                    | Example |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Batch Size      | The batch size to return                                                                                                                                 |         |
| Connection      |                                                                                                                                                          |         |
| Fields          | List of field names to include                                                                                                                           |         |
| Filter Type     | The field to filter on                                                                                                                                   |         |
| Filter Values   | A list of values to filter on for the specified field                                                                                                    |         |
| Next Page Token | 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

```json
{
  "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[​](#getnamedaccountsbyfilter "Direct link to Get Named Accounts By Filter")

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

| Input           | Notes                                                                                                                                                    | Example |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Batch Size      | The batch size to return                                                                                                                                 |         |
| Connection      |                                                                                                                                                          |         |
| Fields          | List of field names to include                                                                                                                           |         |
| Filter Type     | The field to filter on                                                                                                                                   |         |
| Filter Values   | A list of values to filter on for the specified field                                                                                                    |         |
| Next Page Token | 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

```json
{
  "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[​](#getopportunitiesbyfilter "Direct link to Get Opportunities By Filter")

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

| Input           | Notes                                                                                                                                                    | Example |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Batch Size      | The batch size to return                                                                                                                                 |         |
| Connection      |                                                                                                                                                          |         |
| Fields          | List of field names to include                                                                                                                           |         |
| Filter Type     | The field to filter on                                                                                                                                   |         |
| Filter Values   | A list of values to filter on for the specified field                                                                                                    |         |
| Next Page Token | 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

```json
{
  "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[​](#getsalespersonsbyfilter "Direct link to Get Sales Persons By Filter")

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

| Input           | Notes                                                                                                                                                    | Example |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Batch Size      | The batch size to return                                                                                                                                 |         |
| Connection      |                                                                                                                                                          |         |
| Fields          | List of field names to include                                                                                                                           |         |
| Filter Type     | The field to filter on                                                                                                                                   |         |
| Filter Values   | A list of values to filter on for the specified field                                                                                                    |         |
| Next Page Token | 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

```json
{
  "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[​](#getsearchableleadfields "Direct link to Get Searchable Lead Fields")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->Get Searchable Lead Fields

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

```

***

### List Custom Objects[​](#listcustomobjects "Direct link to 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      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->List Custom Objects

```json
{
  "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[​](#rawrequest "Direct link to Raw Request")

Send raw HTTP request to Marketo | **key: rawRequest**

| Input                   | Notes                                                                                                                                                                                            | Example                                                       |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- |
| Connection              |                                                                                                                                                                                                  |                                                               |
| Data                    | The HTTP body payload to send to the URL.                                                                                                                                                        | {"exampleKey": "Example Data"}                                |
| File Data               | File Data to be sent as a multipart form upload.                                                                                                                                                 | \[{key: "example.txt", value: "My File Contents"}]            |
| File Data File Names    | File names to apply to the file data inputs. Keys must match the file data keys above.                                                                                                           |                                                               |
| Form Data               | The Form Data to be sent as a multipart form upload.                                                                                                                                             | \[{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header                  | A list of headers to send with the request.                                                                                                                                                      | User-Agent: curl/7.64.1                                       |
| Max Retry Count         | The maximum number of retries to attempt. Specify 0 for no retries.                                                                                                                              | 0                                                             |
| Method                  | The HTTP method to use.                                                                                                                                                                          |                                                               |
| Query Parameter         | 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           | The type of data you expect in the response. You can request json, text, or binary data.                                                                                                         | json                                                          |
| Retry On All Errors     | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false                                                         |
| Retry Delay (ms)        | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.                                                                                              | 0                                                             |
| Timeout                 | The maximum time that a client will await a response to its request                                                                                                                              | 2000                                                          |
| URL                     | This is the URL to call.                                                                                                                                                                         | /v1/leads.json                                                |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.                                                                    | false                                                         |

***

### Sync Companies (Create, Update, Upsert)[​](#synccompanies "Direct link to Sync Companies (Create, Update, Upsert)")

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

| Input        | Notes                                                                                                                                     | Example        |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Action       | Type of sync operation to perform                                                                                                         | createOrUpdate |
| Companies    | An array of Company objects to use as input for synchronization.                                                                          |                |
| Connection   |                                                                                                                                           |                |
| Dedupe Field | 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. | dedupeFields   |

### Example Payload for <!-- -->Sync Companies (Create, Update, Upsert)

```json
{
  "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)[​](#synccustomobjects "Direct link to Sync Custom Objects (Create, Update, Upsert)")

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

| Input              | Notes                                                                                                                                     | Example        |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Action             | Type of sync operation to perform                                                                                                         | createOrUpdate |
| Connection         |                                                                                                                                           |                |
| Custom Object Name | The name of the Custom Object                                                                                                             |                |
| Custom Objects     | An array of Custom Objects to use as input for synchronization.                                                                           |                |
| Dedupe Field       | 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. | dedupeFields   |

### Example Payload for <!-- -->Sync Custom Objects (Create, Update, Upsert)

```json
{
  "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)[​](#syncleads "Direct link to Sync Leads (Create, Update, Upsert)")

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

| Input            | Notes                                                                                                                                                | Example        |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Action           | Type of sync operation to perform                                                                                                                    | createOrUpdate |
| Async Processing | If set to true, the call will return immediately                                                                                                     | false          |
| Connection       |                                                                                                                                                      |                |
| Leads            | An array of Lead objects to use as input for synchronization.                                                                                        |                |
| Lookup Field     | Field to deduplicate on. The field must be present in each lead record of the input. Defaults to email if unset.                                     | email          |
| Partition Name   | 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)

```json
{
  "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)[​](#syncnamedaccounts "Direct link to Sync Named Accounts (Create, Update, Upsert)")

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

| Input          | Notes                                                                                                                                     | Example        |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Action         | Type of sync operation to perform                                                                                                         | createOrUpdate |
| Connection     |                                                                                                                                           |                |
| Dedupe Field   | 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. | dedupeFields   |
| Named Accounts | An array of Named Account objects to use as input for synchronization.                                                                    |                |

### Example Payload for <!-- -->Sync Named Accounts (Create, Update, Upsert)

```json
{
  "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)[​](#syncopportunities "Direct link to Sync Opportunities (Create, Update, Upsert)")

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

| Input         | Notes                                                                                                                                     | Example        |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Action        | Type of sync operation to perform                                                                                                         | createOrUpdate |
| Connection    |                                                                                                                                           |                |
| Dedupe Field  | 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. | dedupeFields   |
| Opportunities | An array of Opportunities objects to use as input for synchronization.                                                                    |                |

### Example Payload for <!-- -->Sync Opportunities (Create, Update, Upsert)

```json
{
  "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)[​](#syncsalespersons "Direct link to Sync Sales Persons (Create, Update, Upsert)")

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

| Input         | Notes                                                                                                                                     | Example        |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Action        | Type of sync operation to perform                                                                                                         | createOrUpdate |
| Connection    |                                                                                                                                           |                |
| Dedupe Field  | 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. | dedupeFields   |
| Sales Persons | An array of Sales Person objects to use as input for synchronization.                                                                     |                |

### Example Payload for <!-- -->Sync Sales Persons (Create, Update, Upsert)

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

```

***

## Changelog[​](#changelog "Direct link to Changelog")

### 2025-10-21[​](#2025-10-21 "Direct link to 2025-10-21")

Added inline data sources for companies and leads to enhance data selection capabilities