Summary

This action allows you to send both live and test blasts, either immediately or scheduled for a particular time in the future.

Request

Format

<system>
  <authorization>
    <username>{username}</username>
    <password>{password}>/password>
  </authorization>
  <action>schedulesending</action>
  <parameterlist>
    <parameter id='List ID'><value>{list_id}</value></parameter>
    <parameter id='Subject'><value>{subject}</value></parameter>
    <parameter id='Sent Time'><value>{sent_time}</value></parameter>
    <parameter id='HTML Body'><value><![CDATA[
        {html_content}
    ]]></value></parameter>
    <parameter id='Text Body'><value><![CDATA[
        {text_content}
    ]]></value></parameter>
   [<parameter id='Test Mode'><value>{test_mode}</value></parameter>
    <parameter id='Test Recipient'><value>{test_recipients}</value></parameter>]
   [<parameter id='Disable Click Tracking'><value>{disable_click_tracking}</value></parameter>]
   [<parameter id='Search Relation'><value>{search_relation}</value></parameter>
    <parameterarr>
      <parameter id='{field}'>
        <operator>{operator}</operator>
        <value>{value}</value>
      </parameter>
      ...
    </parameterarr>]
  </parameterlist>
</system>

Sent Time

The value specified for {sent_time} indicates the time at which you wish to have the blast sent. If you wish to send the blast immediately, please supply the current time. The value must be formatted as YYYY-MM-DD HH:MM and in Pacific time.

Content Encoding

Use of the <![CDATA[ ... ]]> block is necessary to ensure that any angle brackets, "<" or ">", in your HTML or text are not misinterpreted by our XML parser.

Click Tracking

Click tracking is enabled for all blasts by default. To disable click tracking for a particular blast, include the "Disable Click Tracking" parameter with a value of 1.

Filter Criteria

You may optionally specify a set of filter criteria to be used to select the appropriate recipients during a live blast. This functions similarly to the Simple Filter functionality available when sending and exporting in the Email System web interface.

Search relation, if provided, tells the API what logical operator to use to joining multiple criteria together. Possible values include "AND" (default) and "OR".

Each criterion corresponds to a single <parameter> block within the <parameterarr> block. {field} specifies which custom list field you wish to compare, {operator} specifies the type of comparison you wish to make, and {value} specifies the value against which you wish to compare the field. Options for the {operator} are as follows, including their SQL corollaries:

Operator	SQL
Greater Than	> ?
Less Than	< ?
Equals To	= ?
Contains	LIKE '%?%'
Does Not Contain	NOT LIKE '%?%'
Not Equals To	!= ?

Test Mode

Test mode allows you to send a test blast to one or more recipients. To send in test mode, set {test_mode} to "1", then specify the comma-delimited list of recipients in {test_recipients}:

<system>
  ...
  <parameterlist>
    ...
    <parameter id='Test Mode'><value>1</value></parameter>
    <parameter id='Test Recipient'><value>john@example.com,bill@example.com</value></parameter>
    ...
  </parameterlist>
</system>

Note: When sending in test mode, mail-merge codes will not be replaced. During a live blast, mail-merge codes are replaced with the values for each subscriber in a list. However, because test mode uses a hard-coded list of recipient email addresses provided in your request, it has no values with which to replace any mail-merge codes in your message body. If you wish to see your test message with mail-merge replacement, you will need to create a separate, test list and send a live blast to it.

Response

Format

<system>
  <status>success</status>
 [<resultlist>
    <result id='Message ID'>{message_id}</result>
    <result id='Number Sent'>{number_sent}lt;/result>
  </resultlist>]
</system>

Message ID

When sending a live blast, the API will return the ID of the blast as {message_id}. This ID will be necessary for fetching blast reports after the blast has finished sending.

Test Mode

When sending a test blast, only the status is returned.