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" | ||
| accountName | string | Name of the account associated to the contact record | |
| address1 | string | ||
| address2 | string | ||
| address3 | string | ||
| bouncebackDate | string | DateRequirement | |
| businessPhone | string | ||
| city | string | ||
| country | string | ||
| emailAddress | string | EmailAddressRequirement | |
| fax | string | ||
| fieldValues | List of FieldValue | A list of custom fields and their associated values | |
| firstName | string | ||
| isBounceback | boolean | When 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 |
| isSubscribed | boolean | Identifies whether the contact is set to accept emails | BooleanRequirement |
| lastName | string | ||
| mobilePhone | string | ||
| postalCode | string | ||
| province | string | ||
| salesPerson | string | ||
| subscriptionDate | integer | DateRequirement | |
| title | string | ||
| unsubscriptionDate | string | The date on which the Contact subscription status is set to not accept emails | DateRequirement |
| accessedAt | integer | DateRequirement | |
| createdAt | integer | (read-only) | DateRequirement |
| createdBy | integer | (read-only) | IdRequirement |
| currentStatus | string | ||
| depth | RequestDepth | EnumRequirement | |
| id | integer | The unique ID of the contact reord | IdRequirement |
| updatedAt | integer | (read-only) | DateRequirement |
| updatedBy | integer | (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}