Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

SendNewsletter

Function for creating a mailing. SendDate (long, 2007-01-01), SendTime (hour:minute, 00-23:00-59) and FilterId are optional parameters.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strUsername:
strPassword:
strFromEmail:
strFromName:
strNewsletterId:
strMailingListId:
strSendDate:
strSendTime:
strFilterId:

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

<?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>
    <SendNewsletter xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strFromEmail>string</strFromEmail>
      <strFromName>string</strFromName>
      <strNewsletterId>string</strNewsletterId>
      <strMailingListId>string</strMailingListId>
      <strSendDate>string</strSendDate>
      <strSendTime>string</strSendTime>
      <strFilterId>string</strFilterId>
    </SendNewsletter>
  </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>
    <SendNewsletterResponse xmlns="http://api.anpdm.com/">
      <SendNewsletterResult>int</SendNewsletterResult>
    </SendNewsletterResponse>
  </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>
    <SendNewsletter xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strFromEmail>string</strFromEmail>
      <strFromName>string</strFromName>
      <strNewsletterId>string</strNewsletterId>
      <strMailingListId>string</strMailingListId>
      <strSendDate>string</strSendDate>
      <strSendTime>string</strSendTime>
      <strFilterId>string</strFilterId>
    </SendNewsletter>
  </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>
    <SendNewsletterResponse xmlns="http://api.anpdm.com/">
      <SendNewsletterResult>int</SendNewsletterResult>
    </SendNewsletterResponse>
  </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/SendNewsletter?strUsername=string&strPassword=string&strFromEmail=string&strFromName=string&strNewsletterId=string&strMailingListId=string&strSendDate=string&strSendTime=string&strFilterId=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/SendNewsletter HTTP/1.1
Host: api.anpdm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strUsername=string&strPassword=string&strFromEmail=string&strFromName=string&strNewsletterId=string&strMailingListId=string&strSendDate=string&strSendTime=string&strFilterId=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>