Jump to

• Request
• Response
• Examples

Retrieve an email header

get

/api/REST/1.0/assets/email/header/{id}

Retrieves the email header specified by the id parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id: integer
  Id of the email header to be retrieved.

Query Parameters

• depth(optional): string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : EmailHeader

Type: object

Title: EmailHeader

Show Source

• body(optional): string
  The email header's html text content.
• createdAt(optional): string
  Read Only: true

  The date and time the email header was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the email header.
• currentStatus(optional): string
  The asset's current status. This is a read-only property.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the email header.
• fieldMerges(optional): array fieldMerges
  A list of associated Field Merges.
• hyperlinks(optional): array hyperlinks
  A list of hyperlinks contained within the asset.
• id(optional): string
  Read Only: true

  Id of the email header. This is a read-only property.
• name(optional): string
  The name of the email header.
• permissions(optional): string
  The permissions for the email header granted to your current instance. This is a read-only property.
• text(optional): string
  The raw text from the "body" parameter.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the email header was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the email header.

{
    "title":"EmailHeader",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the email header. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The asset's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The name of the email header."
        },
        "description":{
            "type":"string",
            "description":"The description of the email header."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the email header granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the email header."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the email header was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the email header."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the email header was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "body":{
            "type":"string",
            "description":"The email header's html text content."
        },
        "text":{
            "type":"string",
            "description":"The raw text from the \"body\" parameter."
        },
        "fieldMerges":{
            "type":"array",
            "description":"A list of associated Field Merges.",
            "items":{
                "$ref":"#/definitions/FieldMergeRest10"
            }
        },
        "hyperlinks":{
            "type":"array",
            "description":"A list of hyperlinks contained within the asset.",
            "items":{
                "$ref":"#/definitions/HyperlinkRest10"
            }
        }
    }
}

Nested Schema : fieldMerges

Type: array

A list of associated Field Merges.

Show Source

• Array of: object FieldMerge
  Title: FieldMerge

{
    "type":"array",
    "description":"A list of associated Field Merges.",
    "items":{
        "$ref":"#/definitions/FieldMergeRest10"
    }
}

Nested Schema : hyperlinks

Type: array

A list of hyperlinks contained within the asset.

Show Source

• Array of: object Hyperlink
  Title: Hyperlink

{
    "type":"array",
    "description":"A list of hyperlinks contained within the asset.",
    "items":{
        "$ref":"#/definitions/HyperlinkRest10"
    }
}

Nested Schema : FieldMerge

Type: object

Title: FieldMerge

Show Source

• accountFieldId(optional): string
  Id of the associated account field.
• contactFieldId(optional): string
  Id of the associated contact field.
• createdAt(optional): string
  Read Only: true

  The date and time the field merge was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the field merge.
• currentStatus(optional): string
  The field merge's current status.
• defaultValue(optional): string
  The default value of the field merge.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the field merge.
• eventFieldId(optional): string
  Id of the associated event field.
• eventId(optional): string
  Id of the associated event.
• eventSessionFieldId(optional): string
  Id of the associated event session field.
• id(optional): string
  Read Only: true

  Id of the field merge. This is a read-only property.
• mergeType(optional): string
  Type of the field merge. Possible values include: contactField, accountField, eventField, eventSessionField, and customObjectField.
• name(optional): string
  Name of the field merge.
• permissions(optional): string
  The permissions for the field merge granted to your current instance.
• syntax(optional): string
  The syntax of the field merge.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the field merge was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the field merge.

{
    "title":"FieldMerge",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the field merge. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The field merge's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the field merge."
        },
        "description":{
            "type":"string",
            "description":"The description of the field merge."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the field merge granted to your current instance."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the field merge."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the field merge was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the field merge."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the field merge was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "syntax":{
            "type":"string",
            "description":"The syntax of the field merge."
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the field merge."
        },
        "contactFieldId":{
            "type":"string",
            "description":"Id of the associated contact field."
        },
        "accountFieldId":{
            "type":"string",
            "description":"Id of the associated account field."
        },
        "eventId":{
            "type":"string",
            "description":"Id of the associated event."
        },
        "eventFieldId":{
            "type":"string",
            "description":"Id of the associated event field."
        },
        "eventSessionFieldId":{
            "type":"string",
            "description":"Id of the associated event session field."
        },
        "mergeType":{
            "type":"string",
            "description":"Type of the field merge. Possible values include: <code>contactField</code>, <code>accountField</code>, <code>eventField</code>, <code>eventSessionField</code>, and <code>customObjectField</code>."
        }
    }
}

Nested Schema : Hyperlink

Type: object

Title: Hyperlink

Show Source

• createdAt(optional): string
  Read Only: true

  The date and time the hyperlink was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the hyperlink.
• currentStatus(optional): string
  The hyperlink's current status.
• depth(optional): string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description(optional): string
  The description of the hyperlink.
• href(optional): string
  Href value of the hyperlink.
• hyperlinkType(optional): string
  The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL.
• id(optional): string
  Read Only: true

  Id of the hyperlink. This is a read-only property.
• name(optional): string
  Name of the hyperlink.
• permissions(optional): string
  The permissions for the hyperlink granted to your current instance.
• referencedEntityId(optional): string
  Id of the referenced entity.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the hyperlink was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the hyperlink.

{
    "title":"Hyperlink",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the hyperlink. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The hyperlink's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the hyperlink."
        },
        "description":{
            "type":"string",
            "description":"The description of the hyperlink."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the hyperlink granted to your current instance."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the hyperlink."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the hyperlink was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the hyperlink."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the hyperlink was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "href":{
            "type":"string",
            "description":"Href value of the hyperlink."
        },
        "hyperlinkType":{
            "type":"string",
            "description":"The type of hyperlink. Possible values include: ExternalURL, ICSCalendarURL, LandingPageURL, ReferrerURL, RSSURL, or TrackedExternalURL."
        },
        "referencedEntityId":{
            "type":"string",
            "description":"Id of the referenced entity."
        }
    }
}

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.

Back to Top

Examples

Retrieve the email header asset with Id #11:

GET /api/REST/1.0/assets/email/header/11?depth=complete
			

Response:

{
    "type":"EmailHeader",
    "id":"11",
    "depth":"complete",
    "folderId":"1",
    "name":"Default Email Header",
    "permissions":"fullControl",
    "updatedAt":"1243267870",
    "body":"<TABLE width="550" class="emailheader" align="center"><TBODY><TR><TD align="middle"><FONT face="Arial" size="1">Header text.</FONT></TD></TR></TBODY></TABLE>",
    "fieldMerges":[],
    "hyperlinks":[],
    "text":"Header text."
}
			

Back to Top