MagnetMail Web Service Web Service

MagnetMail Web Service

Click here for a complete list of operations.

UploadListInitialQueue

Upload List (w/Enhanced Personalization Support) In BETA

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

<?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>
    <UploadListInitialQueue xmlns="http://www.magnetmail.net/">
      <Job>
        <InitialQueueId>double</InitialQueueId>
        <UserId>string</UserId>
        <LoginId>double</LoginId>
        <CsvData>string</CsvData>
        <Settings>
          <HasHeaderRow>boolean</HasHeaderRow>
          <GroupId>int</GroupId>
          <ContainsNonWesternCharacters>boolean</ContainsNonWesternCharacters>
          <AddReplace>ADD or REPLACE</AddReplace>
          <UpdateExistingRecipients>boolean</UpdateExistingRecipients>
          <ColumnMappings>
            <UploadColumnMapping xsi:nil="true" />
            <UploadColumnMapping xsi:nil="true" />
          </ColumnMappings>
          <MappingName>string</MappingName>
        </Settings>
      </Job>
    </UploadListInitialQueue>
  </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>
    <UploadListInitialQueueResponse xmlns="http://www.magnetmail.net/">
      <UploadListInitialQueueResult>
        <InitialQueueId>double</InitialQueueId>
        <UserId>string</UserId>
        <LoginId>double</LoginId>
        <CsvData>string</CsvData>
        <Settings>
          <HasHeaderRow>boolean</HasHeaderRow>
          <GroupId>int</GroupId>
          <ContainsNonWesternCharacters>boolean</ContainsNonWesternCharacters>
          <AddReplace>ADD or REPLACE</AddReplace>
          <UpdateExistingRecipients>boolean</UpdateExistingRecipients>
          <ColumnMappings>
            <UploadColumnMapping xsi:nil="true" />
            <UploadColumnMapping xsi:nil="true" />
          </ColumnMappings>
          <MappingName>string</MappingName>
        </Settings>
      </UploadListInitialQueueResult>
    </UploadListInitialQueueResponse>
  </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>
    <UploadListInitialQueue xmlns="http://www.magnetmail.net/">
      <Job>
        <InitialQueueId>double</InitialQueueId>
        <UserId>string</UserId>
        <LoginId>double</LoginId>
        <CsvData>string</CsvData>
        <Settings>
          <HasHeaderRow>boolean</HasHeaderRow>
          <GroupId>int</GroupId>
          <ContainsNonWesternCharacters>boolean</ContainsNonWesternCharacters>
          <AddReplace>ADD or REPLACE</AddReplace>
          <UpdateExistingRecipients>boolean</UpdateExistingRecipients>
          <ColumnMappings>
            <UploadColumnMapping xsi:nil="true" />
            <UploadColumnMapping xsi:nil="true" />
          </ColumnMappings>
          <MappingName>string</MappingName>
        </Settings>
      </Job>
    </UploadListInitialQueue>
  </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>
    <UploadListInitialQueueResponse xmlns="http://www.magnetmail.net/">
      <UploadListInitialQueueResult>
        <InitialQueueId>double</InitialQueueId>
        <UserId>string</UserId>
        <LoginId>double</LoginId>
        <CsvData>string</CsvData>
        <Settings>
          <HasHeaderRow>boolean</HasHeaderRow>
          <GroupId>int</GroupId>
          <ContainsNonWesternCharacters>boolean</ContainsNonWesternCharacters>
          <AddReplace>ADD or REPLACE</AddReplace>
          <UpdateExistingRecipients>boolean</UpdateExistingRecipients>
          <ColumnMappings>
            <UploadColumnMapping xsi:nil="true" />
            <UploadColumnMapping xsi:nil="true" />
          </ColumnMappings>
          <MappingName>string</MappingName>
        </Settings>
      </UploadListInitialQueueResult>
    </UploadListInitialQueueResponse>
  </soap12:Body>
</soap12:Envelope>