Oracle Eloqua Application API

Size: px

Start display at page:

Download "Oracle Eloqua Application API"

Mitchell Hampton
6 years ago
Views:

2 Contents 1 Oracle Eloqua Application API Application API operations Application Application Accounts API Overview API Tasks POST /data/account GET /data/account/id} GET /data/accounts PUT /data/account/id} DELETE /data/account/id} Accounts API Overview API Tasks GET /data/activities/contact/id} Contacts API Overview API Tasks POST /data/contact GET /data/contact/id} GET /data/contacts PUT /data/contact/id} DELETE /data/contact/id} Contact fields API Overview API Tasks POST /assets/contact/field GET /assets/contact/field/id} Oracle Corporation. All rights reserved 2 of 465

3 1.5.5 GET /assets/contact/fields PUT /assets/contact/field/id} DELETE /assets/contact/field/id} Contact lists API Overview API Tasks POST /assets/contact/list GET /assets/contact/list/id} GET /assets/contact/lists PUT /assets/contact/list/id} DELETE /assets/contact/list/id} Contact segments API Overview API Tasks POST /assets/contact/segment GET /assets/contact/segment/id} GET /assets/contact/segments PUT /assets/contact/segment/id} DELETE /assets/contact/segment/id} Content sections API Overview API Tasks POST /assets/contentsection GET /assets/contentsection/id} GET /assets/contentsections PUT /assets/contentsection/id} DELETE /assets/contentsection/id} Custom objects API Overview API Tasks POST /assets/customobject Oracle Corporation. All rights reserved 3 of 465

4 1.9.4 GET /assets/customobjects/id} GET /assets/customobjects PUT /assets/customobject/id} DELETE /assets/customobject/id} Custom object data API Overview API Tasks POST /data/customobject/id} GET /data/customobject/id} API Overview API Tasks POST /assets/ GET /assets/ /id} GET /assets/ s PUT /assets/ /id} DELETE /assets/ /id} folders API Overview API Tasks POST /assets/ /folder GET /assets/ /folder/id} GET /assets/ /folders PUT /assets/ /folder/id} DELETE /assets/ /folder/id} groups API Overview API Tasks POST /assets/ /group GET /assets/ /group/id} GET /assets/ /groups Oracle Corporation. All rights reserved 4 of 465

5 PUT /assets/ /group/id} DELETE /assets/ /group/id} headers API Overview API Tasks POST /assets/ /header GET /assets/ /header/id} GET /assets/ /headers PUT /assets/ /header/id} DELETE /assets/ /header/id} Forms API Overview API Tasks POST /assets/form GET /assets/form/id} GET /assets/forms PUT /assets/form/id} DELETE /assets/form/id} Form data API Overview API Tasks POST /data/form/id} GET /data/form/id} Images API Overview API Tasks POST /assets/image GET /assets/image/id} GET /assets/images PUT /assets/image/id} DELETE /assets/image/id} Oracle Corporation. All rights reserved 5 of 465

6 1.18 Landing pages API Overview API Tasks POST /assets/landingpage GET /assets/landingpage/id} GET /assets/landingpages PUT /assets/landingpage/id} DELETE /assets/landingpage/id} Microsites API Overview API Tasks POST /assets/microsite GET /assets/microsite/id} GET /assets/microsites PUT /assets/microsite/id} DELETE /assets/microsite/id} Option lists API Overview API Tasks POST /assets/optionlist GET /assets/optionlist/id} GET /assets/optionlists PUT /assets/optionlist/id} DELETE /assets/optionlist/id} Users API Overview API Tasks GET /system/user/id} GET /system/users PUT /system/user/id} Campaigns API Oracle Corporation. All rights reserved 6 of 465

7 Overview API Tasks POST /assets/campaign GET /assets/campaign/id} GET /assets/campaigns PUT /assets/campaign/id} DELETE /assets/campaign/id} Custom objects API Overview API Tasks POST /assets/customobject GET /assets/customobject/id} GET /assets/customobjects PUT /assets/customobject/id} DELETE /assets/customobject/id} Custom object fields Custom object data API Overview API Tasks GET /data/customobject/parentid}/instance/id} POST /data/customobject/parentid}/instance External activities API Overview API Tasks POST /data/activity GET /data/activity/id} External assets API Overview API Tasks POST /assets/external GET /assets/external/id} Oracle Corporation. All rights reserved 7 of 465

8 GET /assets/externals PUT /assets/external/id} DELETE /assets/external/id} External asset types API Overview API Tasks POST /assets/external/type GET /assets/external/type/id} GET /assets/external/types PUT /assets/external/type/id} DELETE /assets/external/type/id} Visitors API Overview API Tasks GET /data/visitors deployment API Overview API Tasks POST api/rest/2.0/assets/ /deployment GET api/rest/2.0/assets/ /deployment/id} POST api/rest/2.0/assets/ /deployment GET api/rest/2.0/assets/ /deployment/id} Signature rules API Overview API Tasks GET api/rest/2.0/assets/ /signature/rule/id} GET api/rest/2.0/assets/ /signature/rules POST api/rest/2.0/data/accounts Request parameters Response parameters Example Oracle Corporation. All rights reserved 8 of 465

