Overview

Skill Level: Any

Prerequisites

Users of the ScheduleMailing API are strongly urged to implement a strict folder policy to better categorize and manage the sent mailings produced by this API. Watson Campaign Automation recommends users adopt a Year/Month/Day or similar folder structure by including an appropriate value for the PARENT_FOLDER_PATH element and making use of the CREATE_PARENT_FOLDER element when applicable.

Step-by-step

  1. Syntax of the request and response SOAP for ScheduleMailing

    Operation <ScheduleMailing>    
    Elements TEMPLATE_ID ID of template upon which to base the mailing.  
    ¬† LIST_ID ID of database, query, or contact list to send the template‚Äźbased mailing. ¬†
      MAILING_NAME Name to assign to the generated mailing.  
      SEND_HTML Optional If this element is present, value is true. Leave blank if you do not
    want to include the HTML body.
      SEND_AOL Optional If this element is present, value is true. Leave blank if you do not
    want to include the AOL body.
      SEND_TEXT Optional If this element is present, value is true. Leave blank if you do not
    want to include the text body.
      SUBJECT Optional If you do not include this element, Watson Campaign Automation uses the subject saved with the template.
      FROM_NAME Optional If you do not include this element, Watson Campaign Automation uses the From Name saved with the template.
      FROM_ADDRESS Optional If you do not include this element, Watson Campaign Automation uses the From Address saved with the template.
    ¬† REPLY_TO Optional If you do not include this element, Watson Campaign Automation uses the Reply‚ÄźTo Address saved with the template.
      VISIBILITY Value indicating where to save the sent mailing. Values are:
    0 ‚Äď Private Folder
    1 ‚Äď Shared Folder
     
      SCHEDULED Value specifying the date and time when the mailing should be scheduled to send. The format must be:
    MM/DD/YYYY HH:MM:SS AMPM
     
      INBOX_MONITOR Optional If True, Watson Campaign Automation activates Inbox Monitoring for the mailing.
      SEND_TIME_OPTIMIZATION Optional

    If specified, it is possible to send the mailing over a day or week. Valid values are:

    NONE ‚Äď will not use Send Time Optimization.

    SEND_24HRS ‚Äď will send the mailing over a 24 hour period based on each recipient‚Äôs optimal send time.

    SEND_WEEK‚Äď will send the mailing over a 7 day period based on each recipient‚Äôs optimal send time.

      WA_MAILINGLEVEL_CODE Optional

    This element is used in conjunction with Site Analytics Append String. If you have an append string that includes
    %%WA_MAILINGLEVEL_CODE%%, use the element to specify a mailing specific parameter to be passed via your links to your
    Site Analytics package.

    Note: This element is equivalent to the Mailing Specific Parameter box on the Send Mailing screen in Watson Campaign Automation when using Site Analytics.

      SUPPRESSION_LISTS Optional XML node containing one or more SUPPRESSION_LIST_ID child elements.
    Optional Child
    Elements
    SUPPRESSION_LIST_ID If any suppression lists are specified, they will be utilized as the suppression
    lists when the mailing is sent.
     
      SUBSTITUTIONS Optional XML node containing child element SUBSTITUTION
    Optional Child
    Elements
    SUBSTITUTION XML nodes defining the substitution name and value. This feature allows
    template‚Äźlevel substitutions separate from the normal contact‚Äźlevel
    substitutions performed by personalization. They are not contact specific.
    They are also not related to HTML_GENERAL_DISCLAIMER or the TEXT_GENERAL_DISCLAIMER. Note: If used, each node must have a NAME tag and a VALUE tag.
     
      Optional Child Element NAME The substitution tag used in the mailing template. This
    substitution name is case‚Äźsensitive. For example, if you include
    %%Sub_Value_1%% in the mailing template, the value for this
    child element is Sub_Value_1.
        VALUE The value you would like to substitute into the mailing for the
    tag with the name given above.
    Example <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
    xmlns:user=”SilverpopApi:EngageService.MailManagement.UserActions”>
    <soapenv:Header>
    <ses:sessionHeader>
    <ses:sessionid>87F620244DBE91A49EAAEC81687C84AD</ses:sessionid>
    </ses:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <user:ScheduleMailing>
    <user:TEMPLATE_ID>1866986</user:TEMPLATE_ID>
    <user:LIST_ID>24872</user:LIST_ID>
    <user:MAILING_NAME>Scheduled Mailing2</user:MAILING_NAME>
    <user:SEND_HTML/>
    <user:SUBJECT>Scheduled Mailing</user:SUBJECT>
    <user:FROM_NAME>S HAMIL</user:FROM_NAME>
    <user:FROM_ADDRESS>shamil@silverpop.com</user:FROM_ADDRESS>
    <user:REPLY_TO>shamil@silverpop.com</user:REPLY_TO>
    <user:VISIBILITY>1</user:VISIBILITY>
    <user:SCHEDULED>06/07/2009 12:00:00 PM</user:SCHEDULED>
    <user:SUPPRESSION_LISTS>
    <user:SUPPRESSION_LIST_ID>37782</user:SUPPRESSION_LIST_ID>
    <user:SUPPRESSION_LIST_ID>37744</user:SUPPRESSION_LIST_ID>
    </user:SUPPRESSION_LISTS>
    <user:SUBSTITUTIONS>
    <user:SUBSTITUTION>
    <user:NAME>Sub_Value_1</user:NAME>
    <user:VALUE>The value I would like to put in my
    mailing.</user:VALUE>
       
    Response <RESULT>    
    Elements SUCCESS True if successful.  
      MAILING_ID If the request was successful, this element contains the ID for the sent mailing.  
    Example
    Success
    <envelope:Envelope xmlns=”SilverpopApi:EngageService.MailManagement.UserActions”
    xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body>
    <RESULT>
    <SUCCESS>TRUE</SUCCESS>
    <MAILING_ID>2615568</MAILING_ID>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope>
       
           

Join The Discussion

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