MagnetMail Web Service Web Service

MagnetMail Web Service

Click here for a complete list of operations.

addRecipient

add a recipient to MagnetMail

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/addRecipient"

<?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>
    <addRecipient xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <email>string</email>
      <first_name>string</first_name>
      <last_name>string</last_name>
      <phone>string</phone>
      <fax>string</fax>
      <address_1>string</address_1>
      <address_2>string</address_2>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <company>string</company>
      <text_only>boolean</text_only>
      <custom_id>string</custom_id>
      <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>
      <Groups>
        <int>int</int>
        <int>int</int>
      </Groups>
    </addRecipient>
  </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>
    <addRecipientResponse xmlns="http://www.magnetmail.net/">
      <addRecipientResult>
        <error>double</error>
        <errorObj>
          <errorCode>string</errorCode>
          <errorDetails>string</errorDetails>
          <errorMessage>string</errorMessage>
          <errorNumber>double</errorNumber>
          <errorType>string</errorType>
        </errorObj>
        <id>double</id>
        <msg>string</msg>
      </addRecipientResult>
    </addRecipientResponse>
  </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>
    <addRecipient xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <email>string</email>
      <first_name>string</first_name>
      <last_name>string</last_name>
      <phone>string</phone>
      <fax>string</fax>
      <address_1>string</address_1>
      <address_2>string</address_2>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <company>string</company>
      <text_only>boolean</text_only>
      <custom_id>string</custom_id>
      <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>
      <Groups>
        <int>int</int>
        <int>int</int>
      </Groups>
    </addRecipient>
  </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>
    <addRecipientResponse xmlns="http://www.magnetmail.net/">
      <addRecipientResult>
        <error>double</error>
        <errorObj>
          <errorCode>string</errorCode>
          <errorDetails>string</errorDetails>
          <errorMessage>string</errorMessage>
          <errorNumber>double</errorNumber>
          <errorType>string</errorType>
        </errorObj>
        <id>double</id>
        <msg>string</msg>
      </addRecipientResult>
    </addRecipientResponse>
  </soap12:Body>
</soap12:Envelope>