Overview

Skill Level: Any

Step-by-step

  1. Syntax of the request and response XML for GetSentMailingsForUser

    If the calling user is an Org Admin, all users’ mailings are returned. Use the OPTIONALUSER parameter and an Org Admin can specify a particular username to retrieve only mailings that are sent by that user.

    Operation

    <GetSentMailingsForUser>

    Elements DATE_START Required Starting Date in the format ‘mm/dd/yy hh:mm:ss’
     

    DATE_END

    Required Ending Date in the format “mm/dd/yyyy hh:mm:ss”

     

    OPTIONALUSER

    If the calling user is an Org Admin, all users’ mailings are returned. Use the OPTIONALUSER parameter and an Org Admin can specify a particular username to retrieve only mailings that are sent
    by that user.

     

    PRIVATE

    Optional parameter to retrieve private mailings. If the API does not receive a private or shared designation, the Acoustic Campaign returns both private and shared mailings.

     

    SHARED

    Optional parameter to retrieve shared mailings.

     

    SCHEDULED

    Optional Mailing Type parameter to retrieve scheduled mailings. Acoustic Campaign returns mailings of all types when the API does not receive a mailing type designation.

     

    SENT

    Optional Mailing Type parameter to retrieve sent mailings.

     

    SENDING

    Optional Mailing Type parameter to retrieve mailings that are sending.

     

    OPTIN_CONFIRMATION

    Optional Mailing Type parameter to retrieve Opt-in Autoresponder mailings.

     

    PROFILE_CONFIRMATION

    Optional Mailing Type parameter to retrieve Edit Profile Autoresponder mailings.

     

    AUTOMATED

    Optional Mailing Type parameter to retrieve Custom Autoresponder mailings.

     

    CAMPAIGN_ACTIVE

    Optional Mailing Type parameter to retrieve active Groups of Automated Messages.

     

    CAMPAIGN_COMPLETED

    Optional Mailing Type parameter to retrieve completed Groups of Automated Messages.

     

    CAMPAIGN_CANCELLED

    Optional Mailing Type parameter to retrieve canceled Groups of Automated Messages.

     

    CAMPAIGN_SCRAPE_TEMPLATE

    Optional Mailing Type parameter to retrieve Campaign Scrape Template mailings.

     

    INCLUDE_TAGS

    Optional parameter to return all Tags that are associated with the Sent mailing.

     

    EXCLUDE_ZERO_SENT

    Optional parameter to exclude mailings with no contacts.

     

    MAILING_COUNT_ONLY

    Optional parameter to return only the count of sent mailings for a specific date range.

     

    EXCLUDE_TEST_MAILINGS

    Optional parameter that requests to exclude Test Mailings. If you do not provide this element, the Acoustic Campaign includes all Test Mailings.

    Example
    <Envelope>
      <Body>
        <GetSentMailingsForUser>
          <PRIVATE/>
          <SENT/>
          <DATE_START>07/25/201100:00:00</DATE_START>
          <DATE_END>09/30/201123:59:59</DATE_END>
          <OPTIONALUSER>name@domain.com</OPTIONALUSER>
        </GetSentMailingsForUser>
      </Body>
    </Envelope>
    
    Response <RESULT>
    Elements SUCCESS

    True if successful.

      Mailing

    XML nodes that define the instances of the sent mailing.

      ChildElement

    MailingId

    Returns the Mailing ID.
        ParentTemplateId Returns the parent mailing ID for the mailing
       

    ReportId

    Returns the report ID for an instance of an automated mailing.

       

    ScheduledTS

    Returns the scheduled date and time in the following format: “mm/dd/yy hh:mm AMPM”

       

    MailingName

    Returns the mailing name.

       

    ListName

    Returns the database name.

       

    ListId

    Returns the ID of the database or query that the mailing was sent to.

       

    ParentListId

    Returns the ID of the parent database when the mailing was sent to a query. If the mailing was not sent to a query, this element is empty.

       

    UserName

    Returns the user name for the mailing owner.

       

    SentTS

    Returns the date/time when Acoustic Campaign sent the mailing.

       

    NumSent

    Returns the number of contacts to whom Acoustic Campaign sent the mailing.

       

    SentMailingsCount

    Returns the number of sent mailings.

       

    Subject

    Returns the mailing subject.

       

    Visibility

    Returns visibility information about the mailing. Values are Private or Shared.

       

    Tags

    If INCLUDE_TAGS is specified in the request, return any tags that are associated with the Sent mailing.

          Tag XML nodes that contain the Tags that are associated with the Sent mailing.
    Example 1 with standard usage
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>TRUE</SUCCESS>
          <Mailing>
            <MailingId>5758</MailingId>
            <ReportId>109118</ReportId>
            <ScheduledTS>201-06-14 10:54:06.0</ScheduledTS>
            <MailingName>
              <![CDATA[This is the mailingname]]>
            </MailingName>
            <ListName>
              <![CDATA[This is the databasename]]>
            </ListName>
            <ListId>4615</ListId>
            <UserName> John Doe </UserName>
            <SentTS/>
            <NumSent>0</NumSent>
            <Subject>
              <![CDATA[SummerSale]]>
            </Subject>
            <Visibility>Private</Visibility>
          </Mailing>
          <Mailing>
            <MailingId>5758</MailingId>
            <ReportId>109118</ReportId>
            <ScheduledTS>2011-06-14 10:54:06.0</ScheduledTS>
            <MailingName>
              <![CDATA[My Mailing 2]]>
            </MailingName>
            <ListName>
              <![CDATA[This is the databasename 2]]>
            </ListName>
            <ListId>4616</ListId>
            <UserName>John Doe</UserName>
            <SentTS/>
            <NumSent>0</NumSent>
            <Subject>
              <![CDATA[SummerSale]]>
            </Subject>
            <Visibility>Private</Visibility>
          </Mailing>
        </RESULT>
      </Body>
    </Envelope>
    
    Example 2 when MAILING_COUNT_ONLY parameter is used.
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>TRUE</SUCCESS>
          <Mailing>
            <SentMailingsCount>5758</SentMailingsCount>
          </Mailing>
        </RESULT>
      </Body>
    </Envelope>
    

Join The Discussion

Your email address will not be published. Required fields are marked *