CampaignMonitor::createList PHP Method

createList() public method

Creates a list. Returns the list ID when succesful or false if the call failed
public createList ( string $title, string[optional] $unsubscribePage = null, bool[optional] $confirmOptIn = false, string[optional] $confirmationSuccessPage = null, string[optional] $clientId = null ) : string
$title string The title of the list.
$unsubscribePage string[optional]
$confirmOptIn bool[optional]
$confirmationSuccessPage string[optional]
$clientId string[optional]
return string
    public function createList($title, $unsubscribePage = null, $confirmOptIn = false, $confirmationSuccessPage = null, $clientId = null)
    {
        // set client ID
        $clientId = empty($clientId) ? $this->getClientId() : $clientId;
        // set parameters
        $parameters['Title'] = (string) $title;
        $parameters['UnsubscribePage'] = (string) $unsubscribePage;
        $parameters['ConfirmedOptIn'] = $confirmOptIn ? true : false;
        $parameters['ConfirmationSuccessPage'] = (string) $confirmationSuccessPage;
        // return the result
        return (string) $this->doCall('lists/' . $clientId, $parameters, 'POST');
    }