MemberService

MemberService Description: ASMX, WSDL


Add: ASMX, XML
Description: Add a new contact to send email.
When batching multiple contacts, limit batch size to 100 or fewer.
Parameters:
Name Type Description
Member MemberDataset.MemberDataTable XSD
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



AddBannedDomain: ASMX, XML
Description: Add a domain to the banned addresses for an account or site.
Parameters:
Name Type Description
Domain String  
BanEntireSite Boolean  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
BannedMemberDataset.BannedMemberDataTable XSD



AddBannedEmail: ASMX, XML
Description: Add an email to the banned addresses for an account or site.
Parameters:
Name Type Description
Email String  
BanEntireSite Boolean  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
BannedMemberDataset.BannedMemberDataTable XSD



AddListAdministrator: ASMX, XML
Description: Add an account admin with the minimum data, email address, full name, password.
Parameters:
Name Type Description
Email String  
FullName String  
Password String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



AddListAdministratorUserPassword: ASMX, XML
Description: Add an account admin with the minimum data, email address, full name; a set password email will be sent to the new admin.
Parameters:
Name Type Description
Email String  
FullName String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



AddListAdministratorUserPasswordWithRoles: ASMX, XML
Description: Add an account admin with the minimum data, email address, full name along with specified Roles; a set password email will be sent to the new admin NOTE: Use Account Service ListRoles for RoleIDs
Parameters:
Name Type Description
Email String  
FullName String  
RoleIDs Array of Int32  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



AddListAdministratorWithRoles: ASMX, XML
Description: Add an account admin with the minimum data, email address, full name, password along with specified Roles. NOTE: Use Account Service ListRoles for RoleIDs
Parameters:
Name Type Description
Email String  
FullName String  
Password String  
RoleIDs Array of Int32  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



Delete: ASMX, XML
Description: Delete existing contact if RemovePerminantly=true, else contact will be set to unsub. Unsubbed contacts may not be permanently deleted.
Parameters:
Name Type Description
MemberID Int32  
RemovePerminantly Boolean  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
Boolean  



DeleteByEmail: ASMX, XML
Description: Delete existing contact if RemovePermanently=true, else contact will be set to unsub. Unsubbed contacts may not be permanently deleted.
Parameters:
Name Type Description
MemberEmail String  
RemovePermanently Boolean  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
Boolean  



Exists: ASMX, XML
Description: Check if a contact exists.
Parameters:
Name Type Description
Email String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
Boolean  



ExistsByID: ASMX, XML
Description: Check if a contact exists with MemberID.
Parameters:
Name Type Description
MemberID Int32  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
Boolean  



IsBanned: ASMX, XML
Description: Check if a contact is listed as banned in the database.
Parameters:
Name Type Description
Email String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
Boolean  



IsValidEmailAddress: ASMX, XML
Description: Is your email address formatted correctly?
Parameters:
Name Type Description
Email String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
Boolean  



List: ASMX, XML
Description: List contacts partially matching Email.
Parameters:
Name Type Description
Email String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
PagingHeader:
Name Type Description
PageSize Int32 (Optional) The requested page size.
PageNumber Int32 (Optional) The page number to retrieve.
 
Return Value:
Type Description
MemberListDataset.MemberListDataTable XSD



ListAll: ASMX, XML
Description: List all contacts for current account.
Parameters:
none
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
PagingHeader:
Name Type Description
PageSize Int32 (Optional) The requested page size.
PageNumber Int32 (Optional) The page number to retrieve.
 
Return Value:
Type Description
MemberListDataset.MemberListDataTable XSD



ListAllAdministrators: ASMX, XML
Description: List all account administrator contacts for current account.
Parameters:
none
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberListDataset.MemberListDataTable XSD



