Apsis Newsletter Pro v3 API


Click here for a complete list of operations.

MoveSubscriberToOptOutAll

Move a subscriber to OptOutAll by Email. SendQueueId is optional and should be supplied if you want to keep track of which sending this email belongs to. Reason and MailinglistId is also optional and is only used to keep track of those values.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
strUsername:
strPassword:
strEmail:
strReason:
strMailinglistId:
strSendQueueId:

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

<?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>
    <MoveSubscriberToOptOutAll xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strEmail>string</strEmail>
      <strReason>string</strReason>
      <strMailinglistId>string</strMailinglistId>
      <strSendQueueId>string</strSendQueueId>
    </MoveSubscriberToOptOutAll>
  </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>
    <MoveSubscriberToOptOutAllResponse xmlns="http://api.anpdm.com/">
      <MoveSubscriberToOptOutAllResult>int</MoveSubscriberToOptOutAllResult>
    </MoveSubscriberToOptOutAllResponse>
  </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>
    <MoveSubscriberToOptOutAll xmlns="http://api.anpdm.com/">
      <strUsername>string</strUsername>
      <strPassword>string</strPassword>
      <strEmail>string</strEmail>
      <strReason>string</strReason>
      <strMailinglistId>string</strMailinglistId>
      <strSendQueueId>string</strSendQueueId>
    </MoveSubscriberToOptOutAll>
  </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>
    <MoveSubscriberToOptOutAllResponse xmlns="http://api.anpdm.com/">
      <MoveSubscriberToOptOutAllResult>int</MoveSubscriberToOptOutAllResult>
    </MoveSubscriberToOptOutAllResponse>
  </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/MoveSubscriberToOptOutAll?strUsername=string&strPassword=string&strEmail=string&strReason=string&strMailinglistId=string&strSendQueueId=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/MoveSubscriberToOptOutAll HTTP/1.1
Host: api.anpdm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

strUsername=string&strPassword=string&strEmail=string&strReason=string&strMailinglistId=string&strSendQueueId=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>