Show Source

• createdAt(optional): string
  Read Only: true

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

  The login id of the user who created the email group.
• currentStatus(optional): string
  The email group'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 email group.
• displayName(optional): string
  The display name of the email group.
• emailFooterId(optional): string
  Id of the email footer.
• emailHeaderId(optional): string
  Id of the email header.
• emailIds(optional): array emailIds
  Array containing the unique identifiers of the emails in the email group.
• id(optional): string
  Read Only: true

  Id of the email group. This is a read-only property.
• isVisibleInOutlookPlugin(optional): string
  Whether or not the email group is visible in the Outlook plugin.
• isVisibleInPublicSubscriptionList(optional): string
  Whether or not the email group is visible in the public subscriptions list.
• name(optional): string
  The name of the email group.
• permissions(optional): string
  The permissions for the email group granted to your current instance. This is a read-only property.
• subscriptionLandingPageId(optional): string
  Id of the subscription landing page.
• subscriptionListDataLookupId(optional): string
  Id of the subscription list's data lookup.
• subscriptionListId(optional): string
  Id of the subscription list. This is a read-only property.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• unsubscriptionLandingPageId(optional): string
  Id of the unsubscribe landing page.
• unSubscriptionListDataLookupId(optional): string
  Id of the unsubscribe list's data lookup.
• unSubscriptionListId(optional): string
  Id of the unsubscribe list. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

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

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

{
    "title":"EmailGroup",
    "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 group. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The email group's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the email group."
        },
        "description":{
            "type":"string",
            "description":"The description of the email group."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the email group 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 group."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the email group was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the email group."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the email group 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>."
        },
        "emailHeaderId":{
            "type":"string",
            "description":"Id of the email header."
        },
        "emailFooterId":{
            "type":"string",
            "description":"Id of the email footer."
        },
        "subscriptionLandingPageId":{
            "type":"string",
            "description":"Id of the subscription landing page."
        },
        "unsubscriptionLandingPageId":{
            "type":"string",
            "description":"Id of the unsubscribe landing page."
        },
        "isVisibleInPublicSubscriptionList":{
            "type":"string",
            "description":"Whether or not the email group is visible in the public subscriptions list."
        },
        "isVisibleInOutlookPlugin":{
            "type":"string",
            "description":"Whether or not the email group is visible in the Outlook plugin."
        },
        "emailIds":{
            "type":"array",
            "description":"Array containing the unique identifiers of the emails in the email group.",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the email group."
        },
        "subscriptionListId":{
            "type":"string",
            "description":"Id of the subscription list.  This is a read-only property."
        },
        "unSubscriptionListId":{
            "type":"string",
            "description":"Id of the unsubscribe list.  This is a read-only property."
        },
        "subscriptionListDataLookupId":{
            "type":"string",
            "description":"Id of the subscription list's data lookup."
        },
        "unSubscriptionListDataLookupId":{
            "type":"string",
            "description":"Id of the unsubscribe list's data lookup."
        }
    }
}

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array containing the unique identifiers of the emails in the email group.",
    "items":{
        "type":"string"
    }
}