Product Notice: Eloqua Application API Retrieve an account endpoint – Adding “crmSystemMappings” whe

JodyMooney-Oracle

Overview

With the arrival of Eloqua release 20D (Nov 2020), crmSystemMappings will be returned at complete depth with the Retrieve an account Application API endpoint when the Account is linked to a User.

What’s changing?

With 20D, crmSystemMappings will be returned at complete depth when the Account is linked to a User when using the following endpoint:

• 1.0
  • Retrieve an accountGET /api/REST/1.0/data/account/{id}
    • Default depth is complete

Notes:

• If an Account has no linked Users crmSystemMappings is not returned
• crmSystemMappings is only returned at complete depth
• crmSystemMappings is an array containing type, CRMUsername(s), and loginName values for all of the CRM Users linked with the Account
• crmSystemMappings is read-only, and if including it when creating or updating an account it will be ignored
• Each crmSystemMapping will include at least one of the following CRM Usernames:
  • MSDUserName
  • OSCUserName
  • SFDCUserName
  • SODUserName

Example:

After 20D, crmSystemMappings is returned when retrieving Accounts at complete depth:

Request:

GET /api/REST/1.0/data/account/13211

Response: 200 OK

{

"type": "Account",

"id": "13211",

"createdAt": "1590090316",

"depth": "complete",

"description": "",

"name": "Eloqua",

"updatedAt": "1590090316",

"address1": "",

"address2": "",

"address3": "",

"businessPhone": "",

"city": "",

"country": "",

"crmSystemMappings": [

{

"type": "CrmSystemMapping",

"OSCUserName": "12345678",

"loginName": "Crm Test"

}

    ],

"fieldValues": […],

"postalCode": "",

"province": ""

}

Timeline

With the arrival of Eloqua release 20D (Nov 2020), crmSystemMappings will be returned at complete depth with the Retrieve an account Application API endpoint when the Account is linked to a User. Check the Eloqua Release Center for specific dates and times.

Next Steps

If retrieving Accounts using the Application API using the Retrieve an account endpoint, prepare for crmSystemMappings to be returned at complete depth when the Account is linked to a User.

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 Code It!

FAQ

Q: What endpoints are impacted by this change?

A: Only the following endpoint is impacted:

• 1.0
  • Retrieve an accountGET /api/REST/1.0/data/account/{id}
    • Default depth is complete

Q: How are Accounts linked to Users?

A: Details on linking Accounts to Users will be provided with the 20D release.