Overview

Skill Level: Any

Prerequisites

This interface allows you to send 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 SOAP API is not available for mailings associated with Non‐Email‐Key databases.

Step-by-step

  1. Syntax of the request and response SOAP for ForwardToFriend

    Operation <ForwardToFriend>  
    Elements SENDER_EMAIL  
      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 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>
     

Join The Discussion

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