Create an account
post
/api/REST/1.0/data/account
Creates an account that matches the criteria specified by the request body.
Request
Supported Media Types
- application/json
The request body defines the details of the account to be created.
Root Schema : Account
Type:
object
Title:
Show Source
Account
-
address1:
string
The account's first address.
-
address2:
string
The account's second address.
-
address3:
string
The account's third address.
-
businessPhone:
string
The account's business phone number.
-
city:
string
The account's city.
-
country:
string
The account's country.
-
createdAt:
string
Read Only:
true
The date and time the account was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the account. -
crmSystemMappings:
array crmSystemMappings
Lists CRM Users linked to the Account. Each
crmSystemMappings
contains atype
,CRMUsername
(s), and EloqualoginName
values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to thelinkUsers
parameter in this tutorial. This property is also only returned when the request depth iscomplete
. -
currentStatus:
string
The account'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 account.
-
fieldValues:
array fieldValues
Array containing
type
andid
values for all of the accountFields associated with a given account. -
id:
string
Read Only:
true
Id of the account. This is a read-only property. -
name:
string
The name of the account.
-
permissions:
string
The permissions for the account granted to your current instance. This is a read-only property.
-
postalCode:
string
The account's postal code.
-
province:
string
The account's province.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the account was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the account.
Nested Schema : crmSystemMappings
Type:
array
Lists CRM Users linked to the Account. Each
Show Source
crmSystemMappings
contains a type
, CRMUsername
(s), and Eloqua loginName
values for all of the Eloqua Users linked to the Account.
This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the linkUsers
parameter in this tutorial.
This property is also only returned when the request depth is complete
.-
Array of:
object CrmSystemMapping
Title:
CrmSystemMapping
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
and id
values for all of the accountFields associated with a given account.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : CrmSystemMapping
Type:
object
Title:
Show Source
CrmSystemMapping
-
createdAt:
string
Read Only:
true
-
createdBy:
string
Read Only:
true
-
currentStatus:
string
-
depth:
string
Read Only:
true
-
description:
string
-
id:
string
Read Only:
true
-
loginName:
string
-
MSDUserName:
string
-
name:
string
-
OSCUserName:
string
-
permissions:
string
-
SFDCUserName:
string
-
SODUserName:
string
-
type:
string
-
updatedAt:
string
Read Only:
true
-
updatedBy:
string
Read Only:
true
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 : Account
Type:
object
Title:
Show Source
Account
-
address1:
string
The account's first address.
-
address2:
string
The account's second address.
-
address3:
string
The account's third address.
-
businessPhone:
string
The account's business phone number.
-
city:
string
The account's city.
-
country:
string
The account's country.
-
createdAt:
string
Read Only:
true
The date and time the account was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the account. -
crmSystemMappings:
array crmSystemMappings
Lists CRM Users linked to the Account. Each
crmSystemMappings
contains atype
,CRMUsername
(s), and EloqualoginName
values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to thelinkUsers
parameter in this tutorial. This property is also only returned when the request depth iscomplete
. -
currentStatus:
string
The account'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 account.
-
fieldValues:
array fieldValues
Array containing
type
andid
values for all of the accountFields associated with a given account. -
id:
string
Read Only:
true
Id of the account. This is a read-only property. -
name:
string
The name of the account.
-
permissions:
string
The permissions for the account granted to your current instance. This is a read-only property.
-
postalCode:
string
The account's postal code.
-
province:
string
The account's province.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the account was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the account.
Nested Schema : crmSystemMappings
Type:
array
Lists CRM Users linked to the Account. Each
Show Source
crmSystemMappings
contains a type
, CRMUsername
(s), and Eloqua loginName
values for all of the Eloqua Users linked to the Account.
This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the linkUsers
parameter in this tutorial.
This property is also only returned when the request depth is complete
.-
Array of:
object CrmSystemMapping
Title:
CrmSystemMapping
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
and id
values for all of the accountFields associated with a given account.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : CrmSystemMapping
Type:
object
Title:
Show Source
CrmSystemMapping
-
createdAt:
string
Read Only:
true
-
createdBy:
string
Read Only:
true
-
currentStatus:
string
-
depth:
string
Read Only:
true
-
description:
string
-
id:
string
Read Only:
true
-
loginName:
string
-
MSDUserName:
string
-
name:
string
-
OSCUserName:
string
-
permissions:
string
-
SFDCUserName:
string
-
SODUserName:
string
-
type:
string
-
updatedAt:
string
Read Only:
true
-
updatedBy:
string
Read Only:
true
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 account:
POST /api/REST/1.0/data/account
Content-Type: application/json
Request body:
{
"name":"Hudsucker Industries",
"address1":"2020 Broadway Ave.",
"city":"New York",
"country":"United States"
}
Response:
{
"type":"Account",
"id":"14",
"createdAt":"1433527975",
"depth":"complete",
"description":"",
"name":"Hudsucker Industries",
"updatedAt":"1433527975",
"address1":"2020 Broadway Ave.",
"address2":"",
"address3":"",
"businessPhone":"",
"city":"New York",
"country":"United States",
"fieldValues":[],
"postalCode":"",
"province":""
}