Mailchimp API

Update just about any setting for a campaign that has not been sent. See campaignCreate() for details

Caveats:

• If you set list_id, all segmentation options will be deleted and must be re-added.
• If you set template_id, you need to follow that up by setting it's 'content'
• If you set segment_opts, you should have tested your options against campaignSegmentTest() as campaignUpdate() will not allow you to set a segment that includes no members.

Section:

Campaign Related

Parameters:

apikey

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

cid	the Campaign Id to update

name	the parameter name ( see campaignCreate() )

value

an appropriate value for the parameter ( see campaignCreate() )

Returns:

boolean   -  true if the update succeeds, otherwise an error will be thrown

Examples (4)

download example code

[1] mcapi_campaignUpdate.php

<?php
/**
This Example shows how to Update a regular Campaign via the MCAPI class.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$field = "title";
$value = "My New Title";
 
$retval = $api->campaignUpdate($campaignId, $field, $value);
 
if ($api->errorCode){
	echo "Unable to Update Campaign!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
    echo "SUCCESS! \n";
}
 

[2] mcapi_campaignUpdateAB.php

<?php
/**
This Example shows how to Update an A/B Split Campaign via the MCAPI class.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$field = "absplit";
$value = "My New Title";
 
$ab_opts = array();
$ab_opts['split_test'] = 'from_name';
$ab_opts['pick_winner'] = 'manual';
$ab_opts['from_name_a'] = 'David Gilmour';
$ab_opts['from_email_a'] = 'david@example.org';
$ab_opts['from_name_b'] = 'Roger Waters';
$ab_opts['from_email_b'] = 'roger@example.org';
 
$retval = $api->campaignUpdate($campaignId, $field, $ab_opts);
 
if ($api->errorCode){
	echo "Unable to Update Campaign!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
    echo "SUCCESS!\n";
}
 

[3] xml-rpc_campaignUpdate.php

<?php
/**
This Example shows how to update various parameters of a Campaign using XML-RPC.
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);
 
    $field = "title";
    $value = "My New Title";
 
	$result = $client->campaignUpdate($apikey, $campaignId, $field, $value);
	echo "SUCCESS! \n";
	echo "Returned: ".$result;
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
 

[4] xml-rpc_campaignUpdateAB.php

<?php
/**
This Example shows how to update an AB Split Campaign using XML-RPC.
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);
 
    $field = "absplit";
    $value = "My New Title";
 
    $ab_opts = array();
    $ab_opts['split_test'] = 'from_name';
    $ab_opts['pick_winner'] = 'manual';
    $ab_opts['from_name_a'] = 'David Gilmour';
    $ab_opts['from_email_a'] = 'david@example.org';
    $ab_opts['from_name_b'] = 'Roger Waters';
    $ab_opts['from_email_b'] = 'roger@example.org';
 
	$result = $client->campaignUpdate($apikey, $campaignId, $field, $ab_opts);
 
	echo "SUCCESS! \n";
	echo "Returned: ".$result;
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}