Important Change to Activity Records in Marketo APIs

Included in this article

Note: This post will be updated to reflect changes made to activity records returned by the API due to migration to new infrastructure.

Overview

With the rollout of Marketo’s next-generation Activity Service beginning in May 2017, we will be unable to enforce the uniqueness or presence of the integer “id” field in activities, data value changes, or lead deletion records returned by Marketo’s APIs.  This change will begin rolling out to all subscriptions over the remaining first half of 2017.

To avoid service disruptions for integrations which retrieve activity records, the id field should be treated as optional.  Cutover of this change will begin to affect subscriptions with the September (Q3) 2017 release.

This change will affect the following endpoints:

REST API

SOAP API

The affected SOAP types are ActivityRecord and LeadChangeRecord.

Examples

The following examples show record types which will be affected.  In both examples, the effected field is called “id.”

Example REST Field: id

REST Field ID.PNG

Example SOAP Field: id

SOAP field ID.PNG

FAQs

Do I need to update my WSDL version if I'm using SOAP integration?

Yes. The marketoGUID field will only be returned in activities when using the WSDL version 3.1 or later.  The new URI will follow this pattern: https://{munchkinId}.mktoapi.com/soap/mktows/3_1  It may also be obtained through the Admin->Web Services menu in your subscription

When can I expect to see each change?

Beginning with our Q1 Minor Release on April 7th, activity records retrieved via Marketo’s SOAP or REST APIs will include a new field called “marketoGUID”.  The value of this field will match the value of the “id” field, but will be a string type field.  Some time after the Q2 release beginning May 17th 2017, the “id” field will stop being returned as part of these records, and the value of marketoGUID will become a 128-bit string.

What do I need to do?

If you are responsible for code that deals with Marketo activities, you should determine whether your code relies on the presence or uniqueness of “id” field for Marketo activities, and then remove that requirement.  In an upcoming release, an additional string field called “marketoGUID” will be added.  “marketoGUID” should be considered the unique ID for retrieved activities when it becomes available.  If you are not, you should consult with your team and relay this message to the appropriate stakeholders.

Who will this change affect?

This change should only affect client and partner integrations which retrieve activity records from Marketo, and only if the integrations rely on either the presence and/or type of the “id” field in the response, or rely on the uniqueness of the field.  After the rollout of Orion AS, and the disabling of activity writes to MySQL, the “id” field will no longer be available and will be supplanted by a unique string id field.

Check out our documentation on the Marketo Developers Site here: https://developers.marketo.com/blog/important-change-activity-records-marketo-apis/

Labels (1)