Discussions

Product Notice: Eloqua Application API Contact Field endpoints – “isPopulatedInOutlookPlugin” proper

OMC Documentation-Oracle
OMC Documentation-Oracle Posts: 103 Employee
edited Oct 14, 2020 6:22PM in Developer Tools

Overview

With the arrival of Eloqua release 20C (Aug 2020), the isPopulatedInOutlookPlugin property will be removed for the Application API Contact Field endpoints.

What’s changing?

With 20C, we are removing the isPopulatedInOutlookPlugin property impacting the following Application API Contact Field endpoints:

o   Default depth is minimal

o   Default depth is complete

o   Default depth is complete

o   Default depth is complete

Note: isPopulatedInOutlookPlugin is returned at “partial” and “complete” depth only

Example

Prior to 20C, isPopulatedInOutlookPlugin is returned:

GET /api/REST/1.0/assets/contact/fields?depth=complete&count=2

Response:

{

    "elements": [

        {

            "type": "ContactField",

            "id": "100001",

            "createdAt": "-2208970800",

            "depth": "complete",

            "name": "Email Address",

            "updatedAt": "1563263548",

            "updatedBy": "2",

            "dataType": "text",

            "displayType": "text",

            "internalName": "C_EmailAddress",

            "isReadOnly": "false",

            "isRequired": "false",

            "isStandard": "true",

            "isPopulatedInOutlookPlugin": "false",

            "showTrustedVisitorsOnly": "true",

            "updateType": "always"

        },

        {

            "type": "ContactField",

            "id": "100002",

            "createdAt": "-2208970800",

            "depth": "complete",

            "name": "First Name",

            "updatedAt": "1547046908",

            "updatedBy": "2",

            "dataType": "text",

            "displayType": "text",

            "internalName": "C_FirstName",

            "isReadOnly": "false",

            "isRequired": "true",

            "isStandard": "true",

            "isPopulatedInOutlookPlugin": "false",

            "showTrustedVisitorsOnly": "false",

            "updateType": "newNotBlank"

        }

    ],

    "page": 1,

    "pageSize": 2,

    "total": 336

}

After 20C, isPopulatedInOutlookPlugin will no longer be returned:

GET /api/REST/1.0/assets/contact/fields?depth=complete&count=2

Response:

{

    "elements": [

        {

            "type": "ContactField",

            "id": "100001",

            "createdAt": "-2208970800",

            "depth": "complete",

            "name": "Email Address",

            "updatedAt": "1563263548",

            "updatedBy": "2",

            "dataType": "text",

            "displayType": "text",

            "internalName": "C_EmailAddress",

            "isReadOnly": "false",

            "isRequired": "false",

            "isStandard": "true",

            "showTrustedVisitorsOnly": "true",

            "updateType": "always"

        },

        {

            "type": "ContactField",

            "id": "100002",

            "createdAt": "-2208970800",

            "depth": "complete",

            "name": "First Name",

            "updatedAt": "1547046908",

            "updatedBy": "2",

            "dataType": "text",

            "displayType": "text",

            "internalName": "C_FirstName",

            "isReadOnly": "false",

            "isRequired": "true",

            "isStandard": "true",

            "showTrustedVisitorsOnly": "false",

            "updateType": "newNotBlank"

        }

    ],

    "page": 1,

    "pageSize": 2,

    "total": 336

}

Timeline

When will this impact customers? Is it related to a specific release?

With the arrival of Eloqua release 20C (Aug 2020), the isPopulatedInOutlookPlugin property will be removed for the Application API Contact Field endpoints. Check the Eloqua Release Center for specific dates and times.

Next Steps

If retrieving Contact Fields via the Application API, prepare for the isPopulatedInOutlookPlugin property to no longer be returned.

If creating or updating Contact Fields via the Application API, the isPopulatedInOutlookPlugin property can be removed. If including isPopulatedInOutlookPlugin within the request to create or update a Contact Field, the Contact Field will still be created or updated, and isPopulatedInOutlookPlugin will be ignored and not returned in the response.

Additional Resources

View changes for Eloqua's APIs including, new features, significant recent changes, and platform notices, on the Eloqua Developer Changelog.

If you have questions, post a discussion on Developer Tools!

FAQ

Q: What endpoints are impacted by this change?

A: All Contact Field Application API endpoints, except DELETE.

Q: If isPopulatedInOutlookPlugin is included in a create or update request, will the request still be successful?

A: Yes, if including isPopulatedInOutlookPlugin within the request to create or update a Contact Field, the Contact Field will still be created or updated, and the isPopulatedInOutlookPlugin will be ignored and not returned in the response.

Q: Why is isPopulatedInOutlookPlugin being removed?

A: This property was originally designed for an old Outlook plugin, and the property was disabled a while ago when the old plugin was deprecated. As the property is disabled and not used, it is being removed.

Post edited by Mateo Djuric-Oracle on