Monthly Recipient List


  • The API retrieves the list of recipients - Subscribed or Unsubscribed (based on Recipient Type) for the particular month. The Details includes Email, Mobile No, First Name, Last Name, Custom Fields if any, Unsubscribe Date (For Unsubscribed Recipients) or Subscribe Date and Current Status.
  • The Details File downloaded in the form of zip and text.



Figure : Monthly Recipient List


Table : Monthly Recipient List


Sr

Variable Name

Description

1

username

Encrypted User Name

2

password

Encrypted Password

3

Year-Month

The year month to fetch recipient list details for this particular year and month.

4

Recipient Type

The Recipient Type to fetch recipient list details based on recipient type, i.e. subscribed or unsubscribed

5

Download Option

The Download Option to fetch recipient list details based on recipient type, i.e. with custom field or without custom field.

6

Start Row

The Start Row to fetch recipient list details is a range start value.

7

End Row

The End Row to fetch recipient list details is a range end value.

8

Output format

The Format of the file to be downloaded for details. i.e. csv or xml or json

9

Download as Zip File

The Type of the file to be downloaded for details. i.e. zip or text.