list_edit

Example Usage of 

list_edit

Edit existing mailing list.

Description:

Edit existing mailing list settings and details, just like you would on the Manage Lists page of the admin section.

Endpoint:

/admin/api.php?api_action=list_edit

HTTP method:

POST

Supported output formats:

xml, json, serialize

Requires authentication:

true

Parameters:

* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as 

Content-Type: application/x-www-form-urlencoded

. We don't accept any other input formats like JSON.

Variable	Description
api_action*	list_edit
api_key*	Your API key
api_output	xml, json, or serialize (default is XML)
id*	List ID to edit
name*	Internal list name. Example: 'List Name'
subscription_notify*	Comma-separated list of email addresses to notify on new subscriptions to this list
unsubscription_notify*	Comma-separated list of email addresses to notify on any unsubscriptions from this list
to_name*	If contact doesn't enter a name, use this. Example: 'Recipient'
carboncopy*	Comma-separated list of email addresses to send a copy of all mailings to upon send
p_use_captcha	Whether or not to require CAPTCHA ("enter text on image" field) for this list. Examples: 1 = yes, 0 = no
get_unsubscribe_reason	Whether or not to ask for reason when unsubscribing. Examples: 1 = yes, 0 = no
send_last_broadcast	Whether or not to send the last broadcast campaign when subscribing. Examples: 1 = yes, 0 = no
require_name	Whether or not to require name with email when subscribing. Examples: 1 = yes, 0 = no
sender_addr1	Physical mailing address
sender_zip	Physical mailing address: zip or postal code
sender_country	Physical mailing address country
sender_url	Website associated with this list
sender_reminder	Remind your contacts why they are on this list and why you are emailing them

Example response:

Variable	Description
result_code	Whether or not the response was successful. Examples: 1 = yes, 0 = no
result_message	A custom message that appears explaining what happened. Example: List updated
result_output	The result output used. Example: serialize

PHP Example

This is an example of using the list_edit call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using serialize as the output format. You can change that to XML or JSON if you would like.

<?php

// By default, this sample code is designed to get the result from your installation and print out the result
$url = 'http://account.api-us1.com';


$params = array(

    // the API Key can be found on the "Your Settings" page under the "API" tab.
    // replace this with your API Key
    'api_key'      => 'YOUR_API_KEY',

    // this is the action that modifies list information
    'api_action'   => 'list_edit',

    // define the type of output you wish to get back
    // possible values:
    // - 'xml'  :      you have to write your own XML parser
    // - 'json' :      data is returned in JSON format and can be decoded with
    //                 json_decode() function (included in PHP since 5.2.0)
    // - 'serialize' : data is returned in a serialized format and can be decoded with
    //                 a native unserialize() function
    'api_output'   => 'serialize',
);

// here we define the data we are posting in order to perform an update
$post = array(
    'id'                       => 1, // example list ID to modify
    'name'                     => 'List Name', // list name
    'subscription_notify'      => '', // comma-separated list of email addresses to notify on new subscriptions to this list
    'unsubscription_notify'    => '', // comma-separated list of email addresses to notify on any unsubscriptions from this list
    'to_name'                  => "Recipient", // if contact doesn't enter a name, use this
    'carboncopy'               => '', // comma-separated list of email addresses to send a copy of all mailings to upon send
    'stringid'                 => 'api-test', // URL-safe list name
    'bounceid[1]'              => 1, // use default bounce management account
    //'bounceid[123]'          => 123, // use some additional bounce management accounts
    //'p_use_captcha'          => 1, // uncomment to require CAPTCHA ("enter text on image" field) for this list
    //'get_unsubscribe_reason' => 1, // uncomment to ask for reason when unsubscribing
    //'send_last_broadcast'    => 1, // uncomment to send the last broadcast campaign when subscribing
    //'require_name'           => 1, // uncomment to require name with email when subscribing
    //'private'                => 1, // uncomment to hide it on public side (direct links to it will still work though)
);

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// This section takes the input data and converts it to the proper format
$data = "";
foreach( $post as $key => $value ) $data .= urlencode($key) . '=' . urlencode($value) . '&';
$data = rtrim($data, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
    die('JSON not supported. (introduced in PHP 5.2.0)');
}

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
curl_setopt($request, CURLOPT_POSTFIELDS, $data); // use HTTP POST to send form data
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);

$response = (string)curl_exec($request); // execute curl post and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object

if ( !$response ) {
    die('Nothing was returned. Do you have a connection to Email Marketing server?');
}

// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';

// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';

// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;

echo '<br /><br />POST params:<br />';
echo '<pre>';
print_r($post);
echo '</pre>';?>