Knowledge Base

GridRequests - Mailings

  • Updated

These requests retrieve information about various aspects of mailings.

Mailing

This request retrieves information about mailings, irrespective of whether they have been published. It can be used to populate a listing or to get details about a mailing. The data elements apply to the Request and the Response.

Data Element Type Length Conditional Description
accounting_code String 50 True The internal bill-back code used to allocate mailing costs. (The Accounting Codes extension must be enabled.)
Count Int   False Number of matches based upon criteria.
create_date DateTime   True The date and time the mailing was created.
folder_id Int   True Unique folder ID.
folder_name String 50 True The name of the mailing folder.

friendly_from

 String 50 True The "from name" as it appears on the mailing in the recipients in box. This comes from the template.
from_address String 50 True The "from email address" as it appears on the mailing in the recipients Inbox. This comes from the template.
Is_deleted Int   True Flag indicating if the mailing has been deleted.
last_sent_date DateTime   True The date and time the mailing was last sent. (Each publishing of a mailing will yield a mailing instance within Informz.)
MAILING_ID Int     The unique mailing ID in Informz. Use this to retrieve the mailing for editing, for deleting, and for scheduling the mailing for publishing.
modify_email String Int True The email address of the person who last modified the mailing.
modify_user_id Int   True The Subscriber ID of the person who last modified the mailing.
Name String 255 True The internal name of the mailing.
reply_to String 50 True The "reply to email address" where any replies to the original email will be sent.
schedule_choice String   True 1 = Send now; 4 = On hold.
send_at_date DateTime   True DateTime and time of a publishing.
Subject String 255 True The mailing subject line seen by the recipient.
template_id Int   True Unique ID for the template.
template_name String 50 True The name of the template used with the mailing.

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing">
   <ReturnFields>
    <DataElement>accounting_code</DataElement>
    <DataElement>create_date</DataElement>
    <DataElement>folder_id</DataElement>
    <DataElement>folder_name</DataElement>
    <DataElement>friendly_from</DataElement>
    <DataElement>from_address</DataElement>
    <DataElement>is_deleted</DataElement>
    <DataElement>last_sent_date</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>modify_date</DataElement>
    <DataElement>modify_email</DataElement>
    <DataElement>modify_user_id</DataElement>
    <DataElement>name</DataElement>
    <DataElement>reply_to</DataElement>
    <DataElement>schedule_choice</DataElement>
    <DataElement>send_at_date</DataElement>
    <DataElement>subject</DataElement>
    <DataElement>template_id</DataElement>
    <DataElement>template_name</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Notes

Friendly From, From Address, and Reply To come from the template unless specifically overwritten as part of a ScheduleMailing document.

Response

<?xml version="1.0" encoding="utf-16"?>
<GridResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing">
   <Record row="1">
    <Fields>
     <Field element="accounting_code" />
     <Field element="create_date">2011-07-22T21:26:56.4770000Z</Field>
     <Field element="folder_id">4582</Field>
     <Field element="folder_name">FolderName1</Field>
     <Field element="friendly_from">Pineview Registrar</Field>
     <Field element="from_address">registrar@pineview.edu</Field>
     <Field element="is_deleted">0</Field>
     <Field element="last_sent_date" />
     <Field element="mailing_id">132054</Field>
     <Field element="modify_date">2011-07-22T21:26:56.4770000Z</Field>
     <Field element="modify_email">someemail@gmail.com</Field>
     <Field element="modify_user_id" />
     <Field element="name">New Fall Course Offerings</Field>
     <Field element="reply_to">registrar@pineview.edu</Field>
     <Field element="schedule_choice" />
     <Field element="send_at_date" />
     <Field element="subject">Exciting new fall courses</Field>
     <Field element="template_id">12882</Field>
     <Field element="template_name">Template two</Field>
    </Fields>
   </Record>
  </Grid>
 </Grids>
</GridResponse>

Mailing Template

A template has the preconfigured formatting and layout of a mailing and some of its content. If you want to use various layouts, these are presented in a selectable list.

