Create an email footer
post
/api/REST/1.0/assets/email/footer
Creates an email footer that matches the criteria specified by the request body.
Request
Supported Media Types
- application/json
The request body defines the details of the email footer to be created.
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
201 Response
Success.
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
Create a new email footer:
POST /api/REST/1.0/assets/email/footer
Content-Type: application/json
Request body:
{
"name":"Test Footer",
"body":"<p>Here is some text.</p>"
}
Response:
{
"type": "EmailFooter",
"id": "13",
"createdAt": "1469450883",
"createdBy": "9",
"depth": "complete",
"folderId": "1271",
"name": "Test Footer",
"permissions": "fullControl",
"updatedAt": "1469450883",
"updatedBy": "9",
"body": "<p>Here is some text.</p>",
"fieldMerges": [],
"hyperlinks": [],
"text": "\r\nHere is some text.\r\n\r\n"
}