MagnetMail Web Service
Web Service to access data and add data to MagnetMail.
The following operations are supported. For a formal definition, please review the Service Description.
-
Authenticate
Authenticate -
CreateEventSignUp
Event Sign Up -
GetAllGroupCategories
Get Group Categories -
GetEnhancedPersonalizedFields
Enhanced Personalization Field List In BETA -
GetGroupCategory
Get Group Category -
GetMessageCategory
Get Message Category -
GetMessageDetails
Get Message Details -
GetMessageLinkTracking
Get Message Link Tracking. -
GetMessageOpenTracking
Get Message Open Tracking -
GetMessageSentTracking
Get Message Sent Tracking. -
GetUnsubscribeTracking
Get Unsubscribe Tracking -
GetUploadInitialQueueJobStatus
Upload Initial Queue Job Status In BETA -
SearchPersonifySubscriptionMappings
Get Personify Subscription Mappings -
UploadListInitialQueue
Upload List (w/Enhanced Personalization Support) In BETA -
addGroup
Add a recipient group to your account. -
addRecipient
add a recipient to MagnetMail -
createMagnetMailMessage
Create a new MagnetMail message -
editMagnetMailMessage
Edit an existing MagnetMail message -
editRecipient
edit a MagnetMail recipient -
editRecipientGroups
Edit a recipients group -
getDetailedTracking
Get detailed tracking data for a message. -
getDetailedTrackingUTC
Get detailed tracking data for a message. UTC Times returned for dates -
getErrorDetails
Takes an error_nbr and returns details on that error. -
getGroupDetails
Get Group Details -
getGroupRecipients
Get Group Recipients Details -
getGroupRecipientsCount
Get Group Recipient Count -
getGroups
Takes 3 arguments - user_id, display_status and subscription_groups. Returns an array of 'group' type. -
getGroupsUTC
Takes 3 arguments - user_id, display_status and subscription_groups. Returns an array of 'group' type, UTC formatted dates -
getLinkURLs
Return links in a message that were tracked -
getMessageList
Get A List Of Messages -
getMessageListUtc
Get A List Of Messages Using UTC Date Times -
getMessages
Returns a list of messages by different criterion. Messages can be filtered by sent date , create date, archive status, hide status, if it has fax, if it has email. -
getMessagesUTC
Returns a list of messages by different criterion. Messages can be filtered by sent date , create date, archive status, hide status, if it has fax, if it has email. Dates returned in UTC format -
getOverallTracking
Return overall tracking data for a message -
getRecipientDetails
Get recipient details based on the recipient_id. -
getRecipientFields
Takes a user_id as argument and returns contact fields defined in that account. Returns 2 values for each user1 - fieldNameText and fieldNameValue. -
getRecipientGroups
get the groups that a recipient belongs to -
getRecipientHistory
BETA: Get recipient history based on the recipient_id. -
getSavedSearches
Get an array of saved searches in the account. -
getSpamComplaints
Get list of recipients that have reported a message as spam. -
getSubscribedRecipients
Returns Array of subscription recipients. -
getSuppressedRecipientList
Get the list of suppressed recipients based on date range and/or groupId -
getTrackingData
Get Tracking Data -
getUnsubscribes
Get list of recipients that have unsubscribed from account. -
getUploadJobStatus
Takes a jobid and returns the status of an upload jobid. -
getUploadJobStatusUTC
Takes a jobid and returns the status of an upload jobid. Dates returned in UTC -
getUserDetails
Returns user(also called 'account') options/details -
runSavedSearch
Run a saved search in the account. -
searchForRecipients
search for Recipients -
sendEmailToIndividual
send email to individual -
sendMessageToGroup
BETA: Send message to a group. -
unsubscribeRecipients
Unsubscribe Recipients -
uploadListQueue
Takes an upload job and queues it for upload. Returns status in a complex type.The argument 'csvData' is your contact data in csv format. 'replace_group' specifies if recipients in group should be replaced with new list. 'update_dups' specifies if existing contact records should be overwritten with new values. 'header_line' specifies if your csvData has a header line. 'mapping_name' is name for the mapping between your headers and magnetMail fields. MM_1 thro MM_42 are names of MagnetMail fields to which your fields in csvData are mapped to. See API documentation for details of these fields. -
uploadListQueueTest
Takes an upload job and queues it for upload. Returns status in a complex type.The argument 'csvData' is your contact data in csv format. 'replace_group' specifies if recipients in group should be replaced with new list. 'update_dups' specifies if existing contact records should be overwritten with new values. 'header_line' specifies if your csvData has a header line. 'mapping_name' is name for the mapping between your headers and magnetMail fields. MM_1 thro MM_42 are names of MagnetMail fields to which your fields in csvData are mapped to. See API documentation for details of these fields. -
uploadSuppressionList
suppress a list of recipients