This document retrieves information about subscribers and unsubscribers.
NOTE: A "subscriber" is synonymous with an email address. If a subscriber in the integration database has multiple email addresses, multiple subscriber rows in Informz will result.
| Data Element | Type | Length | Conditional | Description |
|---|---|---|---|---|
| Count | Int | False | Number of matches based on criteria | |
| bounce_date | DateTime | True | Last bounce DateTime | |
| cancel_id | Int | True | Cancellation ID when unsubscribed | |
| cancellation_mailing_instance_id | Int | True | The mailing that the cancellation came from | |
| cancellation_date | DateTime | True | Cancellation date | |
| cancellation_message | String | 1000 | True | Reason supplied for unsubscribe |
| String | 100 | True | Email address | |
| subscriber_id | Int | True | ID in Informz | |
| is_repeated_bouncer | Bit | True | Repeated bouncer flag | |
| is_unsubscriber | Bit | True | Unsubscriber flag (will have cancellation_date and cancel_message) | |
| modified_date | DateTime | True | Last modified DateTime | |
| service_since_date | DateTime | True | DateTime first added to Informz | |
| user_id | Int | True | Unique remote ID |
Subscriber Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Password></Password> <Brand id="9999">Brand Name</Brand> <User>admin</User> <Grids> <Grid type="subscriber"> <ReturnFields> <DataElement>bounce_date</DataElement> <DataElement>cancellation_mailing_instance_id</DataElement> <DataElement>cancellation_message</DataElement> <DataElement>cancellation_date</DataElement> <DataElement>email</DataElement> <DataElement>is_repeated_bouncer</DataElement> <DataElement>is_unsubscriber</DataElement> <DataElement>modified_date</DataElement> <DataElement>service_since_date</DataElement> <DataElement>user_id</DataElement> <DataElement>subscriber_upload_id</DataElement> <DataElement>imis_name_id</DataElement> </ReturnFields> </Grid> </Grids> </GridRequest>
Subscriber Response
<?xml version="1.0" encoding="utf-8"?> <GridResponse xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Brand Name</Brand> <User>admin</User> <Grids> <Grid type="subscriber"> <Record row="1"> <Fields> <Field element="bounce_date" /> <Field element="cancellation_mailing_instance_id" /> <Field element="cancellation_message" /> <Field element="cancellation_date" /> <Field element="email">firstuser1@mail.com</Field> <Field element="is_repeated_bouncer">0</Field> <Field element="is_unsubscriber">0</Field> <Field element="modified_date">2016-06-02T11:54:08.2630000Z</Field> <Field element="service_since_date">2016-06-02T11:54:08.2630000Z</Field> <Field element="user_id" /> <Field element="subscriber_upload_id" /> <Field element="imis_name_id" /> </Fields> </Record> ... </Grid> </Grids> </GridResponse>
Unsubscriber Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/"> <Password>password</Password> <Brand id="9999">Brand Name</Brand> <User>admin</User> <Grids> <Grid type="subscriber"> <Conditions> <Condition> <Single> <DataElement>is_unsubscriber</DataElement> <DataValue>1</DataValue> <Comparator>EQ</Comparator> </Single> </Condition> <Condition> <Single> <DataElement>cancellation_date</DataElement> <DataValue>2008-01-01</DataValue> <Comparator>GT</Comparator> </Single> </Condition> </Conditions> <ReturnFields> <DataElement>email</DataElement> <DataElement>user_id</DataElement> </ReturnFields> </Grid> </Grids>
Unsubscriber Response
<?xml version="1.0" encoding="utf-8"?> <GridResponse xmlns="http://partner.informz.net/aapi/2009/08/"> <Brand id="9999">Brand Name</Brand> <User>admin</User> <Grids> <Grid type="subscriber"> <Record row="1"> <Fields> <Field element="email">861@informz.com</Field> <Field element="user_id">861</Field> </Fields> </Record> <Record row="2"> <Fields> <Field element="email">863@informz.com</Field> <Field element="user_id">863</Field> </Fields> </Record> <Record row="3"> <Fields> <Field element="email">864@informz.com</Field> <Field element="user_id">864</Field> </Fields> </Record> </Grid> </Grids> </GridResponse>