MemberService
The following operations are supported. For a formal definition, please review the Service Description.
-
Add
Add a new contact to send email.
When batching multiple contacts, limit batch size to 100 or fewer. -
AddBannedDomain
Add a domain to the banned addresses for an account or site. -
AddBannedEmail
Add an email to the banned addresses for an account or site. -
Delete
Delete existing contact if RemovePerminantly=true, else contact will be set to unsub. Unsubbed contacts may not be permanently deleted. -
DeleteByEmail
Delete existing contact if RemovePermanently=true, else contact will be set to unsub. Unsubbed contacts may not be permanently deleted. -
Exists
Check if a contact exists. -
ExistsByID
Check if a contact exists with MemberID. -
IsBanned
Check if a contact is listed as banned in the database. -
IsValidEmailAddress
Is your email address formatted correctly? -
List
List contacts partially matching Email. -
ListAll
List all contacts for current account. -
ListAllAdministrators
List all account administrator contacts for current account. -
ListAllForType
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' -
ListCountByMemberType
Count total number of contacts by ContactType/MemberType_. -
ListForType
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 -
ListMemberActivity
List contact activity statistics for a date range. -
ListModified
List contacts modified since ModifiedDate. NOTE: Limited to 10,000 if PageSize is NOT supplied or larger than 10,000. -
Load
Load a contact record by Email Address. -
LoadByID
Load a contact record by MemberID. -
LoadManyByID
Load a batch of contact records by MemberID. -
QuickAdd
Add a contact with the minimum data, email address. -
Update
Update a contact record.
When batching multiple contacts, limit batch size to 100 or fewer. -
Upsert
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. -
UpsertToCategories
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. -
UpsertUserID
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.