10 1 Oracle Eloqua Application API Oracle Eloqua's Application API is a RESTful API which is used to extend the functionality of Eloqua's automation engines, Program Builder and Campaign Canvas, and to build applications for Eloqua's AppCloud. The Application API is used primarily for Eloqua asset management. Assets are the building blocks of Eloqua marketing campaigns, things such as campaign elements ( s and landing pages) and components (images, file storage, hyperlinks, field merges, headers and footers, shared and dynamic content sections and signature layouts and rules). Eloqua's Application API is synchronous and so is not recommended for use with high volumes of data -- for that we recommend using Eloqua's Bulk API. An Application API call will consist of an initial authentication and the following form: [Verb] [base URL]/API/[APIName]/[APINumber]/[endpoint] For example, a typical API call using the Application API's 1.0 REST API would look something like: GET [base URL]/API/REST/1.0/assets/ s And a typical API call using Application API's 2.0 REST API would look something like: GET [base URL]/API/REST/2.0/assets/campaigns Learn more about API requests. Below is a list of supported operations for Application 1.0 and Application 2.0 APIs. Please follow the links to learn more. 1.1 Application API operations IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date Oracle Corporation. All rights reserved 10 of 465

11 1.1.1 Application 1.0 Accounts Activities Contacts Contact fields Contact lists Contact segments Content sections Custom objects Custom object data s folders groups headers Forms Form data Images Landing Pages Microsites Option lists Users 2018 Oracle Corporation. All rights reserved 11 of 465

12 1.1.2 Application 2.0 Campaigns Custom objects External Activities External Assets External asset types Visitors IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date. 1.2 Accounts API Overview An Oracle Eloqua Account provides group contact information API Tasks Retrieve a list of accounts Retrieve a specific account Create a new account Update an existing account Delete an account 2018 Oracle Corporation. All rights reserved 12 of 465

13 IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date POST /data/account Creates an account asset that matches the criteria specified by the request body. Request parameters Required Name Type name string The asset's name. Description Possible value (s) Optional Name Type Description folderid integer The asset's containing folder Id. Possible value(s) permissions InstancePermissions The permissions for the asset/operation granted read / write / to your current instance. address1 string The account's first address. fullcontrol address2 string The account's second address. address3 string The account's third address. businessphone array The account's business phone number. city string The account's city. country boolean The account's country. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. postalcode string The account's postal code. province string The account's province Oracle Corporation. All rights reserved 13 of 465

14 Response parameters Name Type Description Possible value(s) type Account The asset's type in Eloqua. currentstatus string The asset's current status. id integer The asset's unique identifier. createdat datetime (10 digit integer Unix time) Unix timestamp for the date and time the asset was created. createdby integer User Id of the asset's creator. depth RequestDepth The request's level of detail. minimal / partial / complete name string The asset's name. updatedat updatedby datetime (10 digit integer Unix time) datetime (10 digit integer Unix timestamp for the date and time the asset was last updated. User Id of the user who last Unix time) updated the asset. address1 string The account's first address. address2 string The account's second address. address3 string The account's third address. businessphone array The account's business phone number. city string The account's city. country boolean The account's country. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. postalcode string The account's postal code. province string The account's province Oracle Corporation. All rights reserved 14 of 465

15 Example Create a new account asset: POST /data/account Request body: } "name":"hudsucker Industries", "address1":"2020 Broadway Ave.", "city":"new York", "country":"united States" Response: HTTP/ Created Cache-Control: private Content-Length: 314 Content-Type: application/json X-Request-Id: 30a95be0-2a5b-4f38-b358-5b2eb2bcb07f P3P: CP="IDC DSP COR DEVa TAIa OUR BUS PHY ONL UNI COM NAV CNT STA", Date: Fri, 05 Jun :12:55 GMT "type":"account", "id":"14", "createdat":" ", "depth":"complete", "description":"", "name":"hudsucker Industries", "updatedat":" ", "address1":"2020 Broadway Ave.", "address2":"", "address3":"", "businessphone":"", "city":"new York", "country":"united States", "fieldvalues":[], "postalcode":"", 2018 Oracle Corporation. All rights reserved 15 of 465

16 } "province":"" IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date GET /data/account/id} Retrieves the account asset specified by the id} parameter. Request parameters Required Name Description Possible Values Constraints Example Id An integer Eloqua user Id. Must be a valid Eloqua user Id. Optional Name Description Possible Values Constraints Example depth Level of detail returned "minimal" n/a by the request. Learn more about the depth parameter. "partial" "complete"?depth=complete Response parameters Name Type Description Possible value(s) type Account The asset's type in Eloqua. currentstatus string The asset's current status. id integer The asset's unique identifier. createdat datetime (10 digit integer Unix time) Unix timestamp for the date and time the asset was created Oracle Corporation. All rights reserved 16 of 465

