ResourcesAPI documentation

mailkit.campaigns.schedule.cancel

Function mailkit.campaigns.schedule.cancel cancels an already scheduled delivery.

API call example:

XML

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
 <methodName>mailkit.campaigns.schedule.cancel</methodName>
 <params>
  <param>
   <value>
    <int>client_id</int>
   </value>
  </param>
  <param>
   <value>
    <string>client_md5</string>
   </value>
  </param>
  <param>
   <value>
    <i4>123456</i4>
   </value>
  </param>
  <param>
   <value>
    <struct>
     <member>
      <name>ID_send_message_queue</name>
      <value>
       <string>123</string>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodCall>

JSON

{  
   "function":"mailkit.campaign.schedule.cancel,
   "id":"client_id",
   "md5":"client_md5",
     "parameters":{  
      "ID_message": "123456”,
      “ID_send_message_queue”:”123”
   }   
}

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 (optional). When used returns only campaign with a given ID.

ID_send_message_queue * = ID of the scheduled delivery (as returned by mailkit.campaign.single.schedule.list)

* required value

Successful call response:

XML-RPC

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <string>Canceled</string>
   </value>
  </param>
 </params>
</methodResponse>

JSON

{
    "error_status": 0,
    "error": "Canceled"
}

Values:

Canceled = pending delivery has been cancelled

On error / error_status = 1 ... an error occured:
Invalid ID_message = invalid message ID
Invalid status cancel = invalid ID of a pending delivery to cancel (already cancelled or delivered)
Invalid ID_send_message_queue = invalid ID of a pending delivery