ListAllForType: ASMX, XML
Description: List contacts for current account by type. Valid contact types include:
'normal' - normal contact
'confirm' - awaiting confirmation from user
'private' - awaiting admin approval
'expired' - subscription has expired
'held' - on hold due to bad email address
'unsub' - unsubscribed
'referred' - referred by a friend and awaiting confirmation
'needs-confirm' - send a confirm doc then set to 'confirm'
'needs-hello' - send a hello doc then set to 'normal'
'needs-goodbye' - send a goodbye doc then set to 'unsub'
Parameters:
Name Type Description
MemberType String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
PagingHeader:
Name Type Description
PageSize Int32 (Optional) The requested page size.
PageNumber Int32 (Optional) The page number to retrieve.
 
Return Value:
Type Description
MemberListDataset.MemberListDataTable XSD



ListCountByMemberType: ASMX, XML
Description: Count total number of contacts by ContactType/MemberType_.
Parameters:
none
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberTypeCountDataset.MemberTypeCountDataTable XSD



ListForType: ASMX, XML
Description: List contacts for current account by type and date range. Valid contact types include:
'normal' - normal contact
'confirm' - awaiting confirmation from user
'private' - awaiting admin approval
'expired' - subscription has expired
'held' - on hold due to bad email address
'unsub' - unsubscribed
'referred' - referred by a friend and awaiting confirmation
Parameters:
Name Type Description
MemberType String  
StartDate DateTime  
EndDate DateTime  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
PagingHeader:
Name Type Description
PageSize Int32 (Optional) The requested page size.
PageNumber Int32 (Optional) The page number to retrieve.
 
Return Value:
Type Description
MemberListDataset.MemberListDataTable XSD



ListMemberActivity: ASMX, XML
Description: List contact activity statistics for a date range.
Parameters:
Name Type Description
StartDate DateTime  
EndDate DateTime  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberStatisticsDataset.MemberActivityDataTable XSD



ListModified: ASMX, XML
Description: List contacts modified since ModifiedDate. NOTE: Limited to 10,000 if PageSize is NOT supplied or larger than 10,000.
Parameters:
Name Type Description
ModifiedSince DateTime  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
PagingHeader:
Name Type Description
PageSize Int32 (Optional) The requested page size.
PageNumber Int32 (Optional) The page number to retrieve.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



Load: ASMX, XML
Description: Load a contact record by Email Address.
Parameters:
Name Type Description
Email String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



LoadByID: ASMX, XML
Description: Load a contact record by MemberID.
Parameters:
Name Type Description
MemberID Int32  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



LoadManyByID: ASMX, XML
Description: Load a batch of contact records by MemberID.
Parameters:
Name Type Description
MemberIDs Array of Int32  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



QuickAdd: ASMX, XML
Description: Add a contact with the minimum data, email address.
Parameters:
Name Type Description
Email String  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



Update: ASMX, XML
Description: Update a contact record.
When batching multiple contacts, limit batch size to 100 or fewer.
Parameters:
Name Type Description
Member MemberDataset.MemberDataTable XSD
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



Upsert: ASMX, XML
Description: Add a new contact record, or update that contact record if it already exists.
When batching multiple contacts, limit batch size to 100 or fewer.
Parameters:
Name Type Description
Member MemberDataset.MemberDataTable XSD
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



UpsertToCategories: ASMX, XML
Description: Add a new contact record, or update that contact record if it already exists.
Then add that contact to the specified categories.
When batching multiple contacts, limit batch size to 100 or fewer.
Parameters:
Name Type Description
Member MemberDataset.MemberDataTable XSD
CategoryIDs Array of Int32  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD



UpsertUserID: ASMX, XML
Description: Perform an upsert operation, using the UserID as a key to allow email address changes. (UserID is required)
Then add that contact to the specified categories.
When batching multiple contacts, limit batch size to 100 or fewer.
Parameters:
Name Type Description
Member MemberDataset.MemberDataTable XSD
CategoryIDs Array of Int32  
 
SoapHeader:
Name Type Description
Username String Your API access username.
Password String Your API access password.
List String The account you want to access.
 
Return Value:
Type Description
MemberDataset.MemberDataTable XSD