REST API - subscriptions Contact

Similar Questions

• Quesiton answer REST API

  I'm trying to understand what information is contained in the Eloqua activities for the activityTypes object. Activities has these attributes:

  -ID

  -type

  -activityDate

  -activityType

  -assetID

  -contactID

  -Details

  By the documentation, the different activityTypes include emalClickThrough emailSend emailOpen, webVisit, campaignMembership... etc.

  What I've not seen so far, this is what Details would be available for each of these categories. The link below provides an example of output that would be for a emailSend:

  http://topliners.Eloqua.com/docs/doc-3092

  Of course, "Subject line" not will be not rendered for webVisit and CampaignMembership... but what would? We are in the design phase of a project and rely on documentation to illustrate attributes are available for export in a data warehouse.  Please point me to the documentation where I can find this level of information.

  Thank you!

  Hi Joseph,.

  We have updated the original document (REST API - access Contact activities) to include the details for each type of activity.

  Included here for convenience:

  Types of activities (Details)

  • campaignMembership
    • Replied
    • CampaignName
    • LeadStage
  • emailClickThrough
    • EmailClickedThruLink
    • EmailName
    • EmailWebLink
    • EmailRecipientId
    • SubjectLine
  • emailOpen
    • EmailName
    • EmailWebLink
    • EmailRecipientId
    • IPAddress
    • SubjectLine
  • emailSend
    • EmailName
    • EmailWebLink
    • EmailRecipientId
    • SubjectLine
  • emailSubscribe
    • CampaignName
    • EmailCampaignId
  • emailUnsubscribe
    • CampaignName
    • EmailCampaignId
  • formSubmit
    • Collection
    • FormName
  • webVisit
    • Duration
    • QueryString
    • QueryStringDisplay
    • Thread

  Please let me know if you need more information.

  Thank you

  Fred

• Add a contact e-mail group via the Rest API

  Hello

  Is it possible to add a contact to a group of e-mail through the Rest API?

  I saw this article here http://topliners.eloqua.com/docs/DOC-3526 which shows that you can get a subscription email group contacts status, however it is not clear how actually to add a contact to a group of e-mail via the API.

  I tried to post data to ' data/contact / {id} / groups/email/subscription "but I get a response of"Method not allowed"API."

  If someone managed to achieve? If so, how?

  See you soon

  Hi David,

  The POST operation is not supported by this endpoint, but you can use PUT a method for updating subscriptions Contact:

  • PUT: / data/contact / {id} / email/group / {groupId} / subscription

  Where the request body contains an object of the subscription. Hope this helps and please let us know if you need more information.

  Thank you

  Fred

• REST API - the field value date Contact exported in digital format.

  Hi people,

  I used below REST API to retrieve the Contacts with the views and custom filter.

  The JSON response, I shot the date value in the number format. As 'C_Lead_Score_Date': '1434456862',

  
  

  https://secure.Eloqua.com/API/rest/1.0/data/contact/view/ {identifier} / contacts/filter / {id}

  
  

  How can I convert the appropriate number in date value? or y at - it an adjustment to the level of the code to retrieve the value in the correct date format.

  
  

  The data type of the field is dates.

  The date is returned to as a Unix timestamp.

  You can use an online converter to convert it to a normal value, for example: online - time conversion Conversion Unix

  1434456862 = Tuesday, June 16, 2015 12:14:22 GMT

• Using the REST API to delete the contact from the contacts list

  Hello world

  I am looking for some info for the creation of a request to delete a contact from a list of Contact using the REST API.   Here's what I have in Java where the contact id is 1 'and my list is 72'.     I'm open to responses in Java, c# or other languages.

  serverAddress = new URL ("https://secure.p03.eloqua.com/API/REST/1.0/assets/contact/list/72");

  establish communication stuff

  connection = null;

  Set up the initial connection

  connection = (HttpURLConnection) serverAddress.openConnection ();

  connection.setRequestMethod ("PUT");

  connection.setRequestProperty ("content-type", "json; charset=utf-8 ");"

  connection.setRequestProperty ("authorization", 'Basic BLOCKED');

  String body = '{\"membershipDeletions\":[\"1\']}";

  connection.setDoOutput (true);

  connection.getOutputStream () .write (body.getBytes ("UTF8"));

  connection.setReadTimeout (10000);

  Connection.Connect ();

  When I test with it I get a '400' HTTP response

  Thank you!

  Hi Noel,

  The following document describes the operations available for lists of contacts in the Rest API. Please note that we also have a project open source c# example illustrates the use of these endpoints.

  Repositories are all available to the public on Github. Hope this helps and please let me know if you need more information.

  Thank you

  Fred