17 Name Type Description Possible value(s) createdby integer User Id of the asset's creator. depth RequestDepth The request's level of detail. minimal / partial / complete name string The asset's name. updatedat updatedby datetime (10 digit integer Unix time) datetime (10 digit integer Unix timestamp for the date and time the asset was last updated. User Id of the user who last Unix time) updated the asset. address1 string The account's first address. address2 string The account's second address. address3 string The account's third address. businessphone array The account's business phone number. city string The account's city. country boolean The account's country. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. postalcode string The account's postal code. province string The account's province. Example Retrieve the account asset with Id #1: GET /data/account/1 Response: HTTP/ OK 2018 Oracle Corporation. All rights reserved 17 of 465

18 Cache-Control: private Content-Length: 285 Content-Type: application/json X-Request-Id: 3d08e79f-d44d-4f40-a2fd-73ca9659e5a3 P3P: CP="IDC DSP COR DEVa TAIa OUR BUS PHY ONL UNI COM NAV CNT STA", Date: Fri, 05 Jun :54:18 GMT } "type":"account", "id":"1", "createdat":" ", "depth":"complete", "description":"this is an example company.", "name":"cyberdyne Systems", "updatedat":" ", "address1":"123 Industry Lane", "address2":"", "address3":"", "businessphone":" ", "city":"los Angeles ", "country":"united States", "fieldvalues":[], "postalcode":"", "province":"ca" IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date GET /data/accounts Retrieves all account assets that match the criteria specified by the request parameters. Request parameters depth Name Description Constraints Level of detail returned by Possible values: the request. Learn more about the depth parameter. "minimal" 2018 Oracle Corporation. All rights reserved 18 of 465

19 Name Description Constraints "partial" "complete" Example: count Maximum number of entities to return.?depth=complete Any whole number between 1 and 1000 inclusive. Example: page search Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default. The search parameter specifies the search criteria to use to filter the results. The syntax for the search parameter is: search='field} operator}value}'?count=100 Any positive whole number. Example:?page=3&count=10 field} is the name of a field to filter on, operator} is the comparison operator, and value} is the value to compare the field with. If field} and operator} are not supplied, the name field is compared to the value using the equality operator. Searches can be for exact full matches, or partial matches. A "*" symbol can be used after the value} for partial matches. The following operators are supported on most endpoints: = (Equal To)!= (Not equal to) > (Greater than) < (Less than) >= (Greater than or Equal to) <= (Less than or Equal to) Example: GET.../data/contacts?search='id=1' 2018 Oracle Corporation. All rights reserved 19 of 465

20 sort Name Description Constraints Specifies the name of the property used to sort the returned entities. The value depends on the type of entity being sorted, with each entity having its own list of sortable properties. dir orderby lastupdatedat Specifies the direction in which to sort the returned entities. Specified the field by which list results are ordered. When the asset was last updated. Example: GET.../data/contacts?sort=firstName "asc" for ascending or "desc" for descending. Example: GET.../data/contacts?sort=firstName&dir=asc Any valid asset parameter field. Example:?orderBy=createdAt A valid date/time value. Example:?lastUpdatedAt= Response parameters Name Type Description Possible value(s) type Account The asset's type in Eloqua. currentstatus string The asset's current status. id integer The asset's unique identifier. createdat datetime (10 digit integer Unix time) Unix timestamp for the date and time the asset was created. createdby integer User Id of the asset's creator. depth RequestDepth The request's level of detail. minimal / partial / complete name string The asset's name. updatedat datetime (10 digit integer Unix time) Unix timestamp for the date and time the asset was last updated. updatedby datetime (10 digit integer User Id of the user who last 2018 Oracle Corporation. All rights reserved 20 of 465

21 Name Type Description Possible value(s) Unix time) updated the asset. address1 string The account's first address. address2 string The account's second address. address3 string The account's third address. businessphone array The account's business phone number. city string The account's city. country boolean The account's country. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. postalcode string The account's postal code. province string The account's province. Example Retrieve the first 2 accounts in your database: GET /data/accounts?count=2 Note: The "count" value determines the number of results. See the Request parameters tab for details. Response: HTTP/ OK Cache-Control: private Content-Length: 368 Content-Type: application/json X-Request-Id: cb1e3659-9acb-4041-aa07-2fe65e8465c8 P3P: CP="IDC DSP COR DEVa TAIa OUR BUS PHY ONL UNI COM NAV CNT 2018 Oracle Corporation. All rights reserved 21 of 465

22 STA", Date: Fri, 05 Jun :52:33 GMT } "elements":[ "type":"account", "id":"1", "createdat":" ", "depth":"minimal", "description":"", "name":"cyberdyne Systems", "updatedat":" ", "fieldvalues":[] "type":"account", "id":"2", "createdat":" ", "depth":"minimal", "description":"", "name":"jarndyce and Jarndyce Law", "updatedat":" ", "fieldvalues":[] } ], "page":1, "pagesize":2, "total":7 IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date PUT /data/account/id} Updates the account asset specified by the id} parameter. Request parameters Required 2018 Oracle Corporation. All rights reserved 22 of 465

