Overview

Skill Level: Intermediate

Step-by-step

  1. Syntax of the request and response XML for GetMessageGroupDetails

    Operation

    <GetMessageGroupDetails>

    Elements

    MESSAGE_GROUP_ID

    Numeric identifier for the Automated Message Group.

    Note: Due to legacy naming conventions, this ID is referred to as CAMPAIGN_ID in older API operations. The Campaign ID returned in the Raw Recipient Data Export file can be used as the MESSAGE_GROUP_ID.
    Example
    <Envelope>
      <Body>
        <GetMessageGroupDetails>
          <MESSAGE_GROUP_ID>59294</MESSAGE_GROUP_ID>
        </GetMessageGroupDetails>
      </Body>
    </Envelope>
    
    Response

    <RESULT>

    Elements

    SUCCESS

    True if successful.

      USER_ID

    The user that created the Message group.

      NAME

    The name of the Automated Message Group.

      STATUS

    • Draft
    • Active
    • Canceled
    • Completed
      NOTES

    Optional Notes describing the Automated Message Group.
      LIST_ID

    The ID of the database, contact list, or query associated with the Message Group.

      EVENT_TRIGGER

    Indicates the event trigger for the automated messages. Possible values are:

    • OptInDate
    • CustomEventDate
    • CalendarDate
    • Recurring
    • Transact
    • None
      TRACKING_LEVEL

    The tracking level for the automated messages. Possible values are:

    • Unique
    • Aggregate
    • Open Only
    • None
      CUSTOM_EVENT_DATE_COLUMN

    When the EVENT_TRIGGER is “CustomEventDate”, this element indicates the name of the database column that contains the date. The date determines when the automated mailing is sent.

      CALENDAR_DATE

    When the EVENT_TRIGGER is “CalendarDate”, this element indicates the date that the automated mailing is sent.

      SEND_PREVIOUS

    When the EVENT_TRIGGER is date-based, this element indicates whether new contacts are sent all previously delivered mailings. Valid values are:

    • true
    • false
      ACTIVATION_DATE

    The date that the Automated Message Group was activated. This element does not contain a value when STATUS is “Draft”.

      COMPLETION_DATE

    The date that automated mailings are no longer triggered.

     
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>TRUE</SUCCESS>
          <USER_ID>12c734c-108b610e402-f528764d624db129b32c21fbca0cb8d6</USER_ID>
          <NAME>Welcome Campaign</NAME>
          <STATUS>Active</STATUS>
          <NOTES>Mailings are sent when subscription begins.</NOTES>
          <LIST_ID>56432</LIST_ID>
          <EVENT_TRIGGER>CustomEventDate</EVENT_TRIGGER>
          <TRACKING_LEVEL>Unique</TRACKING_LEVEL>
          <CUSTOM_EVENT_DATE_COLUMN>MagazineSubscription Date</CUSTOM_EVENT_DATE_COLUMN>
          <ACTIVATION_DATE>01/29/2011</ACTIVATION_DATE>
          <COMPLETION_DATE>12/31/2011</COMPLETION_DATE>
        </RESULT>
      </Body>
    </Envelope>
    

Join The Discussion

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