Create an account group
post
/api/rest/2.0/assets/account/group
Creates an account group that matches the criteria specified by the request body.
Request
Supported Media Types
- application/json
The request body defines the details of the account group to be created.
Root Schema : AccountGroup
Type:
object
Title:
Show Source
AccountGroup
-
count:
string
The number of companies within the account group. This is a read-only property.
-
createdAt:
string
Read Only:
true
The date and time the account group was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the account group. -
createdByName:
string
The name of the user who created the account group.
-
currentStatus:
string
The account group's current status. This is a read-only property.
-
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 group.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the account group. -
id:
string
Read Only:
true
Id of the account group. -
isArchived:
string
The account group is archived or not. This is a read-only property.
-
name:
string
The account group's name.
-
permissions:
array permissions
The permissions for the account group granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date the account group is scheduled. -
sourceTemplateId:
string
Id of the template used to create the account group.
-
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 group was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the account group. -
updatedByName:
string
The name of the user who last updated the account group.
Nested Schema : permissions
Type:
array
The permissions for the account group granted to your current instance. This is a read-only property.
Show Source
Response
Supported Media Types
- application/json
201 Response
Success
Root Schema : AccountGroup
Type:
object
Title:
Show Source
AccountGroup
-
count:
string
The number of companies within the account group. This is a read-only property.
-
createdAt:
string
Read Only:
true
The date and time the account group was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the account group. -
createdByName:
string
The name of the user who created the account group.
-
currentStatus:
string
The account group's current status. This is a read-only property.
-
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 group.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the account group. -
id:
string
Read Only:
true
Id of the account group. -
isArchived:
string
The account group is archived or not. This is a read-only property.
-
name:
string
The account group's name.
-
permissions:
array permissions
The permissions for the account group granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
The date the account group is scheduled. -
sourceTemplateId:
string
Id of the template used to create the account group.
-
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 group was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the account group. -
updatedByName:
string
The name of the user who last updated the account group.
Nested Schema : permissions
Type:
array
The permissions for the account group granted to your current instance. This is a read-only property.
Show Source
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 an account group:
POST /api/REST/2.0/assets/account/group
Request body:
{
"name":"Hudsucker Industries",
"address1":"2020 Broadway Ave.",
"city":"New York",
"country":"United States"
}
Response:
{
"type": "AccountGroup",
"id": "5",
"createdAt": "1474390646",
"createdBy": "9",
"depth": "complete",
"folderId": "49",
"name": "Global Industries",
"permissions": [
"Retrieve",
"SetSecurity",
"Delete",
"Update",
"Activate"
],
"updatedAt": "1474390646",
"updatedBy": "9",
"count": "0",
"isArchived": "False"
}