Unsubscribe

Returns unsubscribe count and unsubscribe status with reason.

Elements list

Node Type Req'd? Unique? Description
<ID> Int False N/A The unique mailing ID in the partner application.
<Email> String True N/A Email Address.
<UnsubscribeReason> String False N/A Unsubscribe Reason Message.

Request

<?xml version="1.0" encoding="utf-8"?>
<ActionRequest xmlns="http://partner.informz.net/aapi/2009/08/">  
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Password></Password>
 <Actions>
  <Unsubscribe>
   <Subscribers>
    <Subscriber>
     <Email>test1@example.com</Email>
     <ID>1</ID>
     <UnsubscribeReason>Unsubscribe reason 1</UnsubscribeReason>
    </Subscriber>
    <Subscriber>
     <Email>test2@example.com</Email>
     <ID>2</ID>
     <UnsubscribeReason>Unsubscribe reason 2</UnsubscribeReason>
    </Subscriber>
    <Subscriber>
     <Email>test3@example.com</Email>
     <ID>3</ID>
     <UnsubscribeReason>Unsubscribe reason 3</UnsubscribeReason>
    </Subscriber>
   </Subscribers>
  </Unsubscribe>
 </Actions>
</ActionRequest>

Response

<?xml version="1.0" encoding="utf-16"?>
<ActionResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Responses>
  <Unsubscribe>
   <Count>3</Count>
   <ActionStatus>
    <Status>success</Status>
    <Message xsi:type="xsd:string">3 email addresses unsubscribed.</Message>
   </ActionStatus>
  </Unsubscribe>
 </Responses>
</ActionResponse> 

Notes

  1. If the ID is not provided, and there is only one matching email address, it is unsubscribed. If there is more than one matching email address, an exception is returned.
  2. If UnsubscribeReason is not provided, then a default reason ("Unsubscribed via Informz Web Service") is written in DB table.