• How to recover Contacts using ContactGroupID using SOAP or RESTFul API in c#?

  Hi guys,.

  I want to recover contact records from Eloqua 10 using ContactGroupID or by using the SOAP API or RESTFul API in c#. Well want to, help me for the same thing.

  Thanking you,

  Kind regards

  Dhaval Doshi.

  Hi Alain,

  You can use the bulk API to export contacts who are members of a segment or group. Documentation is available at the following address: Eloqua bulk API 1.0: importing and exporting data

  Hope this helps and please let me know if you need more information.

  Thank you

  Fred

• Get complete information of Contact with the REST API with Ruby

  Hello

  I'm trying to find information from a contact using the REST API from Ruby. I followed the example posted here and I was able to get good contact with Eloqua, but information are the basis and the FieldValues table is very long with fieldValues can only be and no label field.

  I don't know I asked for complete = depth, and I verified that the contact even on the side of Eloqua seen so many other areas.

  It's the URL that I use: https://secure.eloqua.com/API/REST/1.0/data/contacts?search= < emailAddress > & depth = full & count = 1

  and I don't get like this field in the fieldValues can only be: {'type': 'FieldValue', 'id': "100175"}

  With respect to the main information, they are basic.

  Is it possible to obtain all the contact fields, the same than the one I see on the site of Eloqua?

  Thank you

  Hi Theyaa,

  You can use the following endpoint to retrieve a list of all fields with their unique identifier and metadata:

  • GET /API/REST/1.0/assets/contact/fields?depth=complete&search=*&page=1&count=250

  Hope this helps and please let me know if you need more information.

  Thank you

  Fred

• Mapping and querying objects for Contact with REST Api

  Hi all

  We are hoping to get some details on the DataCard management defined via REST API. Our implementation goal is to create Contacts and add the custom for each Contact object or to be more precise, add a set of map data for each Contact.

  At the present time, to associate a map Data Set (or custom object) to an existing contact, we provide a suite of fields in the custom when creating custom object object:

  new CustomObjectField  
  {
                                                                  name = "MappedEntityType",
                                                                  dataType = Enum.GetName(typeof(DataType), DataType.numeric),
                                                                  type = "CustomObjectField",
                                                                  defaultValue = "0"
                                                              },
                                                           new CustomObjectField
                                                              {
                                                                  name = "MappedEntityID",
                                                                  dataType = Enum.GetName(typeof(DataType), DataType.numeric),
                                                                  type = "CustomObjectField",
                                                                  defaultValue = "<ContactId>"
                                                              }
  
  

  This is the right approach? This is based on the information provided here: http://topliners.eloqua.com/community/code_it/blog/2012/05/31/eloqua-api-how-to-mapping-a-data-card-to-an-entity.

  The REST API would query the CustomObjects using the MappedEntityId value for the subsequent updates? If so, pointers on how to approach that?

  Thanks to ad.

  The REST API does not support this.  With the upcoming release of Eloqua, you will be able to update the MappedEntityID, as a query it.

• Question: Is it possible to add a contact to a shared list using REST API?

  Maybe it's just me being blind... Is it possible to add a contact to a shared list using the REST API?

  Thank you!

  ADI

  OTHER offers:

  PUT API/REST/1.0/assets/contact/list/{id}

• Searching for a contact through GUID on the REST API

  After talking to some of the developers at Vidyard, it was obvious that there is a way that eloqua could really help us!

  
  

  If taken Eloqua supported a way of searching for a contact based on the GUID of the cookie in the REST API, we could stop using the SOAP API in total. I wanted to just start a thread to see if anyone is looking for this feature? Any ideas would be appreciated!

  
  

  CC TJ fields-Oracle
  

  Hey Ian, is currently our roadmap.  No ETA at this time.

