Update an email header
put
/api/REST/1.0/assets/email/header/{id}
Updates the email header 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 header to update.
The request body defines the details of the email header to be created.
Root Schema : EmailHeader
Type:
object
Title:
Show Source
EmailHeader
-
body:
string
The email header's html text content.
-
createdAt:
string
Read Only:
true
The date and time the email header was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the email header. -
currentStatus:
string
The asset'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 email header.
-
fieldMerges:
array fieldMerges
A list of associated Field Merges.
-
hyperlinks:
array hyperlinks
A list of hyperlinks contained within the asset.
-
id:
string
Read Only:
true
Id of the email header. This is a read-only property. -
name:
string
The name of the email header.
-
permissions:
string
The permissions for the email header granted to your current instance. This is a read-only property.
-
text:
string
The raw text from the "body" parameter.
-
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 email header was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the email header.
Nested Schema : fieldMerges
Type:
array
A list of associated Field Merges.
Show Source
-
Array of:
object FieldMerge
Title:
FieldMerge
Nested Schema : hyperlinks
Type:
array
A list of hyperlinks contained within the asset.
Show Source
-
Array of:
object Hyperlink
Title:
Hyperlink
Nested Schema : FieldMerge
Type:
object
Title:
Show Source
FieldMerge
-
accountFieldId:
string
Id of the associated account field.
-
contactFieldId:
string
Id of the associated contact field.
-
createdAt:
string
Read Only:
true
The date and time the field merge was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the field merge. -
currentStatus:
string
The field merge's current status.
-
defaultValue:
string
The default value of the field merge.
-
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 field merge.
-
eventFieldId:
string
Id of the associated event field.
-
eventId:
string
Id of the associated event.
-
eventSessionFieldId:
string
Id of the associated event session field.
-
id:
string
Read Only:
true
Id of the field merge. This is a read-only property. -
mergeType:
string
Type of the field merge. Possible values include:
contactField
,accountField
,eventField
,eventSessionField
, andcustomObjectField
. -
name:
string
Name of the field merge.
-
permissions:
string
The permissions for the field merge granted to your current instance.
-
syntax:
string
The syntax of the field merge.
-
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 field merge was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the field merge.
Nested Schema : Hyperlink
Type:
object
Title:
Show Source
Hyperlink
-
createdAt:
string
Read Only:
true
The date and time the hyperlink was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the hyperlink. -
currentStatus:
string
The hyperlink'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 hyperlink.
-
href:
string
Href value of the hyperlink.
-
hyperlinkType:
string
The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.
-
id:
string
Read Only:
true
Id of the hyperlink. This is a read-only property. -
name:
string
Name of the hyperlink.
-
permissions:
string
The permissions for the hyperlink granted to your current instance.
-
referencedEntityId:
string
Id of the referenced entity.
-
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 hyperlink was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the hyperlink.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : EmailHeader
Type:
object
Title:
Show Source
EmailHeader
-
body:
string
The email header's html text content.
-
createdAt:
string
Read Only:
true
The date and time the email header was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the email header. -
currentStatus:
string
The asset'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 email header.
-
fieldMerges:
array fieldMerges
A list of associated Field Merges.
-
hyperlinks:
array hyperlinks
A list of hyperlinks contained within the asset.
-
id:
string
Read Only:
true
Id of the email header. This is a read-only property. -
name:
string
The name of the email header.
-
permissions:
string
The permissions for the email header granted to your current instance. This is a read-only property.
-
text:
string
The raw text from the "body" parameter.
-
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 email header was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the email header.
Nested Schema : fieldMerges
Type:
array
A list of associated Field Merges.
Show Source
-
Array of:
object FieldMerge
Title:
FieldMerge
Nested Schema : hyperlinks
Type:
array
A list of hyperlinks contained within the asset.
Show Source
-
Array of:
object Hyperlink
Title:
Hyperlink
Nested Schema : FieldMerge
Type:
object
Title:
Show Source
FieldMerge
-
accountFieldId:
string
Id of the associated account field.
-
contactFieldId:
string
Id of the associated contact field.
-
createdAt:
string
Read Only:
true
The date and time the field merge was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the field merge. -
currentStatus:
string
The field merge's current status.
-
defaultValue:
string
The default value of the field merge.
-
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 field merge.
-
eventFieldId:
string
Id of the associated event field.
-
eventId:
string
Id of the associated event.
-
eventSessionFieldId:
string
Id of the associated event session field.
-
id:
string
Read Only:
true
Id of the field merge. This is a read-only property. -
mergeType:
string
Type of the field merge. Possible values include:
contactField
,accountField
,eventField
,eventSessionField
, andcustomObjectField
. -
name:
string
Name of the field merge.
-
permissions:
string
The permissions for the field merge granted to your current instance.
-
syntax:
string
The syntax of the field merge.
-
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 field merge was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the field merge.
Nested Schema : Hyperlink
Type:
object
Title:
Show Source
Hyperlink
-
createdAt:
string
Read Only:
true
The date and time the hyperlink was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the hyperlink. -
currentStatus:
string
The hyperlink'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 hyperlink.
-
href:
string
Href value of the hyperlink.
-
hyperlinkType:
string
The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.
-
id:
string
Read Only:
true
Id of the hyperlink. This is a read-only property. -
name:
string
Name of the hyperlink.
-
permissions:
string
The permissions for the hyperlink granted to your current instance.
-
referencedEntityId:
string
Id of the referenced entity.
-
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 hyperlink was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the hyperlink.
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 name and body text of the email header with Id #11:
PUT /api/REST/1.0/assets/email/folder/11
Content-Type: application/json
Request body:
{
"name":"Test NEW Update Header",
"id":"11",
"body":"<p>Here is some new text.</p>"
}
Response:
{
"type":"EmailHeader",
"id":"11",
"initialId":"11",
"createdAt":"1432564733",
"createdBy":"19",
"depth":"complete",
"folderId":"314",
"name":"Test NEW Update Header",
"permissions":"fullControl",
"updatedAt":"1432564773",
"updatedBy":"19",
"body":"<p>Here is some new text.</p>",
"fieldMerges":[],
"hyperlinks":[],
"text":"Here is some new text."
}