Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

enumerateLists


The enumerateLists() method returns an array of zero or more VerticalResponse mailing lists that belong to the current user. Provide the list_id argument to retrieve just one list. Provide the type argument to limit the response to only lists of that type. The name argument can be used to search lists for one with a particular name. Provide a campaign_id argument to find the lists that have been associated with the given campaign for mailing. Provide a form_id argument to find the list that’s associated with a given opt-in form. The limit and offset arguments can be used to specify a “window” of matching lists.

Input

[vrtypens:enumerateListsArgs]

session_id [xsd:string] (required)
Your API session id.
list_id [xsd:int]
The id of a list to restrict output to.
type [xsd:string]
The type of lists to restrict output to (e.g., “email”, “optin”).
name [xsd:string]
The name of a list to restrict output to.
campaign_id [xsd:int]
When specified, only lists that are associated with this campaign are returned.
form_id [xsd:int]
When specified, only the list associated with this opt-in form is returned.
include_field_info [xsd:boolean]
Whether to include the names of the fields for each list.
Warning: setting this to true when enumerating many lists can lead to very large responses.
include_deleted_lists [xsd:boolean]
Whether to include deleted lists in the output. By default deleted lists are not returned.
order_by [xsd:string]
The field to sort results by.
limit [xsd:int]
The maximum number of records to return. If set to 0 or omitted, will return all lists.
offset [xsd:int]
Only records on or beyond this index are included in the result.
is_master [xsd:boolean]
When set to true, only the master list is returned.
When set to false, all the user lists (except for the master list) are returned.
When not specified, all lists that match other input parameters are returned, whether master or not.

Output

[vrtypens:ArrayOfList]

Examples

PHP

$vrapi->enumerateLists( array(
	'session_id'         => $sid, 
	'type'               => 'email',
	'include_field_info' => true,
	'limit'              => 2,
) );

Ruby

vr.enumerateLists({
	'session_id' => sid,
	'type'       => 'email',
	'limit'      => 2,
	'include_field_info' => true,
})

Java

System.out.println("calling enumerateLists");

EnumerateListsArgs enumerateListsArgs = new EnumerateListsArgs();
	enumerateListsArgs.setSession_id(sessionID);
	enumerateListsArgs.setType("email");
	enumerateListsArgs.setLimit(2);
	enumerateListsArgs.setInclude_Field_Info(1);

vr.enumerateLists(enumerateListsArgs);

C#.NET

enumerateListsArgs objELists = new enumerateListsArgs();
objELists.session_id = _sSessionId;
objELists.type = "email";
objELists.limit = 5;
objELists.limitSpecified = true;
objELists.include_field_info = true;
objELists.include_field_infoSpecified = true;

objVR.enumerateLists(objELists);

Perl

$vrapi->enumerateLists( {
	session_id         => $sid, 
	type               => 'email',
	include_field_info => 1,
	limit              => 2,
} );