cancelMailingList

Description

Cancel mailing list using its id. Note that once cancelled you cannot resume the mailing list.



Params

Name Type Description
apiKey string API key previously generated.
id integer Mailing list id.

 

Returned data

Type: boolean

Description: Return boolean.

 

Json sample code

<?php

$curl = curl_init('https://your_address/ccm/admin/api/version/2/&type=json');

$postData = array(
    'function' => 'cancelMailingList',
    'apiKey' => 'apiKey',
    'id' => 4,
);

curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$json = curl_exec($curl);
if ($json === false) {
    die('Request failed with error: '. curl_error($curl));
}

$result = json_decode($json);
if ($result->status == 0) {
    die('Bad status returned. Error: '. $result->error);
}

var_dump($result->data);

 

Result of API call

bool(true)
Menu Title