Skip to content

Latest commit

 

History

History
155 lines (118 loc) · 6.65 KB

API.md

File metadata and controls

155 lines (118 loc) · 6.65 KB
Raw

Implemented Marketo Endpoints

Lead

lead.byId(id, options)

Implements Get Lead by Id

param type description
id int the lead id to query for
options object fields: a comma separated list or array of fields to retrieve 
marketo.lead.byId(3).then(function (data) {
  console.log(data);
});

// Using the field attribute
marketo.lead.byId(3, { fields: ['email', 'lastName'] }).then(function (data) {
  // data.result[0]
  //
  // {
  //   email: "[email protected]",
  //   lastName: "LastName"
  // }
});

lead.find(filterType, filterValues, options)

Implements Get Multiple Leads by Filter Type

param type description
filterType string the field that we will filter on
filterValues Array/string the values that we will filter for
options object fields: a comma separated list or array of fields to retrieve
batchSize: the number of lead records to be returned (max is 300)
nextPageToken: used to paginate through large result sets 
marketo.lead.find('email', ['[email protected]', '[email protected]']);

// or
marketo.lead.find('email', '[email protected],[email protected]');

lead.createOrUpdate(input, options)

Implements Create/Update Leads

param type description
input Array An array of lead records to create or update
options object action: one of 4 valid actions (createOnly, updateOnly, ...)
lookupField: the field used to dedup on
partitionName: not sure what this does yet, :) 
// Since the action is not passed in, the default action is 'createOrUpdate'
marketo.lead.createOrUpdate(
  [{ email: '[email protected]' }, { email: '[email protected]' }],
  { lookupField: 'email' }
);

// The same query without creating new leads
marketo.lead.createOrUpdate(
  [{ email: '[email protected]' }, { email: '[email protected]' }],
  { lookupField: 'email', action: 'updateOnly' }
);

lead.push(input, options)

Implements Push Leads

param type description
input Array An array of lead records to push
options object
lookupField: the field used to dedup on
programName : the program name in Marketo 
// Push a lead to Marketo program name
marketo.lead.push([{ email: '[email protected]' }, { email: '[email protected]' }], {
  lookupField: 'email',
  programName: 'Test program name',
});

List

list.find(options)

Implements Get Multiple Lists

param type description
options object id: array of ids to filter by
name: array of names to filter by
programName: array of program names to filter by
workspaceName: array of workspaces to filter by 
// Retrieve all lists
marketo.list.find();

// Find lists with specific ids
marketo.list.find({ id: [1, 2, 3] });

// The same query using CSV instead
marketo.list.find({ id: '1,2,3' });

// Name in a specific program
marketo.list.find({
  name: ['some name'],
  workspaceName: ['Default'],
});

list.addLeadsToList(listId, input)

Implements Add Leads To List

param type description
listId int the id of the list you want to add leads to
input Array an array of lead ids to be added to the list, not CSV 
// Add leads 1, 2, and 3 to list id 1
marketo.list.addLeadsToList(1, [1, 2, 3]);

// Same thing, in object form
marketo.list.addLeadsToList(1, [{ id: 1 }, { id: 2 }, { id: 3 }]);

list.getLeads(options)

Implements Get Multiple Leads by List Id

param type description
listId int the id of the list you want to get leads
options object fields: a comma separated list or array of fields to retrieve
batchSize: the number of lead records to be returned (max is 300)
nextPageToken: used to paginate through large result sets
fields: a comma separated list or array of fields to retrieve 
// Get leads from list id 1
marketo.list.getLeads(1);