Mailing management interfaces allow you to invoke Watson Campaign Automation functions directly related to particular mailings. There are two operations in this category: SendMailing and ForwardToFriend.

Send a Mailing to a Contact

SendMailing You can automate a mailing to send after contacts successfully Opt In or Edit Profile using a Web form associated. You can also set automation for custom events, which are triggered by an API request. The SendMailing operation sends a mailing to the specified contact. The SendMailing operation is specifically for the delivery of autoresponders based on a custom event. This operation will not send a mailing Template. The Mailing ID must be for an existing, custom event autoresponder and the contact email address must be for a contact who already exists in the database associated with the mailing. See the Add a Contact for information on adding a contact to a database. Each Send is queued for message generation and delivery. They do not always send immediately, but receive slices of processing time as determined by an algorithm. Small sends such as these are typically built and sent within a range of seconds‐to‐minutes, but that varies based on several factors such as concurrent system usage. Note: There is a limit of 1,000 SendMailing API calls per day for an Organization. If you plan to send more than 1,000 transactional emails per day, please contact your IBM account manager to discuss alternatives.

Operation  <SendMailing>      
 Elements  MailingId Identifies the mailing Watson Campaign Automation will send.    
   RecipientEmail Identifies the targeted contact’s email address.    
   COLUMNS Optional XML nodes defining the column name and value for the database’s keyfields. Note: Each node must have a Name tag and a Value tag. If the databasehas a key that is not Email, Unique key columns must also be part of the submission with column names and values.    
  Child Elements COLUMN  XML nodes defining the column name and value. Note: Eachnode must have a Name tag and a Value tag. If the database hasa key that is not Email, Unique key columns must also be part ofthe submission with column names and values.  
     Child Elements Name Defines the field name.
      Value Contains the field value.
Example <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:mail=”SilverpopApi:EngageService.MailManagement”>
<soapenv:Body>
<mail:SendMailing>
<mail:MailingId>1867084</mail:MailingId>
<mail:RecipientEmail>recipient@domain.com</mail:RecipientEmail>
</mail:SendMailing>
</soapenv:Body>
</soapenv:Envelope>
     
Response <RESPONSE>      
Elements SUCCESS TRUE if successful. Upon success, the API immediately schedules a mailing to the contact.    
  ORGANIZATION_ID Identifies your Watson Campaign Automation Organization.    
Example <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<RESULT>
<SUCCESS>TRUE</SUCCESS>
</RESULT>
</envelope:Body>
</envelope:Envelope>
     

Forward Mailing to a Friend

ForwardToFriend This operation sends a copy of a mailing along with an additional message to the specified contacts. You must use the Mailing ID of an existing Sent Mailing. Note: The ForwardToFriend API is not available for mailings associated with Non‐Email‐Key databases.

Operation <ForwardToFriend>
Elements SENDER_EMAIL Email address of message sender (forwarder).
  rs or r The internal ID of the contact forwarding the message. Use <rs> with an encoded
ID or <r> with an un‐encoded ID.
  m Identifies the mailing to send.
  RECIPIENTS Identifies the email address of the targeted contact. Separate multiple values
with commas.
  MESSAGE Text of additional message that will accompany the forwarded mailing.
Example <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
xmlns:mail=”SilverpopApi:EngageService.MailManagement”>
<soapenv:Body>
<mail:ForwardToFriend>
<mail:SENDER_EMAIL>sbhamilton@gmail.com</mail:SENDER_EMAIL>
<mail:r>28054753</mail:r>
<mail:m>1867084</mail:m>
<mail:RECIPIENTS>somebody@domain.com</mail:RECIPIENTS>
<mail:MESSAGE>Forwarded Mailing</mail:MESSAGE>
</mail:ForwardToFriend>
</soapenv:Body>
</soapenv:Envelope>
Response <FTF_RESULT>  
Elements FTF_RESULT For a successful submission, FTF_RESULT will have no value. Possible error values
include:
5 – Error w/ Sender recipient ID
4 – Error w/ Sender email address
3 – Error w/ mailing ID – not found
2 – Error w/ recipient ID
1 – Error w/ mailing ID – invalid format
  ORGANIZATION_ID Identifies your Watson Campaign Automation Organization.
Example <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement”
xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
<envelope:Header/>
<envelope:Body>
<FTF_RESULT/>
</envelope:Body>
</envelope:Envelope>

2 comments on"Mailing Management Interfaces"

  1. Diego Trujillo March 08, 2018

    Hi, i would like to use the SendMailing service, what exactly is an “autoresponder”, i’m trying to send my templates but i get the error “Only sending Custom Automated Mailings are allowed. Please provide the Mailing ID for a Custom Automated Mailing”.
    Sorry is this is an obvious question, i’m new to silverpop. Thanks in advance

Join The Discussion

Your email address will not be published. Required fields are marked *