23 Name Type name string The asset's name. Description Possible value (s) id integer The asset's unique identifier. Note: For a PUT request, the Id specified in the request body must match the Id used in the request endpoint, and it cannot be changed as part of the update. The name parameter is required but it can be changed at will. Optional Name Type Description folderid integer The asset's containing folder Id. Possible value(s) permissions InstancePermissions The permissions for the asset/operation granted read / write / to your current instance. address1 string The account's first address. fullcontrol address2 string The account's second address. address3 string The account's third address. businessphone array The account's business phone number. city string The account's city. country boolean The account's country. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. postalcode string The account's postal code. province string The account's province. Response parameters Name Type Description Possible value(s) type Account The asset's type in Eloqua. currentstatus string The asset's current status Oracle Corporation. All rights reserved 23 of 465

24 Name Type Description Possible value(s) id integer The asset's unique identifier. createdat datetime (10 digit integer Unix time) Unix timestamp for the date and time the asset was created. createdby integer User Id of the asset's creator. depth RequestDepth The request's level of detail. minimal / partial / complete name string The asset's name. updatedat updatedby datetime (10 digit integer Unix time) datetime (10 digit integer Unix timestamp for the date and time the asset was last updated. User Id of the user who last Unix time) updated the asset. address1 string The account's first address. address2 string The account's second address. address3 string The account's third address. businessphone array The account's business phone number. city string The account's city. country boolean The account's country. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. postalcode string The account's postal code. province string The account's province. Example Update the account with Id #14: 2018 Oracle Corporation. All rights reserved 24 of 465

25 PUT /data/account/14 Request body: } "id":"14" "name":"hudsucker Industries", "country":"guatemala", Response: HTTP/ OK Cache-Control: private Content-Length: 301 Content-Type: application/json X-Request-Id: f2d f c9-11c36ac5e0f9 P3P: CP="IDC DSP COR DEVa TAIa OUR BUS PHY ONL UNI COM NAV CNT STA", Date: Fri, 05 Jun :26:28 GMT } "type":"account", "id":"14", "initialid":"14", "createdat":" ", "depth":"complete", "description":"", "name":"hudsucker Industries", "updatedat":" ", "address1":"", "address2":"", "address3":"", "businessphone":"", "city":"", "country":"guatemala", "fieldvalues":[], "postalcode":"", "province":"" 2018 Oracle Corporation. All rights reserved 25 of 465

26 IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date DELETE /data/account/id} Deletes the account asset specified by the id} parameter. Request parameters Required Name Type Description id integer The asset's unique identifier. Possible value (s) Example Delete the account asset with Id #14: DELETE /data/account/14 Response: HTTP/ OK Cache-Control: private X-Request-Id: 609e4bfa-f b-9f59-276bce8dd4cf P3P: CP="IDC DSP COR DEVa TAIa OUR BUS PHY ONL UNI COM NAV CNT STA", Date: Thu, 21 May :02:39 GMT Content-Length: 0 IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date Oracle Corporation. All rights reserved 26 of 465

27 1.3 Accounts API Overview Activities are tracked for individual contacts API Tasks Retrieve a list of activities for a given contact IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date GET /data/activities/contact/id} Retrieves all activity assets that match the criteria specified by the request parameters. Request parameters Required parameters Name Description Possible Values Constraints Example id Id of the contact asset you wish to retrieve activity information from. type The type of activity you wish to retrieve from the specified contact. open send clickthrough Must be one of the specified possible values. subscribe unsubscribe formsubmit webvisit 2018 Oracle Corporation. All rights reserved 27 of 465

28 Name Description Possible Values Constraints Example campaignmembership startdate datetime (10 digit integer Unix time) enddate count datetime (10 digit integer Unix time) Maximum number Any whole number between 1 of entities to and 1000 inclusive. return. Must follow Unix timestamp conventions. Must follow Unix timestamp conventions (Fri, 01 Jan :00:00 GMT) (Tue, 09 Jun :00:00 GMT) Must be less than or equal to 1000?count=100 and greater than or equal to 1. Response parameters Name Type Description Possible value(s) type Activity The asset's type in Eloqua. activitydate datetime (10 digit integer Unix time) Date the activity was performed. activitytype integer The activity's type. asset datetime (10 digit integer Unix time) Id of the associated asset. assettype string Type of the associated asset. contact datetime (10 digit integer Unix time) The id of the contact whose activity is being returned. id integer The activity's id. details array An array of detail values, specific to individual activity types. See the Activity details table below for more information. Activity detail values Asset type Activity type Detail Name Description campaign campaignmembership Responded When or if a contact is associated with a campaign. Contacts become associated to 2018 Oracle Corporation. All rights reserved 28 of 465

29 Asset type Activity type Detail Name Description campaigns when they submit a form within the campaign. CampaignName The campaign asset's filename. LeadStage? clickthrough ClickedThruLink Link to the asset.? Name The asset's filename. WebLink? RecipientId contact Id? SubjectLine The asset's subject line. open Name The asset's filename. WebLink? RecipientId contact Id? IPAddress where it was opened? SubjectLine The asset's subject line. send Name The asset's filename. WebLink? RecipientId contact Id? SubjectLine The asset's subject line. subscribe CampaignName The campaign asset's filename. CampaignId campaign's id? unsubscribe CampaignName The campaign asset's filename. CampaignId campaign's id? form formsubmit Collection FormName The form asset's filename. web webvisit Duration Length of time spent on the web visit. QueryString? QueryStringDisplay? Thread? Example Retrieve the first 2 " open" activities associated with the contact id #1 in the given time frame: GET 2018 Oracle Corporation. All rights reserved 29 of 465

