API - Delete a Contact

Delete existing contact.

Description:

Allows you to delete an existing contact from the system.

HTTP method:

GET

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
account*	YOUR ACCOUNT URL
api_action*	contact_delete
api_key*	Your API key
api_output	xml, json, or serialize (default is XML)
id*	ID of the contact you wish to delete

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: Contact deleted
result_output	The result output used. Example: serialize

<?php

$url = 'https://api.t2connect.com/v1/';

//set POST variables
$data = array(
'account' => [YOUR ACCOUNT URL],
'api_key' => [YOUR API KEY],
// this is the action that deletes a contact based on the ID you provide
'api_action' => 'contact_delete',

// 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',

// ID of the contact you wish to delete
'id' => 1,

// if you wish to delete the contact only from certain lists, list them here
//'listids[123]' => 123,
//'listids[345]' => 345,
);

//open connection
$ch = curl_init($url);
$json_data = json_encode($data);

curl_setopt($ch, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS

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

if ( !$response ) {
die('Nothing was returned. Do you have a connection to your account?');
}
//close connection
curl_close($ch);

// unserializer
$result = unserialize($response);
// 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>';



?>