ResourcesAPI documentation

mailkit.campaigns.single.schedule

Function mailkit.campaigns.single.schedule is used to set an single delivery schedule.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.campaigns.single.schedule</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>ID_message</int>
      </value>
    </param>
    <param>
      <value>
        <string>subject</string>
      </value>
    </param>
    <param>
      <value>
        <string>send_date</string>
      </value>
    </param>
    <param>
      <value>
        <string>time_zone</string>
      </value>
    </param>
    <param>
      <value>
        <string>condition</string>
      </value>
    </param>
    <param>
      <value>
        <string>ID_template</string>
      </value>
    </param>
  <param>
   <value>
    <struct>
     <member>
      <name>ID_query</name>
      <value>
       <string>123</string>
      </value>
     </member>
     <member>
      <name>ID_delivery_feed</name>
      <value>
       <string>123</string>
      </value>
     </member>
    </struct>
   </value>
  </param>  </params>
</methodCall>

Values

client_id * = client ID can be found in your Mailkit account's menu Profile / Integration / API settings.

client_md5 * = MD5 code can be found in your Mailkit account's menu Profile / Integration / API settings.

ID_message * = ID of campaign

subject = subject of campaign (optional). When is empty the default subject will be set on.

send_date * = date of campaign delivery: rrrr-mm-dd hh:mm, for canceling delivery: '0000-00-00', or 'now' for immediate delivery

time_zone * = time zone: hh:mm or -hh:mm (02:00, -03:00...)

condition (Base64) = condition for delvery capping, f.e. '[CUSTOM2]' eq 'Yes'. Can be used only for mailing lists with maximum 10000 recipients.

ID_template = ID of template

ID_query = ID of the stored query for delivery capping (returned by mailkit.profile.queries.list)

ID_delivery_feed = ID of delivery data-source to use

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>OK, send_date: rrrr-mm-dd hh:mm:ss</string>
      </value>
    </param>
  </params>
</methodResponse>

Values

OK = campaign will be sent, date of delivery

Unsuccessful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>Missing send date of campaign</string>
      </value>
    </param>
  </params>
</methodResponse>

Values

Missing send date of campaign

Missing ID of campaign

The send date is in the past

Invalid ID_delivery_feed

Invalid ID_query

error: Confused parameters - it is not possible to combine delivery capping and delivery feeds

  • If a campaign has a mailing list assigned and the mailkit.campaign.single schedule contains delivery feed assignment, the feed will be assigned and mailing lists removed from the campaign.
  • If a mailkit.campaign.single schedule call contains valid delivery capping query ID, the query will be assigned to the campaign and delivery capping activated.
  • If campaign has delivery capping active and the mailkit.campaign.single schedule is called with ID_query = 0, the delivery capping of the campaign will be disabled. If no ID_query is passed in the call the existing delivery capping settings will be preserved.