Eloqua 491 Sneak Peek: Bulk API - Contact Fields on Activity Exports and SMTP Fields on Bounceback E

Lou PatrickLou Patrick Posts: 343 Gold Badge
edited September 11 in Developer Tools

Original Blog Post Date: Sep 12, 2017 8:26:10 PM

With the Oracle Eloqua 491 release, Contact fields will be available on all Bulk API activity exports, and a Dream will be partially implemented with SMTP fields being added to Bulk API hard Bounceback exports.

Contact Fields on Bulk API Activity Exports

  • Up to 10 Contact fields will be available to add in an activity export definition
    • If more than 10 Contact fields are included, Eloqua will respond with a 400 validation error
    • There should be an expected addition to export time when adding Contact fields to an activity export
  • Any Contact field returned via the Retrieve a list of contact field definitions endpoint will be available
  • Including Contact fields on activity exports enables two common fields for matching activities to Contacts to be available for all activity types: Contact ID Ext and Email Address
  • Contact attributes (e.g. Id) and special fields (e.g. IsBounced, IsSbuscribed, Format) are not available with this addition
    • We are planning to add Contact Id to the remaining activity types it's not currently available (Subscribe, Unsubscribe, Bounceback) in the future
    • There are no plans to add special fields, if there are use cases for these fields, please share
  • The syntax for a Contact field statement in a Bulk API activity export definition will be:
  • Example Email Open activity export definition with a Contact field:
POST /api/bulk/2.0/activities/exports{  "filter": "'{{Activity.Type}}'='EmailOpen'",  "name": "Bulk Activity Export - Email Open",  "fields": {    "ActivityId": "{{Activity.Id}}",    "ActivityType": "{{Activity.Type}}",    "ActivityDate": "{{Activity.CreatedAt}}",    "ContactId": "{{Activity.Contact.Id}}",    "IpAddress": "{{Activity.Field(IpAddress)}}",    "VisitorId": "{{Activity.Visitor.Id}}",    "VisitorExternalId": "{{Activity.Visitor.ExternalId}}",    "EmailRecipientId": "{{Activity.Field(EmailRecipientId)}}",    "AssetType": "{{Activity.Asset.Type}}",    "AssetName": "{{Activity.Asset.Name}}",    "AssetId": "{{Activity.Asset.Id}}",    "SubjectLine": "{{Activity.Field(SubjectLine)}}",    "EmailWebLink": "{{Activity.Field(EmailWebLink)}}",    "CampaignId": "{{Activity.Campaign.Id}}",    "ExternalId": "{{Activity.ExternalId}}",    "DeploymentId": "{{Activity.Field(EmailDeploymentId)}}",    "EmailSendType": "{{Activity.Field(EmailSendType)}}",    "EmailAddress": "{{Activity.Field(EmailAddress)}}",    "ContactIdExt": "{{Activity.Contact.Field(ContactIDExt)}}"  }}

SMTP Fields on Bulk API Hard Bounceback Exports

Here is an example Bounceback export definition as a preview of the field statements:

POST /API/Bulk/2.0/activities/exports{  "filter": "'{{Activity.Type}}'='Bounceback'",  "name": "Bulk Activity Export - Bounceback",  "fields": {    "ActivityId": "{{Activity.Id}}",    "ActivityType": "{{Activity.Type}}",    "ActivityDate": "{{Activity.CreatedAt}}",    "EmailAddress": "{{Activity.Field(EmailAddress)}}",    "AssetType": "{{Activity.Asset.Type}}",    "AssetName": "{{Activity.Asset.Name}}",    "AssetId": "{{Activity.Asset.Id}}",    "CampaignId": "{{Activity.Campaign.Id}}",    "ExternalId": "{{Activity.ExternalId}}",    "EmailRecipientId":"{{Activity.Field(EmailRecipientId)}}",    "DeploymentId": "{{Activity.Field(EmailDeploymentId)}}",    "SmtpErrorCode": "{{Activity.Field(SmtpErrorCode)}}",    "SmtpStatusCode": "{{Activity.Field(SmtpStatusCode)}}",    "SmtpMessage": "{{Activity.Field(SmtpMessage)}}"  }}

SMTP Activity field details:

Field typeData typeMax lengthDescription
{{Activity.Field(SmtpErrorCode)}}String9The SMTP Status Code for the email bounceback.
{{Activity.Field(SmtpStatusCode)}}String3The SMTP Response Code for the email bounceback.
{{Activity.Field(SmtpMessage)}}String510The SMTP message for the email bounceback.

And one more addition! In the above Bounceback example export definition, there are two additional fields available: EmailRecipientId and EmailDeploymentId. These fields enable tying a hard Bounceback to an email send.

When will I receive the 491 release? Visit the Oracle Eloqua Release Center to view roll out dates.

How about documentation? When version 491 is rolled out to POD2, the applicable Oracle Eloqua Developer Help Center reference and tutorial pages will be updated.

Interested in more related to the 491 release? When version 491 is rolled out to POD2:

Sign In or Register to comment.