Scheduled Mailings

This example shows how to retrieve a list of Scheduled Mailings for a brand.

Element List

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.