Example Usage of address_edit
Edit an existing address.
Description: | Edit an existing address, just like you would on the Addresses page of the settings section. | ||||||||||||||||||||||||||||
Endpoint: |
/admin/api.php?api_action=address_edit
|
||||||||||||||||||||||||||||
HTTP method: | POST |
||||||||||||||||||||||||||||
Supported output formats: | json |
||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||
Example response: |
|
PHP Example
This is an example of using the address_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 ActiveCampaign installation and print out the result $url = 'https://account.api-us1.com'; // 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'; $params = array( // this is the action that edits an address 'api_action' => 'address_edit', // define the type of output you wish to get back // possible values: // - 'json' : data is returned in JSON format and can be decoded with // json_decode() function (included in PHP since 5.2.0) 'api_output' => 'json', ); // here we define the data we are posting in order to perform an update $post = array( 'id' => '3', 'company_name' => 'ActiveCampaign', // Company (or Organization) 'address_1' => '1 N Dearborn St', // Address Line 1 // 'address_2' => '', // Address Line 2 'city' => 'Chicago', // City 'state' => 'IL', // State (or Province) 'zip' => '60602', // Zip (or Postal Code) 'country' => 'US', // Country Code 'allgroup' => 0, // All groups have access to address // Assign to lists: 'list[123]' => 123, // Example List ID (REPLACE '123' WITH ACTUAL LIST ID, IE: list[5] = 5) //'list[]' => 345, // Some additional lists // Assign to groups: 'group[123]' => 123, // Example Group ID (REPLACE '123' WITH ACTUAL LIST ID, IE: group[3] = 3) //'group[]' => 345, // Some additional groups ); // This section takes the input fields and converts them to the proper format $query = ""; foreach( $params as $key => $value ) $query .= $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 .= $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_HTTPHEADER, array('API-TOKEN: ' . $api_key)); // Provide the API Token via the API-TOKEN header 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, true); // 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>';?>
Questions? Discuss this API call in our developer forum