30 /data/activities/contact/1?type= open&startdate= &enddate= &count=2 Response: HTTP/ OK Cache-Control: private Content-Length: 778 Content-Type: application/json X-Request-Id: aefb038a-d9c5-4bc2-9b10-d804ad227c9e P3P: CP="IDC DSP COR DEVa TAIa OUR BUS PHY ONL UNI COM NAV CNT STA", Date: Tue, 09 Jun :38:02 GMT [ "type":"activity", "activitydate":" ", "activitytype":" open", "asset":"80", "assettype":" ", "contact":"1", "details":[ "Key":" WebLink", "Value":"" "Key":"IPAddress", "Value":" " "Key":" Name", "Value":"Example Event.html" "Key":" RecipientID", "Value":"85222ff6-15b aa5c-fcc2623bf46a" "Key":"SubjectLine", "Value":"Example Event" } 2018 Oracle Corporation. All rights reserved 30 of 465

31 ] } ], "id":"71" "type":"activity", "activitydate":" ", "activitytype":" open", "asset":"80", "assettype":" ", "contact":"1", "details":[ "Key":" WebLink", "Value":"" "Key":"IPAddress", "Value":" " "Key":" Name", "Value":"Example Event.html" "Key":" RecipientID", "Value":"85222ff6-15b aa5c-fcc2623bf46a" "Key":"SubjectLine", "Value":"Example Event" } ], "id":"58" IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date Oracle Corporation. All rights reserved 31 of 465

32 1.4 Contacts API Overview A contact is a data entity that contains the explicit data around an individual person in the database. Learn more about contacts API Tasks Retrieve a list of all contacts Retrieve a specific contact Create a new contact Update an existing contact Delete a contact IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date POST /data/contact Creates a contact asset that matches the criteria specified by the request body. Request parameters Required Name Type Description address string The contact's address. Possible value (s) 2018 Oracle Corporation. All rights reserved 32 of 465

33 Important: The address parameter must be the same as the name parameter (which is the name of the contact asset, rather than the name of the actual person. Optional Name Type Description name string The asset's name. Possible value(s) folderid integer The asset's containing folder Id. permissions InstancePermissions The permissions for the asset/operation read / write / granted to your current instance. fullcontrol formatpreference string The contact's format preference. unspecified / text / html isbounceback boolean Whether or not the contact has any associated bouncebacks. issubscribed boolean Whether or not the contact is subscribed. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. Note: For contact assets, the FieldValue id corresponds to the value received when making a GET request to the assets/contact/field/id} endpoint. Learn more about retrieving contact field information. Response parameters Name Type Description type Contact The asset's type in Eloqua. Possible value (s) currentstatus string The asset's current status. id integer The asset's unique identifier. depth RequestDepth The request's level of minimal / partial / 2018 Oracle Corporation. All rights reserved 33 of 465

34 Name Type Description detail. Possible value (s) complete name string The asset's name. accountname string The contact's company. accountid string If there is a linked Account, the contact's associated Account Id. address1 string The contact's first address. address2 string The contact's second address. address3 string The contact's third address. businessphone string The contact's business phone number. city string The contact's city. country string The contact's country. createdat string The date and time the contact was created, expressed in Unix time address string The contact's address. fax string The contact's fax number. firstname string The contact's first name. lastname string The contact's last name. mobilephone string The contact's mobile phone number. postalcode string The contact's postal code or zip code. province string The contact's province. salesperson string The contact's salesperson. title string The contact's title. updatedat string Unix timestamp for the date and time the contact was last updated. formatpreference string The contact's format preference. unspecified / text / html isbounceback boolean Whether or not the contact has any associated bouncebacks. issubscribed boolean Whether or not the contact is subscribed. subscriptiondate datetime (10 digit integer Unix time) Unix timestamp for the date and time the contact subscribed Oracle Corporation. All rights reserved 34 of 465

35 unsubscriptiondate bouncebackdate Name Type Description datetime (10 digit integer Unix time) datetime (10 digit integer Unix time) Unix timestamp for the date and time the contact unsubscribed. Unix timestamp for the date and time the contact bouncebacked. Possible value (s) fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. Note: For contact assets, the FieldValue id corresponds to the value received when making a GET request to the assets/contact/field/id} endpoint. Learn more about retrieving contact field information. Example Create a new contact asset: POST /data/contact Request body: } address":"fortinbras@norway.com" Response: "type":"contact", "currentstatus":"awaiting action", "id":"22482", "createdat":" ", "depth":"complete", "name":"fortinbras@norway.com", 2018 Oracle Corporation. All rights reserved 35 of 465

