Use this request to retrieve a list of mailing folders along with the corresponding ID of the folder.
Elements
Data Element | Type | Length | Conditional? | Description |
---|---|---|---|---|
Count | Int | False | Number of matches found based upon criteria used | |
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>
Note
The default folder can be edited under System Settings in the UI (Admin > System Settings).