Mailchimp API

Schedule a campaign to be sent in the future

Section:

Campaign Related

Parameters:

apikey

a valid API Key for your user account. Get by calling login()

cid	the id of the campaign to schedule

schedule_time

the time to schedule the campaign. For A/B Split "schedule" campaigns, the time for Group A - in YYYY-MM-DD HH:II:SS format in GMT

schedule_time_b

optional - the time to schedule Group B of an A/B Split "schedule" campaign - in YYYY-MM-DD HH:II:SS format in GMT

Returns:

boolean   -  true on success

Examples (2)

download example code

[1] mcapi_campaignSchedule.php

<?php
/**
This Example shows how to schedule a campaign for future delivery
via the MCAPI class.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$schedule_for = '2018-04-01 09:05:21';
$retval = $api->campaignSchedule($campaignId, $schedule_for);
 
if ($api->errorCode){
	echo "Unable to Schedule Campaign!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
	echo "Campaign Scheduled to be delivered $schedule_for!\n";
}
 

[2] xml-rpc_campaignSchedule.php

<?php
/**
This Example shows how to Schedule a Campaign to be sent at a specified time in the 
future using the XML-RPC service and do some basic error checking.
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
	// note that the Schedule date MUST be formatted like this: 
	//         '2008-04-01 09:05:21' means 'April 1st, 2008'
	$schedule_for = '2018-04-01 09:05:21';
	$result = $client->campaignSchedule($apikey, $campaignId, $schedule_for);
	echo "SUCCESS!\n";
	var_dump($result);
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
?>