36 "updatedat":" ", " formatpreference":"unspecified", "fieldvalues":[ "type":"fieldvalue", "id":"100005" "type":"fieldvalue", "id":"100017" "type":"fieldvalue", "id":"100023" "type":"fieldvalue", "id":"100024" "type":"fieldvalue", "id":"100032", "value":"cplto " "type":"fieldvalue", "id":"100033" "type":"fieldvalue", "id":"100034" "type":"fieldvalue", "id":"100035" "type":"fieldvalue", "id":"100036" "type":"fieldvalue", "id":"100041" 2018 Oracle Corporation. All rights reserved 36 of 465

37 "type":"fieldvalue", "id":"100043" "type":"fieldvalue", "id":"100044" "type":"fieldvalue", "id":"100045" "type":"fieldvalue", "id":"100046" "type":"fieldvalue", "id":"100047" "type":"fieldvalue", "id":"100048" "type":"fieldvalue", "id":"100049" "type":"fieldvalue", "id":"100051" "type":"fieldvalue", "id":"100065" "type":"fieldvalue", "id":"100066" "type":"fieldvalue", "id":"100068" 2018 Oracle Corporation. All rights reserved 37 of 465

38 "type":"fieldvalue", "id":"100069" "type":"fieldvalue", "id":"100072" "type":"fieldvalue", "id":"100081" "type":"fieldvalue", "id":"100171", "value":"norway.com" "type":"fieldvalue", "id":"100172" "type":"fieldvalue", "id":"100174" "type":"fieldvalue", "id":"100175" "type":"fieldvalue", "id":"100176" "type":"fieldvalue", "id":"100177" "type":"fieldvalue", "id":"100178" "type":"fieldvalue", "id":"100179" 2018 Oracle Corporation. All rights reserved 38 of 465

39 "type":"fieldvalue", "id":"100180" "type":"fieldvalue", "id":"100184" "type":"fieldvalue", "id":"100187" "type":"fieldvalue", "id":"100188" "type":"fieldvalue", "id":"100189", "value":"fortinbrasl88fjf" "type":"fieldvalue", "id":"100190" "type":"fieldvalue", "id":"100191" "type":"fieldvalue", "id":"100192" "type":"fieldvalue", "id":"100193" "type":"fieldvalue", "id":"100194" "type":"fieldvalue", "id":"100195" 2018 Oracle Corporation. All rights reserved 39 of 465

40 } "type":"fieldvalue", "id":"100197" } ], "isbounceback":"false", "issubscribed":"true", "subscriptiondate":" " Note: For contact assets, the FieldValue id corresponds to the value received when making a GET request to the assets/contact/field/id} endpoint. Learn more about retrieving contact field information. IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date GET /data/contact/id} Retrieves the contact asset specified by the id} parameter. Request parameters Required Name Description Possible Values Constraints Example Id An integer Eloqua user Id. Must be a valid Eloqua user Id. Optional Name Description Possible Values Constraints Example depth Level of detail returned "minimal" n/a by the request. Learn more about the depth parameter. viewidspecifies a contact view to retrieve a specific set "partial" "complete" Must be a valid Eloqua view Id.?depth=complete?viewId= Oracle Corporation. All rights reserved 40 of 465

41 Name Description Possible Values Constraints Example of contact data. Response parameters Name Type Description type Contact The asset's type in Eloqua. Possible value (s) currentstatus string The asset's current status. id integer The asset's unique identifier. depth RequestDepth The request's level of detail. minimal / partial / complete name string The asset's name. accountname string The contact's company. accountid string If there is a linked Account, the contact's associated Account Id. address1 string The contact's first address. address2 string The contact's second address. address3 string The contact's third address. businessphone string The contact's business phone number. city string The contact's city. country string The contact's country. createdat string The date and time the contact was created, expressed in Unix time address string The contact's address. fax string The contact's fax number. firstname string The contact's first name. lastname string The contact's last name. mobilephone string The contact's mobile phone number. postalcode string The contact's postal code or zip code. province string The contact's province. salesperson string The contact's salesperson. title string The contact's title Oracle Corporation. All rights reserved 41 of 465

42 Name Type Description Possible value (s) updatedat string Unix timestamp for the date and time the contact was last updated. formatpreference string The contact's format preference. unspecified / text / html isbounceback boolean Whether or not the contact has any associated bouncebacks. issubscribed boolean Whether or not the contact is subscribed. subscriptiondate unsubscriptiondate bouncebackdate datetime (10 digit integer Unix time) datetime (10 digit integer Unix time) datetime (10 digit integer Unix time) Unix timestamp for the date and time the contact subscribed. Unix timestamp for the date and time the contact unsubscribed. Unix timestamp for the date and time the contact bouncebacked. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. Note: For contact assets, the FieldValue id corresponds to the value received when making a GET request to the assets/contact/field/id} endpoint. Learn more about retrieving contact field information. Example Retrieve the contact asset with Id #1: GET /data/contact/1?depth=complete Response: 2018 Oracle Corporation. All rights reserved 42 of 465

