Create a contact
post
/api/REST/1.0/data/contact
Creates a contact that matches the criteria specified by the request body
Request
Supported Media Types
- application/json
The request body defines the details of the contact to be created.
Root Schema : Contact
Type:
object
Title:
Show Source
Contact
-
accountId:
string
The account id in which the contact belongs. This is a read-only property.
-
accountName:
string
The account name in which the contact belongs.
-
address1:
string
The contact's first address.
-
address2:
string
The contact's second address.
-
address3:
string
The contact's third address.
-
bouncebackDate:
string
The contact's bounceback date.
-
businessPhone:
string
The contact's business phone number.
-
city:
string
The contact's city.
-
country:
string
The contact's country.
-
createdAt:
string
Read Only:
true
The date and time the contact was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the contact. -
currentStatus:
string
The contact's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the contact.
-
emailAddress:
string
The contact's email address.
-
emailFormatPreference:
string
The contact's email format preference.
-
fax:
string
The contact's fax number.
-
fieldValues:
array fieldValues
Array containing
type
andid
values for all of the contactFields associated with a given contact. -
firstName:
string
The contact's first name.
-
id:
string
Read Only:
true
Id of the contact. This is a read-only property. -
isBounceback:
string
Whether or not the contact has any associated bouncebacks.
-
isSubscribed:
string
Whether or not the contact is subscribed.
-
lastName:
string
The contact's last name.
-
mobilePhone:
string
The contact's mobile phone number.
-
name:
string
The name of the contact.
-
permissions:
string
The permissions for the contact granted to your current instance. This is a read-only property.
-
postalCode:
string
The contact's postal code.
-
province:
string
The contact's province.
-
salesPerson:
string
The contact's account representative.
-
subscriptionDate:
string
The contact's subscription date.
-
title:
string
The contact's title.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
unsubscriptionDate:
string
The contact's unsubscription date.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the contact was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the contact.
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
and id
values for all of the contactFields associated with a given contact.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
Response
Supported Media Types
- application/json
201 Response
Success
Root Schema : Contact
Type:
object
Title:
Show Source
Contact
-
accountId:
string
The account id in which the contact belongs. This is a read-only property.
-
accountName:
string
The account name in which the contact belongs.
-
address1:
string
The contact's first address.
-
address2:
string
The contact's second address.
-
address3:
string
The contact's third address.
-
bouncebackDate:
string
The contact's bounceback date.
-
businessPhone:
string
The contact's business phone number.
-
city:
string
The contact's city.
-
country:
string
The contact's country.
-
createdAt:
string
Read Only:
true
The date and time the contact was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the contact. -
currentStatus:
string
The contact's current status.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the contact.
-
emailAddress:
string
The contact's email address.
-
emailFormatPreference:
string
The contact's email format preference.
-
fax:
string
The contact's fax number.
-
fieldValues:
array fieldValues
Array containing
type
andid
values for all of the contactFields associated with a given contact. -
firstName:
string
The contact's first name.
-
id:
string
Read Only:
true
Id of the contact. This is a read-only property. -
isBounceback:
string
Whether or not the contact has any associated bouncebacks.
-
isSubscribed:
string
Whether or not the contact is subscribed.
-
lastName:
string
The contact's last name.
-
mobilePhone:
string
The contact's mobile phone number.
-
name:
string
The name of the contact.
-
permissions:
string
The permissions for the contact granted to your current instance. This is a read-only property.
-
postalCode:
string
The contact's postal code.
-
province:
string
The contact's province.
-
salesPerson:
string
The contact's account representative.
-
subscriptionDate:
string
The contact's subscription date.
-
title:
string
The contact's title.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
unsubscriptionDate:
string
The contact's unsubscription date.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the contact was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the contact.
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
and id
values for all of the contactFields associated with a given contact.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Examples
Create a new contact:
POST/api/REST/1.0/data/contact
Content-Type: application/json
Request body:
{
"address1": "P.O.Box 72202 - 00200",
"address2": "6th Floor, Lonrho House ",
"address3": "Standard Street, City Centre",
"businessPhone": "2540312885",
"city": "Copenhagen",
"country": "Denmark",
"emailAddress": "fortinbras@norway.com",
"fax": "2540312886",
"firstName": "Fort",
"lastName": "Fortinbras",
"mobilePhone": "2540312887",
"postalCode": "2620",
"province": "Malmo",
"salesPerson": "Hamlet",
"title": "Actor",
"fieldValues": [
{
"id": "100017",
"value": "Mr."
},
{
"id": "100044",
"value": "source-integration"
}
]
}
Response:
{
"type": "Contact",
"currentStatus": "Awaiting action",
"id": "221",
"createdAt": "1524057264",
"depth": "complete",
"name": "fortinbras@denmark.com",
"updatedAt": "1524057264",
"address1": "P.O.Box 72202 - 00200",
"address2": "6th Floor, Lonrho House ",
"address3": "Standard Street, City Centre",
"businessPhone": "2540312885",
"city": "Copenhagen",
"country": "Denmark",
"emailAddress": "fortinbras@denmark.com",
"emailFormatPreference": "unspecified",
"fax": "2540312886",
"fieldValues": [
{
"type": "FieldValue",
"id": "100005"
},
{
"type": "FieldValue",
"id": "100017",
"value": "Mr."
},
{
"type": "FieldValue",
"id": "100023"
},
{
"type": "FieldValue",
"id": "100024"
},
{
"type": "FieldValue",
"id": "100032",
"value": "CDC13000000000221"
},
{
"type": "FieldValue",
"id": "100033"
},
{
"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": "source-integration"
},
{
"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"
},
{
"type": "FieldValue",
"id": "100069"
},
{
"type": "FieldValue",
"id": "100072"
},
{
"type": "FieldValue",
"id": "100081"
},
{
"type": "FieldValue",
"id": "100171",
"value": "denmark.com"
},
{
"type": "FieldValue",
"id": "100172",
"value": "Fort Fortinbras"
},
{
"type": "FieldValue",
"id": "100174"
},
{
"type": "FieldValue",
"id": "100175"
},
{
"type": "FieldValue",
"id": "100176"
},
{
"type": "FieldValue",
"id": "100177"
},
{
"type": "FieldValue",
"id": "100178"
},
{
"type": "FieldValue",
"id": "100179"
},
{
"type": "FieldValue",
"id": "100180"
},
{
"type": "FieldValue",
"id": "100181",
"value": "4efdd39ac3897aa7e07ace895cf3aa92"
},
{
"type": "FieldValue",
"id": "100182",
"value": "bb3b073c9378cbea219aba5ec912f6503317e5c42ba827449fbb45b7632bcc6c"
},
{
"type": "FieldValue",
"id": "100183",
"value": "9c68e0364c733a3fc0b04e0d54f5aa40"
},
{
"type": "FieldValue",
"id": "100184",
"value": "268c7391c9934c2ec13fff24666e2ecc3549102dcc32acb69b3ec1f23d9c30db"
},
{
"type": "FieldValue",
"id": "100185",
"value": "d8e16887c9fb9f65a56d3ab4d824845a"
},
{
"type": "FieldValue",
"id": "100186",
"value": "a4550c88a73d99ba2a2525e85fb1ddd958ae84a5dcadd557c9db7f6c881c0dd5"
},
{
"type": "FieldValue",
"id": "100187"
},
{
"type": "FieldValue",
"id": "100188",
"value": "FortFortinbrasL888M4"
},
{
"type": "FieldValue",
"id": "100190"
},
{
"type": "FieldValue",
"id": "100191"
},
{
"type": "FieldValue",
"id": "100192"
},
{
"type": "FieldValue",
"id": "100193"
},
{
"type": "FieldValue",
"id": "100194"
},
{
"type": "FieldValue",
"id": "100195"
},
{
"type": "FieldValue",
"id": "100196"
},
{
"type": "FieldValue",
"id": "100197"
},
{
"type": "FieldValue",
"id": "100198"
},
{
"type": "FieldValue",
"id": "100199"
},
{
"type": "FieldValue",
"id": "100200"
},
{
"type": "FieldValue",
"id": "100201"
},
{
"type": "FieldValue",
"id": "100202"
},
{
"type": "FieldValue",
"id": "100203"
},
{
"type": "FieldValue",
"id": "100204"
},
{
"type": "FieldValue",
"id": "100205"
},
{
"type": "FieldValue",
"id": "100206"
},
{
"type": "FieldValue",
"id": "100207"
},
{
"type": "FieldValue",
"id": "100208"
},
{
"type": "FieldValue",
"id": "100209"
},
{
"type": "FieldValue",
"id": "100210"
}
],
"firstName": "Fort",
"isBounceback": "false",
"isSubscribed": "true",
"lastName": "Fortinbras",
"mobilePhone": "2540312887",
"postalCode": "2620",
"province": "Malmo",
"salesPerson": "Hamlet",
"subscriptionDate": "1524057264",
"title": "Actor"
}