Sunnysideup\CampaignMonitor\Api\Traits\Lists::createList
Creates a new list based on the provided details.
Both the UnsubscribePage and the ConfirmationSuccessPage parameters are optional.
Signature
public function createList(string
$title,
string
$unsubscribePage,
string
$confirmationSuccessPage,
[boolean
$confirmedOptIn = false,
[string
$unsubscribeSetting = NULL]] )
Parameters
$title
— string- - the page to redirect subscribers to when they unsubscribeThe list title
$unsubscribePage
— string- - The page to redirect subscribers to when they unsubscribe
$confirmationSuccessPage
— string- - The page to redirect subscribers to when they confirm their subscription
$confirmedOptIn
— boolean- - Whether this list requires confirmation of subscription
$unsubscribeSetting
— string- - Unsubscribe setting must be CS_REST_LIST_UNSUBSCRIBE_SETTING_ALL_CLIENT_LISTS or CS_REST_LIST_UNSUBSCRIBE_SETTING_ONLY_THIS_LIST. See the documentation for details: http://www.campaignmonitor.com/api/lists/#creating_a_list
Returns
- mixed
- A successful response will be the ID of the newly created list