43 "type": "Contact", "currentstatus": "Awaiting action", "id": "1", "createdat": " ", "depth": "complete", "name": "updatedat": " ", "accountname": "C_Company", "address1": "C_Address1", "address2": "C_Address2", "address3": "C_Address3", "businessphone": "C_BusPhone", "city": "C_City", "country": "US", " address": " formatpreference": "unspecified", "fax": "C_Fax", "fieldvalues": [ "type": "FieldValue", "id": "100005" "type": "FieldValue", "id": "100017", "value": "C_Salutation" "type": "FieldValue", "id": "100023" "type": "FieldValue", "id": "100024" "type": "FieldValue", "id": "100032", "value": "CLPSB " "type": "FieldValue", "id": "100033" 2018 Oracle Corporation. All rights reserved 43 of 465

44 "type": "FieldValue", "id": "100034" "type": "FieldValue", "id": "100035" "type": "FieldValue", "id": "100036" "type": "FieldValue", "id": "100041" "type": "FieldValue", "id": "100043" "type": "FieldValue", "id": "100044", "value": "C_Lead_Source Most_Recent" "type": "FieldValue", "id": "100045", "value": "C_Lead_Source Original1" "type": "FieldValue", "id": "100046" "type": "FieldValue", "id": "100047" "type": "FieldValue", "id": "100048" "type": "FieldValue", "id": "100049" 2018 Oracle Corporation. All rights reserved 44 of 465

45 "type": "FieldValue", "id": "100051" "type": "FieldValue", "id": "100065" "type": "FieldValue", "id": "100066" "type": "FieldValue", "id": "100068" "type": "FieldValue", "id": "100069" "type": "FieldValue", "id": "100072" "type": "FieldValue", "id": "100081" "type": "FieldValue", "id": "100171", "value": "oracle.com" "type": "FieldValue", "id": "100172", "value": "C_FirstName C_LastName" "type": "FieldValue", "id": "100174" "type": "FieldValue", "id": "100175" 2018 Oracle Corporation. All rights reserved 45 of 465

46 "type": "FieldValue", "id": "100176" "type": "FieldValue", "id": "100177" "type": "FieldValue", "id": "100178" "type": "FieldValue", "id": "100179" "type": "FieldValue", "id": "100180" "type": "FieldValue", "id": "100184" "type": "FieldValue", "id": "100187" "type": "FieldValue", "id": "100188" "type": "FieldValue", "id": "100189", "value": "lpatrickl88888" "type": "FieldValue", "id": "100190" "type": "FieldValue", "id": "100191" 2018 Oracle Corporation. All rights reserved 46 of 465

47 } "type": "FieldValue", "id": "100192" "type": "FieldValue", "id": "100193" "type": "FieldValue", "id": "100194" "type": "FieldValue", "id": "100195" } ], "firstname": "C_FirstName", "isbounceback": "false", "issubscribed": "true", "lastname": "C_LastName", "mobilephone": "C_MobilePhone", "postalcode": "C_Zip_Postal", "province": "OR", "salesperson": "C_Salesperson", "subscriptiondate": " ", "title": "C_Title" Note: For contact assets, the FieldValue id corresponds to the value received when making a GET request to the assets/contact/field/id} endpoint. Learn more about retrieving contact field information. IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date Oracle Corporation. All rights reserved 47 of 465

48 1.4.5 GET /data/contacts Retrieves all contact assets that match the criteria specified by the request parameters. Request parameters depth Name Description Constraints Level of detail returned by Possible values: the request. Learn more about the depth parameter. "minimal" "partial" "complete" count Maximum number of entities to return. Example:?depth=complete Any whole number between 1 and 1000 inclusive. Example: page search Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default. The search parameter specifies the search criteria to use to filter the results. The syntax for the search parameter is: search='field} operator}value}'?count=100 Any positive whole number. Example:?page=3&count=10 field} is the name of a field to filter on, operator} is the comparison operator, and value} is the value to compare the field with. If field} and operator} are not supplied, the name field is compared to the value using the equality operator. Searches can be for exact full matches, or partial matches. A "*" symbol can be used after the value} for partial matches. The following operators are supported on most endpoints: = (Equal To)!= (Not equal to) 2018 Oracle Corporation. All rights reserved 48 of 465

49 Name Description Constraints > (Greater than) < (Less than) >= (Greater than or Equal to) <= (Less than or Equal to) Example: sort Specifies the name of the property used to sort the returned entities. GET.../data/contacts?search='id=1' The value depends on the type of entity being sorted, with each entity having its own list of sortable properties. dir orderby lastupdatedat Specifies the direction in which to sort the returned entities. Specified the field by which list results are ordered. When the asset was last updated. Example: GET.../data/contacts?sort=firstName "asc" for ascending or "desc" for descending. Example: GET.../data/contacts?sort=firstName&dir=asc Any valid asset parameter field. Example:?orderBy=createdAt A valid date/time value. Example:?lastUpdatedAt= Response parameters Name Type Description Possible value (s) type Contact The asset's type in Eloqua. currentstatus string The asset's current status. id integer The asset's unique identifier. depth RequestDepth The request's level of detail. minimal / partial / complete 2018 Oracle Corporation. All rights reserved 49 of 465

