Discussions
Product Notice: Eloqua Application API - New “isUpdatingCrmID” property being added [Aug 2022]
Overview
With the arrival of Eloqua release 22C (Aug 2022), a new property, isUpdatingCrmID, that indicates if crmId is being updated, will be added to the Application API Update a campaign endpoint.
What's Changing
With 22C, we are adding isUpdatingCrmID to the Application API Update a campaign endpoint.
Notes:
- isUpdatingCrmID can be included in the Update a campaign request body but will not be returned
- isUpdatingCrmID can only be set to “true” or “false”
- If isUpdatingCrmID is not included in the Update a campaign request, isUpdatingCrmID will be set to “true”, and crmId will be updated
- If isUpdatingCrmID is set to “false” and crmId is included in the Update a campaign request, crmId will be ignored and not be updated
Examples:
After 22C, isUpdatingCrmID can be used to not modify crmId:
Request:
PUT /api/REST/2.0/assets/campaign/8663
{
"type": "Campaign",
"id": "8663",
"name": "Do not update crmId",
"isUpdatingCrmID": "false"
}
Response: 200 OK
{
"type": "Campaign",
"currentStatus": "Draft",
"id": "8663",
"initialId": "8663",
"createdAt": "1655334015",
"createdBy": "71",
"depth": "complete",
"folderId": "1263",
"name": "Do not update crmId",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update",
"Activate"
],
"updatedAt": "1655414544",
"updatedBy": "71",
"elements": […],
"isReadOnly": "false",
"actualCost": "0.00",
"adCampaignId": "",
"budgetedCost": "0.00",
"campaignCategory": "contact",
"campaignClassification": "",
"campaignType": "",
"crmId": "test12345",
"fieldValues": […],
"isEmailMarketingCampaign": "false",
"isIncludedInROI": "false",
"isMemberAllowedReEntry": "false",
"isSyncedWithCRM": "false",
"product": "",
"referenceProduct": "",
"region": ""
}
Timeline
With the arrival of Eloqua release 22C (Aug 2022), a new property, isUpdatingCrmID, that indicates if crmId is being updated, will be added to the Application API Update a campaign endpoint. Check the Eloqua Release Center for specific dates and times.
Next Steps
If updating Campaigns via the Application API, and crmId is being updated, then there is no action, as the this is the default behavior.
If updating Campaigns via the Application API, and there is a need for crmId to not be updated in the request, isUpdatingCrmID can now be included and set to “false” to not modify crmId.
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 it below!
FAQs
Q: What endpoints are impacted by this change?
A: The following endpoint is impacted:
- Update a campaign: PUT /api/REST/2.0/assets/campaign/{id}
- Default depth is complete
Q: What happens if I do not include the new isUpdatingCrmID property in the update request?
A: isUpdatingCrmID will be set to “true”, and crmId will be updated, which is the same behavior as prior to 22C.
Q: What happens if isUpdatingCrmID is set to “false” and crmId is included in the Update a campaign request?
A: crmId will be ignored and not be updated.
Q: Why is this isUpdatingCrmID being added?
A: Prior to 22C, if not including crmId in the Update a campaign request, crmId is set to blank. This caused an issue with CRM integrations, where an update in Eloqua was overwriting the crmId set by the CRM integration. Eloqua will now use this new property to only update crmId when it’s been modified.
Group Product Manager, CX - Marketing: Eloqua