REST API - Contact Information

Version 2

    The contact record is at the core of Eloqua's REST API. A contact is an individual with a known level of engagement. You can create, retrieve, update and delete contacts using the API.

     

    Accessing Contacts

    • GET   /data/contact/{id}?depth={depth}&viewId={viewId}

     

    Response

    The response from this call looks as follows :

     

    {
      "type": "Contact",
      "currentStatus": "Awaiting action",
      "id": "4",
      "createdAt": "1282771736",
      "depth": "complete",
      "name": "fred.sakr@eloqua.com",
      "updatedAt": "1348238427",
      "accountName": "Acme.com",
      "businessPhone": "779 584-9090",
      "country": "US",
      "emailAddress": "fred.sakr@eloqua.com",
      "emailFormatPreference": "unspecified",
      "firstName": "Fred",
      "isBounceback": "false",
      "isSubscribed": "true",
      "lastName": "Fred",
      "postalCode": "W23EN",
      "province": "OU",
      "salesPerson": "Scott McNabb",
      "subscriptionDate": "1282771736",
      "title":"Software Engineer"
    }
       

     

    Properties

     

    Name

    Type

    Description

    Validations

    type"Contact"
    accountNamestringName of the account associated to the contact record
    address1string
    address2string
    address3string
    bouncebackDatestringDateRequirement
    businessPhonestring
    citystring
    countrystring
    emailAddressstringEmailAddressRequirement
    faxstring
    fieldValuesList of
    FieldValue
    A list of custom fields and their associated values
    firstNamestring
    isBouncebackbooleanWhen an email cannot be delivered, a non-deliverable message is created and the contact cannot be sent email once they are marked as having bounced.BooleanRequirement
    isSubscribedbooleanIdentifies whether the contact is set to accept emailsBooleanRequirement
    lastNamestring
    mobilePhonestring
    postalCodestring
    provincestring
    salesPersonstring
    subscriptionDateintegerDateRequirement
    titlestring
    unsubscriptionDatestringThe date on which the Contact subscription status is set to not accept emailsDateRequirement
    accessedAtintegerDateRequirement
    createdAtinteger

    (read-only)

    DateRequirement
    createdByinteger

    (read-only)

    IdRequirement
    currentStatusstring
    depthRequestDepthEnumRequirement
    idintegerThe unique ID of the contact reordIdRequirement
    updatedAtinteger(read-only)DateRequirement
    updatedByinteger(read-only)IdRequirement

     

     

    Related operations

    • POST:  /data/contact
    • PUT:  /data/contact/{id}
    • DELETE:  /data/contact/{id}
    • GET :  /data/contacts?depth={depth}&search={search}&page={page}&count={count}

     

    Sample Code