These documents retrieve information about a mailing's primary email client as well as suppressed subscriber details.
Primary Email Client
This document retrieves information about the primary email client.
Data Element | Type | Length | Conditional | Description |
---|---|---|---|---|
subscriber_email | String | -1 | True | Subscriber email address |
subscriber_id | Int | True | Unique Subscriber ID | |
remote_id | String | 50 | True | Subscriber ID for the remote system |
type_id | Int | True | Unique Score Type ID | |
type_name | String | 255 | True | Score type name |
description | String | 2000 | True | Score name |
score_id | Int | True | Score description |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Password>password </Password> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type="subscriber_primary_email_client"> <Conditions> <Condition> <Single> <DataElement>subscriber_id</DataElement> <DataValue>500402555</DataValue> <Comparator>EQ</Comparator> </Single> </Condition> </Conditions> <ReturnFields> <DataElement>subscriber_email</DataElement> <DataElement>subscriber_id</DataElement> <DataElement>remote_id</DataElement> <DataElement>type_id</DataElement> <DataElement>type_name</DataElement> <DataElement>description</DataElement> <DataElement>score_id</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">Test Brand</Brand> <User>testuser</User> <Grids> <Grid type="subscriber_primary_email_client"> <Record row="1"> <Fields> <Field element="subscriber_email"></Field> <Field element="subscriber_id">500402555</Field> <Field element="remote_id">abada</Field> <Field element="type_id">4</Field> <Field element="type_name">Primary Email Client</Field> <Field element="description">Email client is uncertain</Field> <Field element="score_id">9061</Field> </Fields> </Record> </Grid> </Grids> </GridResponse>
Suppressed Subscribers
This document retrieves a mailing's suppressed subscriber details. A suppressed subscriber is anyone who was excluded from a mailing without having been unsubscribed. Enter a mailing_instance_id to retrieve details for a specific mailing instance.
Data Element | Type | Length | Conditional | Description |
---|---|---|---|---|
brand_id | Int | True | Brand ID | |
subscriber_match_id | Int | True | Primary key for this data | |
subscriber_id | Int | True | Subscriber's ID | |
String | 100 | True | Subscriber's email address | |
reason | String | 400 | True | Reason for suppression |
mailing_id | Int | True | ID of the mailing | |
mailing_instance_id | Int | True | ID of the mailings Instance | |
mailing_date | DateTime | True | Date of the mailing | |
mailing_name | String | 1000 | True | Name of the mailing |
mailing_instance_name | String | True | Name of the mailing instance | |
cancelled_id | If the subscriber is cancelled |
Request 1
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Password></Password> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type="suppressed_subscribers"> <ReturnFields> <DataElement>brand_id</DataElement> <DataElement>subscriber_match_id</DataElement> <DataElement>subscriber_id</DataElement> <DataElement>email</DataElement> <DataElement>reason</DataElement> <DataElement>mailing_id</DataElement> <DataElement>mailing_instance_id</DataElement> <DataElement>mailing_date</DataElement> <DataElement>mailing_name</DataElement> <DataElement>mailing_instance_name</DataElement> <DataElement>cancelled_id</DataElement> </ReturnFields> </Grid> </Grids>
Request 2
Use the following XML for Demo Data:
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Password></Password> <Brand id="9999">Test Brand</Brand> <User></User> <Grids> <Grid type="suppressed_subscribers_demo"> <ReturnFields> <DataElement>brand_id</DataElement> <DataElement>subscriber_match_id</DataElement> <DataElement>subscriber_id</DataElement> <DataElemnt>email</DataElement> <DataElement>reason</DataElement> <DataElement>mailing_id</DataElement> <DataElement>mailing_instance_id</DataElement> <DataElement>mailing_date</DataElement> <DataElement>mailing_name</DataElement> <DataElement>mailing_instance_name</DataElement> <DataElement>cancelled_id</DataElement> </ReturnFields> </Grid> </Grids>