Data Element Type Length Conditional Description
Count Int   False Number of matches based upon criteria.
Name String 50 True Descriptive name.
template_ID Int   True Unique ID for the template.
body_tag_paramaters String 1,000 True Body tag parameters.
Bottom String -1 True Bottom section of template.
head_tags String -1 True Head Tags.
news_format_id String 10 True Unique mailing ID.
use_powered_by_informz Bit   True Display the Powered By Informz logo?
use_standard_footer Bit   True Uses standard footer?
Top String -1 True Top section of template.

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_template">
   <ReturnFields>
    <DataElement>body_tag_paramaters</DataElement>
    <DataElement>bottom</DataElement>
    <DataElement>head_tags</DataElement>
    <DataElement>name</DataElement>
    <DataElement>news_format_id</DataElement>
    <DataElement>use_powered_by_informz</DataElement>
    <DataElement>template_id</DataElement>
    <DataElement>top</DataElement>
    <DataElement>use_standard_footer</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Mailing Instance

Use this request to retrieve information about mailings that were sent on a specified date and/or time.

When a mailing is published, a mailing instance is created. The subject line from the mailing (mailing_subject) is stored with this instance.

Data Element Type Conditional Description
Count Int False Number of matches based upon criteria.
is_test Bit   Flag for testing.
last_resend_date DateTime True Last resend DateTime (if used)
mailing_date DateTime True The DateTime and time when the mailing instance was published.
mailing_id Int True The parent mailing ID to this mailing instance.
mailing_instance_id Int   The unique ID for a mailing instance.
mailing_subject String True The subject of the mailing (255 characters max.).
target_group_id Int True The target group associated with the last publishing.

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="0">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="Mailing_Instance">
   <Conditions>
    <Condition>
     <Collection>
      <DataElement>Mailing_ID</DataElement>
      <DataValue>51223</DataValue>
      <DataValue>51238</DataValue>
      <SetOperator>IN</SetOperator>
     </Collection>
    </Condition>
    <Condition>
     <Single>
      <DataElement>Mailing_Date</DataElement>
      <DataValue>2008-08-04</DataValue>
      <Comparator>GTE</Comparator>
     </Single>
    </Condition>
    <Condition>
     <Single>
      <DataElement>Mailing_Date</DataElement>
      <DataValue>2008-08-11</DataValue>
      <Comparator>LT</Comparator>
     </Single>
    </Condition>
   </Conditions>
   <ReturnFields>
    <DataElement>Mailing_ID</DataElement>
    <DataElement>Mailing_Instance_ID</DataElement>
    <DataElement>Mailing_Date</DataElement>
    <DataElement>Mailing_Subject</DataElement>
   </ReturnFields>
   <SortField order="asc">Mailing_Date</SortField>
   <StartRow>0</StartRow>
   <NumberOfRows>50</NumberOfRows>
  </Grid>
 </Grids>
</GridRequest>

Request for a list of mailings from a single day

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
  <Brand id="9999">Test Brand</Brand>
  <User>testuser</User>
  <Grids>
    <Grid type="mailing_instance">
      <Conditions>
        <Condition>
          <Single>
            <DataElement>Mailing_Date</DataElement>
            <DataValue>2014-06-01</DataValue>
            <Comparator>GTE</Comparator>
          </Single>
        </Condition>
        <Condition>
          <Single>
            <DataElement>Mailing_Date</DataElement>
            <DataValue>2014-06-02</DataValue>
            <Comparator>LT</Comparator>
          </Single>
        </Condition>
      </Conditions>
      <ReturnFields>
        <DataElement>Mailing_ID</DataElement>
        <DataElement>Mailing_Instance_ID</DataElement>
        <DataElement>Mailing_Date</DataElement>
        <DataElement>Mailing_Subject</DataElement>
      </ReturnFields>
      <SortField order="asc">Mailing_Date</SortField>
    </Grid>
  </Grids>
</GridRequest>

Mailing Folder

This request returns a list of mailing folders along with the corresponding ID.

Data Element Type Length Conditional Description
Count Int   False Number of matches based upon criteria.
folder_id Int   True Unique ID.
Name String 100 True Descriptive name.
is_deleted Bit   True  

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="Mailing_Folder">
   <ReturnFields>
    <DataElement>Folder_ID</DataElement>
    <DataElement>Name</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Note

There is always a default folder called "Main" with an ID of 0.

Response

<GridResponse>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="MailingFolder">
   <Record row="1">
    <Fields>
     <Field element="ID">0</Field>
     <Field element="Main">Default</Field>
    </Fields>
   </Record>
   <Record row="2">
    <Fields>
     <Field element="ID">5</Field>
     <Field element="Name">Annual Appeal</Field>
    </Fields>
   </Record>
  </Grid>
 </Grids>
