marketo op update leads

Update Marketo Lead Information

Version: 17.07

Supported Since: 17.07

Update Marketo Lead Information connector operation provides the facilities to perform altering operations of Marketo Leads such as pushing a new lead, deleting existing leads, merging leads, updating partitions and updating program status. This connector operation provides the following sub operations.

All these operations require Read-Write Lead permission from Marketo API.

Sync Leads

Sync Leads operation can be used to sync a list of leads to the target instance.

Parameters

This operation does not have any configurable parameters

Request

This operation expects the request message to contain the information of the Leads to be synced as a JSON payload of the following format.

{
  "action": "createOnly",
  "asyncProcessing": false,
  "input": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "lookupField": "string",
  "partitionCode": "string",
  "partitionName": "string"
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Push new Lead

Push new Lead operation can be used to upsert a lead, and generate a Push to Marketo activity.

Parameters

This operation does not have any configurable parameters

Request

This operation expects the request message to contain the information of the Lead to be pushed as a JSON payload of the following format.

{
  "input": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "lookupField": "string",
  "partitionName": "string",
  "programName": "string",
  "programStatus": "string",
  "reason": "string",
  "source": "string"
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Delete Leads

Delete Leads operation can be used to delete a list of leads from the destination instance.

Parameters

* marked fields are mandatory

Define IDs in URL

Basic

If this is set to true, the lead IDs to be deleted will be defined as a URL query parameter, or else they are expected to be included in the payload (refer Request section). The default value is false.

Lead IDs *

Basic
This parameter is only applicable if Define IDs in URL parameter is set to true.

A comma-separated list that contains the IDs of the Leads to be deleted. This can be specified as a constant value or as a combination of placeholder expressions.

Request

If the Define IDs in URL parameter is set to false, the request message is expected to contain the Lead IDs in a JSON payload of the following format.

{
  "input": [
    {
      "id": 0
    }
  ]
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Associate Lead

Associate Lead operation can be used to associate a known Marketo lead record to a munchkin cookie and its associated web activity history.

Parameters

* marked fields are mandatory

ID to be associated *

Basic

The ID of the lead to be associated. This should be a long value and can be specified as a constant value or as a combination of placeholder expressions.

Cookie to be associated *

Basic

The munchkin cookie value to associate. This can be specified as a constant value or as a combination of placeholder expressions.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "nextPageToken": "string",
  "requestId": "string",
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Merge Leads

Merge Leads operation can be used to merge two or more known lead records into a single lead record.

Parameters

* marked fields are mandatory

Winning Lead ID *

Basic

The ID of the winning Lead record. This should be a long value and can be specified as a constant value or as a combination of placeholder expressions.

Losing Lead IDs *

Basic

A comma-separated list of losing Lead IDs. These IDs should be long values and can be specified as a constant value or as a combination of placeholder expressions.

Merge in CRM

Basic

If this is set to true, will attempt to merge the designated records in a natively-synced CRM. Only valid for instances which are natively synced to SFDC. The default value is false.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "nextPageToken": "string",
  "requestId": "string",
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Add Leads to List

Add Leads to List operation can be used to add a given set of lead records to a target static list.

Parameters

* marked fields are mandatory

List ID *

Basic

The ID of the target static list. This must be an integer value and can be specified as a constant value or as a combination of placeholder expressions.

Define IDs in URL

Basic

If this is set to true, the lead IDs to be added will be defined as a URL query parameter, or else they are expected to be included in the payload (refer Request section). The default value is false.

Lead IDs *

Basic
This parameter is only applicable if Define IDs in URL parameter is set to true.

A comma-separated list that contains the IDs of the Leads to be added to the list. This can be specified as a constant value or as a combination of placeholder expressions.

Request

If the Define IDs in URL parameter is set to false, the request message is expected to contain the Lead IDs in a JSON payload of the following format.

{
  "input": [
    {
      "id": 0
    }
  ]
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Remove Leads from List

Remove Leads from List operation can be used to remove a given set of lead records from a target static list.

Parameters

* marked fields are mandatory

List ID *

Basic

The ID of the target static list. This must be an integer value and can be specified as a constant value or as a combination of placeholder expressions.

Define IDs in URL

Basic

If this is set to true, the lead IDs to be removed will be defined as a URL query parameter, or else they are expected to be included in the payload (refer Request section). The default value is false.

Lead IDs *

Basic
This parameter is only applicable if Define IDs in URL parameter is set to true.

A comma-separated list that contains the IDs of the Leads to be removed to the list. This can be specified as a constant value or as a combination of placeholder expressions.

Request

If the Define IDs in URL parameter is set to false, the request message is expected to contain the Lead IDs in a JSON payload of the following format.

{
  "input": [
    {
      "id": 0
    }
  ]
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Update Partition

Update Partition operation can be used to update the lead partition for a list of leads.

Parameters

This operation does not have any configurable parameters

Request

This operation expects the request message to contain the information of the Leads to be updated as a JSON payload of the following format.

{
  "input": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ]
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Update Program Status

Update Program Status operation can be used to change the program status of a list of leads in a target program. Only existing members of the program may have their status changed with this operation.

Parameters

* marked fields are mandatory

Program ID *

Basic

The ID of the target program. This must be an integer value and can be specified as a constant value or as a combination of placeholder expressions.

Request

This operation expects the request message to contain the information of the program status to be updated as a JSON payload of the following format.

{
  "input": [
    {}
  ],
  "lookupField": "string",
  "status": "string"
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
In this topic
In this topic
(c) Copyright 2016-2017 AdroitLogic. All rights reserved.
Terms of Use
Contact Us