50 Name Type Description Possible value (s) name string The asset's name. accountname string The contact's company. accountid string If there is a linked Account, the contact's associated Account Id. address1 string The contact's first address. address2 string The contact's second address. address3 string The contact's third address. businessphone string The contact's business phone number. city string The contact's city. country string The contact's country. createdat string The date and time the contact was created, expressed in Unix time address string The contact's address. fax string The contact's fax number. firstname string The contact's first name. lastname string The contact's last name. mobilephone string The contact's mobile phone number. postalcode string The contact's postal code or zip code. province string The contact's province. salesperson string The contact's salesperson. title string The contact's title. updatedat string Unix timestamp for the date and time the contact was last updated. formatpreference string The contact's format preference. unspecified / text / html isbounceback boolean Whether or not the contact has any associated bouncebacks. issubscribed boolean Whether or not the contact is subscribed. subscriptiondate datetime (10 digit integer Unix time) Unix timestamp for the date and time the contact subscribed. unsubscriptiondate datetime (10 digit Unix timestamp for the date 2018 Oracle Corporation. All rights reserved 50 of 465

51 bouncebackdate Name Type Description integer Unix time) datetime (10 digit integer Unix time) and time the contact unsubscribed. Unix timestamp for the date and time the contact bouncebacked. Possible value (s) fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. Note: For contact assets, the FieldValue id corresponds to the value received when making a GET request to the assets/contact/field/id} endpoint. Learn more about retrieving contact field information. Example Retrieve the first 2 contacts in your database: GET /data/contacts?count=2 Note: The "count" value determines the number of results. See the Request parameters tab for details. Response: "elements":[ "type":"contact", "id":"1", "createdat":" ", "depth":"minimal", "name":"george.washington@america.com", "updatedat":" ", 2018 Oracle Corporation. All rights reserved 51 of 465

52 } } ], "page":1, "pagesize":2, "total":527 " address":"george.washington@america.com" "type":"contact", "id":"2", "createdat":" ", "depth":"minimal", "name":"john.a.macdonald@canada.com", "updatedat":" ", " address":"john.a.macdonald@canada.com" IMPORTANT: Click here to access the latest version of our API reference. The content on this page is no longer maintained and may be out of date PUT /data/contact/id} Updates the contact asset specified by the id} parameter. Request parameters Required Name Type Description address string The contact's address. Possible value (s) id integer The asset's unique identifier. Note: For a PUT request, the Id specified in the request body must match the Id used in the request endpoint, and it cannot be changed as part of the update. The address parameter is required but it can be changed at will Oracle Corporation. All rights reserved 52 of 465

53 Important: The address parameter must be the same as the name parameter (which is the name of the contact asset, rather than the name of the actual person. Optional Name Type Description name string The asset's name. Possible value(s) folderid integer The asset's containing folder Id. permissions InstancePermissions The permissions for the asset/operation read / write / granted to your current instance. fullcontrol formatpreference string The contact's format preference. unspecified / text / html isbounceback boolean Whether or not the contact has any associated bouncebacks. issubscribed boolean Whether or not the contact is subscribed. fieldvalues array Array containing type and id values for all of the contactfields associated with a given contact. Response parameters Name Type Description type Contact The asset's type in Eloqua. Possible value (s) currentstatus string The asset's current status. id integer The asset's unique identifier. depth RequestDepth The request's level of detail. minimal / partial / complete name string The asset's name. accountname string The contact's company. accountid string If there is a linked Account, the contact's associated Account Id Oracle Corporation. All rights reserved 53 of 465

54 Name Type Description Possible value (s) address1 string The contact's first address. address2 string The contact's second address. address3 string The contact's third address. businessphone string The contact's business phone number. city string The contact's city. country string The contact's country. createdat string The date and time the contact was created, expressed in Unix time address string The contact's address. fax string The contact's fax number. firstname string The contact's first name. lastname string The contact's last name. mobilephone string The contact's mobile phone number. postalcode string The contact's postal code or zip code. province string The contact's province. salesperson string The contact's salesperson. title string The contact's title. updatedat string Unix timestamp for the date and time the contact was last updated. formatpreference string The contact's format preference. unspecified / text / html isbounceback boolean Whether or not the contact has any associated bouncebacks. issubscribed boolean Whether or not the contact is subscribed. subscriptiondate unsubscriptiondate bouncebackdate datetime (10 digit integer Unix time) datetime (10 digit integer Unix time) datetime (10 digit integer Unix time) Unix timestamp for the date and time the contact subscribed. Unix timestamp for the date and time the contact unsubscribed. Unix timestamp for the date and time the contact bouncebacked Oracle Corporation. All rights reserved 54 of 465

Oracle Eloqua Bulk API v2.0

http://docs.oracle.com Oracle Eloqua Bulk API v2.0 Developer Guide 2018 Oracle Corporation. All rights reserved 02-Feb-2018 Contents 1 Oracle Eloqua Bulk API 7 1.1 What you'll find in these docs 7 2 Getting