• Can not do a query with the REST api

  Hello

  After discovering that the use of the standard SOAP API what is like poking yourself in the eye with a sharp stick, I try to use the REST API. At first, I tried to exercise it through the extension of POSTMAN on Chrome. But I have no joy.

  Can I use caller ID to get the URL, so I know that my authentication is OK. But all other calls give me:

  Failure of 403 XSRF Protection

  
  

  Is an example of a call, that I'm trying:

  https://secure.Eloqua.com/API/rest/1.0/data/[email protected] & Count = 1

  I can't find any reference anywhere to this error 403.

  Help!

  Thank you

  Simon

  Hi Simon,.

  Looks like you're client (web browser) might have stored credentials for Eloqua, probably in the cookies collection. If you try to delete your cookies and rerun the query API with basic authentication, it should work.

  Hope this helps and please let us know if you need more information.

  Thank you

  Fred

• Updated filter shared via the REST API

  Hello I'm trying to update a shared API filter. I'm using PHP and client fredsakr/eloqua-php-application · GitHub.

  So far, I was able to retrieve the filter with the following call:

  <?php
  require('./eloquaRequest.php');
  $eloquaRequest = new EloquaRequest('site', 'User.Name', 'password', 'https://secure.eloqua.com/API/REST/1.0');
  $response = $eloquaRequest->get('assets/contact/filters?search=TheFilterName&depth=complete');
  print_r($response);
  ?>
  

  I can see the filter in the answer below:

  (
      [type] => ContactFilter
      [currentStatus] => Active
      [id] => 100761
      [createdAt] => 1380137168
      [createdBy] => 48
      [depth] => complete
      [folderId] => 1036
      [name] => TheFilterName
      [updatedAt] => 1383589417
      [updatedBy] => 48
      [count] => 254382
      [criteria] => Array
          (
              [0] => stdClass Object
                  (
                      [type] => ContactFieldCriterion
                      [id] => 1912
                      [condition] => stdClass Object
                          (
                              [type] => TextSetCondition
                              [operator] => in
                              [optionListId] => 193
                          )
  
                      [fieldId] => 100012
                  )
  
          )
  
      [lastCalculatedAt] => 1380137190
      [scope] => global
    statement] => 1912
  

  What I want to do is update that corresponds to the values of 'Compare the Contact fields' in the GUI Eloqua under Contact = > Shared Library = > Contact filters.

  Looks like he has the "[type] = ContactFieldCriterion" under the [criteria] field in the response.

  I'd get how this value in a call to REST, and also how I would update it.

  Please let me know if you need more details on this issue. Please help and thank you.

  After some research I found what I wanted to do has been updated the list of options for this filter. See http://topliners.eloqua.com/docs/DOC-3588 for documentation on the base object. But I had difficulty in updating an OptionList with the Rest API using PUT. If you can help, please visit http://topliners.eloqua.com/message/36739#36739 . Thank you.

• Calling REST API security token error simple GET method

  Please help me get past this error. I have yet to get a successful REST API request of Eloqua. API is enabled for our sandbox that I managed by instantiating different SOAP request/response.

  This is my test RequestURI

  https://secure.Eloqua.com/API/rest/2.0/data/contact/3

  With the method 'GET' headers appropriate and what I have collected of their API guides, including the very useful

  Eloqua REST API - authentication

  Eloqua REST API - URL parameters

  Eloqua REST API - HTTP request headers

  RequestURI works when typed manually into a authenticated (connected to the Eloqua Sandbox session) tab of the FireFox browser.

  When I try the request in my tools (middleware Tibco integration, acting as a client HTTP request), I always get the answer:

  A security token that is associated with your session became invalid.

  I saw this topic, but this was not useful in my case.

  http://topliners.Eloqua.com/message/20371#20371

  The behavior in my case is pretty consistent, and seems not to care if I even spoil RequestURI making it invalid. The same error persists.

  Help, please! Thank you

  Heath

  A more complete answer follows:

  < RequestActivityOutput >

  < header > HTTP/1.1 200 OK

  Content-Type: text/html; charset = utf-8

  Content-Length: 2355

  Date: Friday, April 19, 2013 19:43:19 GMT

  cache-control: private

  connection: close

  P3P: CP = "IDC DSP COR DEVa TAIa OUR PHY ONL UNI COM NAV CNT STA BUS."

  < / header >

  < statusLine >

  < httpVersion > HTTP/1.1 < / httpVersion >

  < statusCode 200 > < / statusCode >

  < reasonPhrase > OK < / reasonPhrase >

  < / statusLine >

  ....

  A security token that is associated with your session became invalid.

  This can happen if you open multiple instances of Eloqua, in

  different browser Windows or tabs, then the diary of one of

  These instances.  Please either close this window or tab, or

  & lt; a href = "" / FormsLogin.aspx "target ="_top"> click here to connect to new & lt;" /a >. & lt; br >

  Heath,

  I'm not able to simply navigate to this URL in my browser either, even though I am connected to my sandbox (which has access to the API). I don't know how you manage to get there in Firefox.

  That being said, I can hit this page of the REST API very well when I base64 encode my credentials HTTP as described here:

  Eloqua REST API - authentication

  May be useful to take a look at the auth string you use when calling from rest.

  Jim

