Update an email group
put
/api/REST/1.0/assets/email/group/{id}
Updates the email group specified by the
id
parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Id of the email group to update.
The request body defines the details of the email group to be updated.
Root Schema : EmailGroup
Type:
object
Title:
Show Source
EmailGroup
-
createdAt:
string
Read Only:
true
The date and time the email group was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the email group. -
currentStatus:
string
The email group'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 email group.
-
displayName:
string
The display name of the email group.
- emailFooterId: string
-
emailHeaderId:
string
Id of the email header.
-
emailIds:
array emailIds
Array containing the unique identifiers of the emails in the email group.
-
id:
string
Read Only:
true
Id of the email group. This is a read-only property. -
isVisibleInOutlookPlugin:
string
Whether or not the email group is visible in the Outlook plugin.
-
isVisibleInPublicSubscriptionList:
string
Whether or not the email group is visible in the public subscriptions list.
-
name:
string
The name of the email group.
-
permissions:
string
The permissions for the email group granted to your current instance. This is a read-only property.
-
subscriptionLandingPageId:
string
Id of the subscription landing page.
-
subscriptionListDataLookupId:
string
Id of the subscription list's data lookup.
-
subscriptionListId:
string
Id of the subscription list. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
unsubscriptionLandingPageId:
string
Id of the unsubscribe landing page.
-
unSubscriptionListDataLookupId:
string
Id of the unsubscribe list's data lookup.
-
unSubscriptionListId:
string
Id of the unsubscribe list. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the email group was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the email group.
Nested Schema : emailIds
Type:
array
Array containing the unique identifiers of the emails in the email group.
Show Source
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : EmailGroup
Type:
object
Title:
Show Source
EmailGroup
-
createdAt:
string
Read Only:
true
The date and time the email group was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the email group. -
currentStatus:
string
The email group'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 email group.
-
displayName:
string
The display name of the email group.
- emailFooterId: string
-
emailHeaderId:
string
Id of the email header.
-
emailIds:
array emailIds
Array containing the unique identifiers of the emails in the email group.
-
id:
string
Read Only:
true
Id of the email group. This is a read-only property. -
isVisibleInOutlookPlugin:
string
Whether or not the email group is visible in the Outlook plugin.
-
isVisibleInPublicSubscriptionList:
string
Whether or not the email group is visible in the public subscriptions list.
-
name:
string
The name of the email group.
-
permissions:
string
The permissions for the email group granted to your current instance. This is a read-only property.
-
subscriptionLandingPageId:
string
Id of the subscription landing page.
-
subscriptionListDataLookupId:
string
Id of the subscription list's data lookup.
-
subscriptionListId:
string
Id of the subscription list. This is a read-only property.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
unsubscriptionLandingPageId:
string
Id of the unsubscribe landing page.
-
unSubscriptionListDataLookupId:
string
Id of the unsubscribe list's data lookup.
-
unSubscriptionListId:
string
Id of the unsubscribe list. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the email group was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the email group.
Nested Schema : emailIds
Type:
array
Array containing the unique identifiers of the emails in the email group.
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
Update the email group with Id #20:
PUT /api/REST/1.0/assets/email/group/20
Content-Type: application/json
Request body:
{
"type":"EmailGroup",
"id": "20",
"depth":"minimal",
"name":"New Group Name",
"emailFooterId":"1",
"emailHeaderId":"2",
"emailIds":[
"61",
"57",
"58",
"61",
"62",
"59"
],
"isVisibleInOutlookPlugin":"true",
}
Response:
{
"type":"EmailGroup",
"id":"20",
"initialId":"20",
"createdAt":"1432303955",
"createdBy":"19",
"depth":"minimal",
"name":"New Group Name",
"permissions":"fullControl",
"updatedAt":"1432304656",
"updatedBy":"19"
}