REST API - Email Groups

Version 2

    The REST API supports retrieve operations for Email Groups.

     

    Accessing Email Groups

    • GET     /assets/email/group/{id}?depth={depth}

     

    Response

    The response for this call looks as follows :

     

    {
          "type": "EmailGroup",
          "x_e10_isTemplate": "false",
          "x_e10_templateIcon": "",
          "x_e10_createdAt": "1316025882",
          "x_e10_createdBy": "44",
          "id": "9",
          "createdAt": "1297453870",
          "createdBy": "44",
          "depth": "minimal",
          "description": "",
          "name": "0 - Eloqua Emails",
          "permissions": "fullControl",
          "updatedAt": "1316025882",
          "updatedBy": "44"
        }
    

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"EmailGroup"
    displayNamestring
    emailFooterIdintegerIdRequirement
    emailHeaderIdintegerIdRequirement
    emailIdsList of string
    isVisibleInOutlookPluginbooleanBoolean
    Requirement
    isVisibleInPublicSubscriptionListbooleanBoolean
    Requirement
    subscriptionLandingPageIdintegerIdRequirement
    subscriptionListDataLookupIdstring
    subscriptionListIdintegerIdRequirement
    unsubscriptionLandingPageIdintegerIdRequirement
    unSubscriptionListDataLookupIdstring
    unSubscriptionListIdintegerIdRequirement
    accessedAtintegerDate
    Requirement
    createdAtintegerReadOnlyDate
    Requirement
    createdByintegerReadOnlyIdRequirement
    currentStatusstring
    depthRequestDepthEnum
    Requirement
    descriptionstring
    folderIdintegerIdRequirement
    idintegerThe unique identifier of the Email GroupIdRequirement
    namestring
    permissionsInstance
    Permission
    Enum
    Requirement
    updatedAtintegerReadOnlyDate
    Requirement
    updatedByintegerReadOnlyIdRequirement

     

    Related Operations

    • GET  /assets/email/groups?depth={depth}&count={count}&page={page}&search={search}&orderBy={orderBy}&lastUpdatedAt={lastUpdatedAt}

     

    We hope that you find this helpful and please let us know if you need more information.

     

    Thanks,

    Fred