MagnetMail Web Service Web Service

MagnetMail Web Service

Click here for a complete list of operations.

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.

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

<?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>
    <uploadListQueue xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <groupid>int</groupid>
      <csvData>string</csvData>
      <replace_group>boolean</replace_group>
      <update_dups>boolean</update_dups>
      <header_line>boolean</header_line>
      <mapping_name>string</mapping_name>
      <MM_1>string</MM_1>
      <MM_2>string</MM_2>
      <MM_3>string</MM_3>
      <MM_4>string</MM_4>
      <MM_5>string</MM_5>
      <MM_6>string</MM_6>
      <MM_7>string</MM_7>
      <MM_8>string</MM_8>
      <MM_9>string</MM_9>
      <MM_10>string</MM_10>
      <MM_11>string</MM_11>
      <MM_12>string</MM_12>
      <MM_13>string</MM_13>
      <MM_14>string</MM_14>
      <MM_15>string</MM_15>
      <MM_16>string</MM_16>
      <MM_17>string</MM_17>
      <MM_18>string</MM_18>
      <MM_19>string</MM_19>
      <MM_20>string</MM_20>
      <MM_21>string</MM_21>
      <MM_22>string</MM_22>
      <MM_23>string</MM_23>
      <MM_24>string</MM_24>
      <MM_25>string</MM_25>
      <MM_26>string</MM_26>
      <MM_27>string</MM_27>
      <MM_28>string</MM_28>
      <MM_29>string</MM_29>
      <MM_30>string</MM_30>
      <MM_31>string</MM_31>
      <MM_32>string</MM_32>
      <MM_33>string</MM_33>
      <MM_34>string</MM_34>
      <MM_35>string</MM_35>
      <MM_36>string</MM_36>
      <MM_37>string</MM_37>
      <MM_38>string</MM_38>
      <MM_39>string</MM_39>
      <MM_40>string</MM_40>
      <MM_41>string</MM_41>
      <MM_42>string</MM_42>
    </uploadListQueue>
  </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>
    <uploadListQueueResponse xmlns="http://www.magnetmail.net/">
      <uploadListQueueResult>
        <complete_date>dateTime</complete_date>
        <error>double</error>
        <errorObj>
          <errorCode>string</errorCode>
          <errorDetails>string</errorDetails>
          <errorMessage>string</errorMessage>
          <errorNumber>double</errorNumber>
          <errorType>string</errorType>
        </errorObj>
        <good_records>double</good_records>
        <group_count>double</group_count>
        <groupid>double</groupid>
        <header>double</header>
        <jobid>double</jobid>
        <loginid>double</loginid>
        <mm_filename>string</mm_filename>
        <msg>string</msg>
        <new_added>double</new_added>
        <old_updated>double</old_updated>
        <replace_group>double</replace_group>
        <status>double</status>
        <total_records>double</total_records>
        <update_dups>double</update_dups>
        <upload_date>dateTime</upload_date>
        <user_filename>string</user_filename>
        <user_id>string</user_id>
      </uploadListQueueResult>
    </uploadListQueueResponse>
  </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>
    <uploadListQueue xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <groupid>int</groupid>
      <csvData>string</csvData>
      <replace_group>boolean</replace_group>
      <update_dups>boolean</update_dups>
      <header_line>boolean</header_line>
      <mapping_name>string</mapping_name>
      <MM_1>string</MM_1>
      <MM_2>string</MM_2>
      <MM_3>string</MM_3>
      <MM_4>string</MM_4>
      <MM_5>string</MM_5>
      <MM_6>string</MM_6>
      <MM_7>string</MM_7>
      <MM_8>string</MM_8>
      <MM_9>string</MM_9>
      <MM_10>string</MM_10>
      <MM_11>string</MM_11>
      <MM_12>string</MM_12>
      <MM_13>string</MM_13>
      <MM_14>string</MM_14>
      <MM_15>string</MM_15>
      <MM_16>string</MM_16>
      <MM_17>string</MM_17>
      <MM_18>string</MM_18>
      <MM_19>string</MM_19>
      <MM_20>string</MM_20>
      <MM_21>string</MM_21>
      <MM_22>string</MM_22>
      <MM_23>string</MM_23>
      <MM_24>string</MM_24>
      <MM_25>string</MM_25>
      <MM_26>string</MM_26>
      <MM_27>string</MM_27>
      <MM_28>string</MM_28>
      <MM_29>string</MM_29>
      <MM_30>string</MM_30>
      <MM_31>string</MM_31>
      <MM_32>string</MM_32>
      <MM_33>string</MM_33>
      <MM_34>string</MM_34>
      <MM_35>string</MM_35>
      <MM_36>string</MM_36>
      <MM_37>string</MM_37>
      <MM_38>string</MM_38>
      <MM_39>string</MM_39>
      <MM_40>string</MM_40>
      <MM_41>string</MM_41>
      <MM_42>string</MM_42>
    </uploadListQueue>
  </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>
    <uploadListQueueResponse xmlns="http://www.magnetmail.net/">
      <uploadListQueueResult>
        <complete_date>dateTime</complete_date>
        <error>double</error>
        <errorObj>
          <errorCode>string</errorCode>
          <errorDetails>string</errorDetails>
          <errorMessage>string</errorMessage>
          <errorNumber>double</errorNumber>
          <errorType>string</errorType>
        </errorObj>
        <good_records>double</good_records>
        <group_count>double</group_count>
        <groupid>double</groupid>
        <header>double</header>
        <jobid>double</jobid>
        <loginid>double</loginid>
        <mm_filename>string</mm_filename>
        <msg>string</msg>
        <new_added>double</new_added>
        <old_updated>double</old_updated>
        <replace_group>double</replace_group>
        <status>double</status>
        <total_records>double</total_records>
        <update_dups>double</update_dups>
        <upload_date>dateTime</upload_date>
        <user_filename>string</user_filename>
        <user_id>string</user_id>
      </uploadListQueueResult>
    </uploadListQueueResponse>
  </soap12:Body>
</soap12:Envelope>