Delete Contact List

Method: DELETE
Endpoint: /api/deleteList/{id}


Parameter Type Required Description
id int Yes id of the list to be deleted

Response Parameters

Parameter Type Description
status JSON Success or Error
result JSON Result of the operation

Example Request (CURL)


// Authentication
$api_token	=	'API_KEY'; // Mumara API Key (can be found in Settings -> API Key)
$domain		=	''; // Your Mumara Domain Name

// API Endpoint
$endpoint	=	'/api/deleteList/';

//List id
$list_id = 1;

// Defining cURL Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$domain.$endpoint.$list_id);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Content-Type: application/json', 'Authorization: Bearer ' . $api_token));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Executing cURL
$output = curl_exec ($ch);

// Printing Output
echo "<pre>";
echo json_encode(json_decode($output),JSON_PRETTY_PRINT );

// Closing cURL
curl_close ($ch);


Example Response (JSON)

    "status": "success",
    "result": "Success: List has been successfully deleted."
Status value of the success response will be "success"

Example Error Response (JSON)

    "status": "error",
    "result": "Error: Contact list is in use. Unlink it from associated triggers and segments"

Possible Errors

  • Invalid contact list id
  • Access denied
Try it out