You can use this request to delete a specific list.
Your method must be structured as follows:
|$id||integer||The ID of the list you need to delete.||yes|
Large lists are deleted asynchronously, the API will return a status code of 202 (Accepted) and a false result. Smaller lists are deleted immediately and will return a status code of 204 (No Content) on success.
|boolean||Whether or not the list was successfully deleted.|
$url = '(Your URL)/api/2.0/lists/list_id';
$method = 'DELETE';
$cSession = curl_init();
$headers = array();
$auth = base64_encode($username . ':' . $apikey);
$headers = 'Authorization: Basic ' . $auth;
curl_setopt($cSession, CURLOPT_URL, $url);
curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);
curl_setopt($cSession, CURLOPT_HEADER, false);
curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));
curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($cSession);
The rest of this document describes the example above, step-by-step.
In our Getting Started section we covered the four important components of an API request; URL, method, headers, and body.
Let's analyse the code sample above to determine where each line fits into this outline.
The following line of code tells the server which API URL to access for the request:
In this line of code, you tell the API which REST function to use:
cURL is a tool for sending and receiving files from a web server. This line of code initialises the cURL session.
This section of the code opens the headers section and passes the authentication (including your API key).
The first line uses the $url to get your specified url
The second line returns the string (text) of the return value.
The third line tells the server not to include the header in the ouput.
The fourth line calls the $method specified above, which is to ‘DELETE’ the data from the server.
Call the headers using the $headers method.