Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

InsertCsvSubscribersFromFileCustom

Insert multiple subscribers from a custom-delimited textfile. The fields in the text-file should be: mandatory fields (Email;Name;Format;) and optional fields(dd1;dd2;dd3;dd4;dd5;dd6...d25) or up to dd100 if activated on account. Format should have either one of the two values HTML or Text. The URL is the complete path to the file, with forward-slashes between directories. E.g. http://api.anpdm.com/example-files/import-examplefile.csv. Recommended usage: <80 000 rows.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strUsername:
strPassword:
strMailingListID:
strCSVUrl:
chrDelimiter:
chrQuote:
chrEscape:
chrComment:
blnHasHeaders:

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 /externalapiservice.asmx HTTP/1.1
Host: api.anpdm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.anpdm.com/InsertCsvSubscribersFromFileCustom"

<?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>
    <InsertCsvSubscribersFromFileCustom xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strMailingListID>string</strMailingListID>
      <strCSVUrl>string</strCSVUrl>
      <chrDelimiter>char</chrDelimiter>
      <chrQuote>char</chrQuote>
      <chrEscape>char</chrEscape>
      <chrComment>char</chrComment>
      <blnHasHeaders>boolean</blnHasHeaders>
    </InsertCsvSubscribersFromFileCustom>
  </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>
    <InsertCsvSubscribersFromFileCustomResponse xmlns="http://api.anpdm.com/">
      <InsertCsvSubscribersFromFileCustomResult>int</InsertCsvSubscribersFromFileCustomResult>
    </InsertCsvSubscribersFromFileCustomResponse>
  </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 /externalapiservice.asmx HTTP/1.1
Host: api.anpdm.com
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>
    <InsertCsvSubscribersFromFileCustom xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strMailingListID>string</strMailingListID>
      <strCSVUrl>string</strCSVUrl>
      <chrDelimiter>char</chrDelimiter>
      <chrQuote>char</chrQuote>
      <chrEscape>char</chrEscape>
      <chrComment>char</chrComment>
      <blnHasHeaders>boolean</blnHasHeaders>
    </InsertCsvSubscribersFromFileCustom>
  </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>
    <InsertCsvSubscribersFromFileCustomResponse xmlns="http://api.anpdm.com/">
      <InsertCsvSubscribersFromFileCustomResult>int</InsertCsvSubscribersFromFileCustomResult>
    </InsertCsvSubscribersFromFileCustomResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /externalapiservice.asmx/InsertCsvSubscribersFromFileCustom?strUsername=string&strPassword=string&strMailingListID=string&strCSVUrl=string&chrDelimiter=string&chrQuote=string&chrEscape=string&chrComment=string&blnHasHeaders=string HTTP/1.1
Host: api.anpdm.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://api.anpdm.com/">int</int>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /externalapiservice.asmx/InsertCsvSubscribersFromFileCustom HTTP/1.1
Host: api.anpdm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strUsername=string&strPassword=string&strMailingListID=string&strCSVUrl=string&chrDelimiter=string&chrQuote=string&chrEscape=string&chrComment=string&blnHasHeaders=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://api.anpdm.com/">int</int>