MagnetMail Web Service
Click here for a complete list of operations.
getUnsubscribes
Get list of recipients that have unsubscribed from account.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.magnetmail.net/getUnsubscribes"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<mmAuthHeader xmlns="http://www.magnetmail.net/">
<sessionId>string</sessionId>
<user_id>string</user_id>
</mmAuthHeader>
</soap:Header>
<soap:Body>
<getUnsubscribes xmlns="http://www.magnetmail.net/">
<user_id>string</user_id>
<fromDate>dateTime</fromDate>
<toDate>dateTime</toDate>
</getUnsubscribes>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<getUnsubscribesResponse xmlns="http://www.magnetmail.net/">
<getUnsubscribesResult>
<recp_unsubscribe>
<recipient>
<id>string</id>
<email>string</email>
<first_name>string</first_name>
<last_name>string</last_name>
<fax>string</fax>
<Custom_Id>string</Custom_Id>
<phone>string</phone>
<address>string</address>
<address_2>string</address_2>
<city>string</city>
<state>string</state>
<zip>string</zip>
<company>string</company>
<unsubscribed>boolean</unsubscribed>
<fax_send_suppress>boolean</fax_send_suppress>
<email_send_suppress>boolean</email_send_suppress>
<email_confirm>boolean</email_confirm>
<text_only>boolean</text_only>
<custom1>string</custom1>
<custom2>string</custom2>
<custom3>string</custom3>
<custom4>string</custom4>
<custom5>string</custom5>
<custom6>string</custom6>
<custom7>string</custom7>
<custom8>string</custom8>
<custom9>string</custom9>
<custom10>string</custom10>
<custom11>string</custom11>
<custom12>string</custom12>
<custom13>string</custom13>
<custom14>string</custom14>
<custom15>string</custom15>
<custom16>string</custom16>
<custom17>string</custom17>
<custom18>string</custom18>
<custom19>string</custom19>
<custom20>string</custom20>
<custom21>string</custom21>
<custom22>string</custom22>
<custom23>string</custom23>
<custom24>string</custom24>
<custom25>string</custom25>
<custom26>string</custom26>
<custom27>string</custom27>
<custom28>string</custom28>
<custom29>string</custom29>
<custom30>string</custom30>
<suppressed>boolean</suppressed>
<suppressed_date>dateTime</suppressed_date>
</recipient>
<ResultDate>dateTime</ResultDate>
<message_name>string</message_name>
<group_name>string</group_name>
<message_CategoryId>long</message_CategoryId>
<group_CategoryId>long</group_CategoryId>
</recp_unsubscribe>
<recp_unsubscribe>
<recipient>
<id>string</id>
<email>string</email>
<first_name>string</first_name>
<last_name>string</last_name>
<fax>string</fax>
<Custom_Id>string</Custom_Id>
<phone>string</phone>
<address>string</address>
<address_2>string</address_2>
<city>string</city>
<state>string</state>
<zip>string</zip>
<company>string</company>
<unsubscribed>boolean</unsubscribed>
<fax_send_suppress>boolean</fax_send_suppress>
<email_send_suppress>boolean</email_send_suppress>
<email_confirm>boolean</email_confirm>
<text_only>boolean</text_only>
<custom1>string</custom1>
<custom2>string</custom2>
<custom3>string</custom3>
<custom4>string</custom4>
<custom5>string</custom5>
<custom6>string</custom6>
<custom7>string</custom7>
<custom8>string</custom8>
<custom9>string</custom9>
<custom10>string</custom10>
<custom11>string</custom11>
<custom12>string</custom12>
<custom13>string</custom13>
<custom14>string</custom14>
<custom15>string</custom15>
<custom16>string</custom16>
<custom17>string</custom17>
<custom18>string</custom18>
<custom19>string</custom19>
<custom20>string</custom20>
<custom21>string</custom21>
<custom22>string</custom22>
<custom23>string</custom23>
<custom24>string</custom24>
<custom25>string</custom25>
<custom26>string</custom26>
<custom27>string</custom27>
<custom28>string</custom28>
<custom29>string</custom29>
<custom30>string</custom30>
<suppressed>boolean</suppressed>
<suppressed_date>dateTime</suppressed_date>
</recipient>
<ResultDate>dateTime</ResultDate>
<message_name>string</message_name>
<group_name>string</group_name>
<message_CategoryId>long</message_CategoryId>
<group_CategoryId>long</group_CategoryId>
</recp_unsubscribe>
</getUnsubscribesResult>
</getUnsubscribesResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<mmAuthHeader xmlns="http://www.magnetmail.net/">
<sessionId>string</sessionId>
<user_id>string</user_id>
</mmAuthHeader>
</soap12:Header>
<soap12:Body>
<getUnsubscribes xmlns="http://www.magnetmail.net/">
<user_id>string</user_id>
<fromDate>dateTime</fromDate>
<toDate>dateTime</toDate>
</getUnsubscribes>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<getUnsubscribesResponse xmlns="http://www.magnetmail.net/">
<getUnsubscribesResult>
<recp_unsubscribe>
<recipient>
<id>string</id>
<email>string</email>
<first_name>string</first_name>
<last_name>string</last_name>
<fax>string</fax>
<Custom_Id>string</Custom_Id>
<phone>string</phone>
<address>string</address>
<address_2>string</address_2>
<city>string</city>
<state>string</state>
<zip>string</zip>
<company>string</company>
<unsubscribed>boolean</unsubscribed>
<fax_send_suppress>boolean</fax_send_suppress>
<email_send_suppress>boolean</email_send_suppress>
<email_confirm>boolean</email_confirm>
<text_only>boolean</text_only>
<custom1>string</custom1>
<custom2>string</custom2>
<custom3>string</custom3>
<custom4>string</custom4>
<custom5>string</custom5>
<custom6>string</custom6>
<custom7>string</custom7>
<custom8>string</custom8>
<custom9>string</custom9>
<custom10>string</custom10>
<custom11>string</custom11>
<custom12>string</custom12>
<custom13>string</custom13>
<custom14>string</custom14>
<custom15>string</custom15>
<custom16>string</custom16>
<custom17>string</custom17>
<custom18>string</custom18>
<custom19>string</custom19>
<custom20>string</custom20>
<custom21>string</custom21>
<custom22>string</custom22>
<custom23>string</custom23>
<custom24>string</custom24>
<custom25>string</custom25>
<custom26>string</custom26>
<custom27>string</custom27>
<custom28>string</custom28>
<custom29>string</custom29>
<custom30>string</custom30>
<suppressed>boolean</suppressed>
<suppressed_date>dateTime</suppressed_date>
</recipient>
<ResultDate>dateTime</ResultDate>
<message_name>string</message_name>
<group_name>string</group_name>
<message_CategoryId>long</message_CategoryId>
<group_CategoryId>long</group_CategoryId>
</recp_unsubscribe>
<recp_unsubscribe>
<recipient>
<id>string</id>
<email>string</email>
<first_name>string</first_name>
<last_name>string</last_name>
<fax>string</fax>
<Custom_Id>string</Custom_Id>
<phone>string</phone>
<address>string</address>
<address_2>string</address_2>
<city>string</city>
<state>string</state>
<zip>string</zip>
<company>string</company>
<unsubscribed>boolean</unsubscribed>
<fax_send_suppress>boolean</fax_send_suppress>
<email_send_suppress>boolean</email_send_suppress>
<email_confirm>boolean</email_confirm>
<text_only>boolean</text_only>
<custom1>string</custom1>
<custom2>string</custom2>
<custom3>string</custom3>
<custom4>string</custom4>
<custom5>string</custom5>
<custom6>string</custom6>
<custom7>string</custom7>
<custom8>string</custom8>
<custom9>string</custom9>
<custom10>string</custom10>
<custom11>string</custom11>
<custom12>string</custom12>
<custom13>string</custom13>
<custom14>string</custom14>
<custom15>string</custom15>
<custom16>string</custom16>
<custom17>string</custom17>
<custom18>string</custom18>
<custom19>string</custom19>
<custom20>string</custom20>
<custom21>string</custom21>
<custom22>string</custom22>
<custom23>string</custom23>
<custom24>string</custom24>
<custom25>string</custom25>
<custom26>string</custom26>
<custom27>string</custom27>
<custom28>string</custom28>
<custom29>string</custom29>
<custom30>string</custom30>
<suppressed>boolean</suppressed>
<suppressed_date>dateTime</suppressed_date>
</recipient>
<ResultDate>dateTime</ResultDate>
<message_name>string</message_name>
<group_name>string</group_name>
<message_CategoryId>long</message_CategoryId>
<group_CategoryId>long</group_CategoryId>
</recp_unsubscribe>
</getUnsubscribesResult>
</getUnsubscribesResponse>
</soap12:Body>
</soap12:Envelope>