• Get the emails in descending order of creation date. [REST API]

  Hello I am trying to GET emaiils of the REST API in order descending creation date. So far, my URL params look like:

  emails/assets /? Search = * BN * & page = 1 & number = 50 & depth minimum = & orderBy = converted

  This seems to put in ascending order. I wonder if I can specify the order? I noticed for the contacts there is a sorting = {sortOn} & dir = desc, so is it possible

  to do with e-mails? I tried to join the above URL & dir = desc but not luck and assuming that he only is not supported from this page http://topliners.eloqua.com/docs/DOC-3083.

  Yes I can reverse my logic in the program from the end of emails received, but I wonder if I can simply specify order emails using the REST API?

  Please let me know and thank you.

  Hi John,.

  To sort by a column name, such as the 'name' field, you can simply add the following query string parameters: & orderBy = name % 20desc

  The sort directions are: asc | / / DESC

  We will share a post soon to describe how to do this. The API should support the "dir" query string argument, but it doesn't seem to work. We will look into it as well.

  Hope this helps,

  Fred

• There the rest APIs to retrieve the metadata for entity for eloqua objects?

  There is a list of all the objects that are accessible by the REST for CRUD in this link: REST API - Documentation for kernel objects in the objects of the core section.

  For each of the objects listed in the objects of the core section are there is a metadata field in the Properties section.

  For example, for the purpose of the e-mail message, The REST API - to access Emails , under the Properties section, there entered corresponding to the fields of the object of the emails under the
  Name, Type, Description and validation topics.

  Is there a REST API to retrieve the same information, i.e. metadata field for an object programmatically eloqua?
  Otherwise, this is a serious obstacle to building systems that are the metadata engine and support for SOAP is removed...

  The closest to what you are looking for would be endpoints of assistance for a description of the fields. Example of /api/bulk/1.0/contact/fields

  {

  "items": [{}

  'name': "E-mail address",

  "internalName": "C_EmailAddress",

  'dataType': 'emailAddress;

  'hasReadOnlyConstraint': false,

  'hasNotNullConstraint': false,

  'hasUniquenessConstraint': true,

  'Déclaration': '{{Contact.Field (C_EmailAddress)}}.

  "uri": "/ contact/field/100001",

  "converted': ' / Date (-2208970800000) /"

  'updatedAt': ' / Date (-2208970800000) / ".

  },

  {

  'name': "First name",

  "internalName": "C_FirstName",

  'dataType': "string",.

  'hasReadOnlyConstraint': false,

  'hasNotNullConstraint': false,

  'hasUniquenessConstraint': false,

  'Déclaration': '{{Contact.Field (C_FirstName)}}.

  "uri": "/ contact/field/100002."

  "converted': ' / Date (-2208970800000) /"

  "updatedBy": "MgrzzzOracleCloudSupportP01E10",

  'updatedAt': ' / Date (1408993722380) / ".

  },.....

  If so, it will also include an element "defaultValue". How many characters you can store in a field (precision) is documented here: Type of data (data and Digital Formats). The same endpoint exist in bulk 2.0, and there are variants for the account fields and Objetpersonnalise. Another exists in the REST through Api/rest/2.0/assets/contact/fields?depth=complete... It does not include the declaration of ML, but there other useful information such as the type of default update and a flag 'isAccountLinkageField '.

  Similarly, if you describe a form via SOAP or REST, it also will give you the fields and their type.

  Kind regards

  Bojan