Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

deleteListMember


The deleteListMember() method deletes a single member from a VR mailing list. The list member’s hash must be provided inside its member_data so that the member can be identified.

Input

[vrtypens:deleteListMemberArgs]

session_id [xsd:string] (required)
Your API session id.
list_member [vrtypens:ListMember] (required)
A ListMember object representing the member to delete. It must have its “list_id” attribute set.
For email lists, the ListMember object must have a “hash” NVPair in its “member_data” dictionary.
For postcard lists, the ListMember object must have an “address_hash” NVPair in its “member_data” dictionary.
delete_from_master [xsd:boolean] (required)
Set this flag to true to indicate if you want to remove member from your master list also.

Output

[xsd:boolean]
The output is always true.

Examples

Perl

$vrapi->deleteListMember( {
    session_id => $sid,
    list_member => {
        list_id => $lid,
        member_data => [
            {
                name => 'hash',
                value=> '99e3cf416f',
                },
        ],
    },
} );

PHP

$vrapi->deleteListMember( array(
    'session_id' => $sid,
    'list_member' => array(
        'list_id' => $lid,
        'member_data' => array(
            array(
                name => 'hash',
                value => '99e3cf416f',
            ),
        ),
    ),
) );

Ruby

vr.deleteListMember({
   'session_id'  => sid,
   'list_member' => {
        'list_id'     => lid,
        'member_data' => 
             [{
              'name'  => 'hash',
              'value' => '99e3cf416f'               
             }]
         }
})

C#.NET

NVPair member_data = new NVPair();
member_data.name = "hash";
member_data.value= "99e3cf416f";

ListMember list_member = new ListMember();
list_member.list_id = iListId;
list_member.member_data = member_data;

deleteListMemberArgs objDLMember = new deleteListMemberArgs();
objDLMember.session_id = _sSessionId;
objDLMember.list_member = list_member;

objVR.deleteListMember(objDLMember);