</GridResponse>

Notes

The default folder can be edited under System Settings in the Admin interface (Admin > System Settings).

Story

Use this request to retrieve information about the HTML and Text stories in a mailinges.

Data Element Type Length Conditional Description
Count Int   False Number of matches based upon criteria.
html_content Text 1000 False The content of the HTML version of the story.
is_deleted Bit   False Whether the story has been deleted
story_id Int   True Unique story ID.
mailing_id Int   True The "parent" ID to get all news stories for a mailing.
Rank Int   True Relative rank order if multiple stories used.
target_group_id Int   True Target group associated with a news story.
text_content Text 1000 False The content of the Text version of the story.
Title String 255 True The title of the story.

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="story">
   <ReturnFields>
    <DataElement>html_content</DataElement>
    <DataElement>is_deleted</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>rank</DataElement>
    <DataElement>story_id</DataElement>
    <DataElement>target_group_id</DataElement>
    <DataElement>text_content</DataElement>
    <DataElement>title</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Scheduled Mailings

This request provides a list of mailings that are scheduled.

Data Element Type Length Conditional Description
mailing_id Int   True Unique Mailing ID.
mailing_scheduled_date Datetime   True Mailing scheduled date.
mailing_name String 200 True Mailing name.
mailing_type String 43 True Mailing schedule type description.
ab Bit   True Determines that mailing has A/B testing enabled.
sent_to_winner Bit   True Determines that mailing has Send To winner enabled.
send_time_optimization Bit   True Determines that mailing has Time Optimization enabled.
distributed Bit   True Determines that mailing has Distributed delivery enabled.

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="scheduled_mailings">
   <Conditions>
    <Condition>
     <Between>
      <DataElement>mailing_scheduled_date</DataElement>
      <DataValue>11.10.2015</DataValue>
      <DataValue>12.10.2016</DataValue>
     </Between>
    </Condition>
   </Conditions>
   <ReturnFields>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_scheduled_date</DataElement>
    <DataElement>mailing_name</DataElement>
    <DataElement>mailing_type</DataElement>
    <DataElement>ab</DataElement>
    <DataElement>send_to_winner</DataElement>
    <DataElement>send_time_optimization</DataElement>
    <DataElement>distributed</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Response

<?xml version="1.0" encoding="utf-8"?>
<GridResponse xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999"></Brand>
 <User></User>
 <Grids>
  <Grid type="scheduled_mailings">
   <Record row="1">
    <Fields>
     <Field element="mailing_id">7342</Field>
     <Field element="mailing_scheduled_date">2015-11-25T18:15:00.0000000Z</Field>
     <Field element="mailing_name">Copy of Pi Beta 2</Field>
     <Field element="mailing_type">Send Once</Field>
     <Field element="ab">1</Field>
     <Field element="send_to_winner">0</Field>
     <Field element="send_time_optimization">0</Field>
     <Field element="distributed">0</Field>
    </Fields>
   </Record>
   <Record row="2">
    <Fields>
     <Field element="mailing_id">7350</Field>
     <Field element="mailing_scheduled_date">2015-12-01T22:00:00.0000000Z</Field>
     <Field element="mailing_name">test extended demographic</Field>
     <Field element="mailing_type">Monthly</Field>
     <Field element="ab">0</Field>
     <Field element="send_to_winner">0</Field>
     <Field element="send_time_optimization">0</Field>
     <Field element="distributed">0</Field>
    </Fields>
   </Record>
   <Record row="3">
    <Fields>
     <Field element="mailing_id">7350</Field>
     <Field element="mailing_scheduled_date">2016-01-01T22:00:00.0000000Z</Field>
     <Field element="mailing_name">test extended demographic</Field>
     <Field element="mailing_type">Monthly</Field>
     <Field element="ab">0</Field>
     <Field element="send_to_winner">0</Field>
     <Field element="send_time_optimization">0</Field>
     <Field element="distributed">0</Field>
    </Fields>
   </Record>   
  </Grid>
 </Grids>
</GridResponse>

Notes

A maximum of 200 rows can be returned in one request.

Was this article helpful?
0 out of 0 found this helpful
Return to top

Can’t find what you’re looking for?

Create a Case Call US Support