Overview

Namespaces

  • Ctct
    • Auth
    • Components
      • Account
      • Activities
      • Contacts
      • EmailMarketing
      • Library
      • Tracking
    • Exceptions
    • Services
    • Util
    • WebHooks

Classes

  • AccountService
  • ActivityService
  • BaseService
  • CampaignScheduleService
  • CampaignTrackingService
  • ContactService
  • ContactTrackingService
  • EmailMarketingService
  • LibraryService
  • ListService
  • Overview
  • Namespace
  • Class

Class ListService

Performs all actions pertaining to Constant Contact Lists

Ctct\Services\BaseService
Extended by Ctct\Services\ListService
Namespace: Ctct\Services
Package: Services
Author: Constant Contact
Located at Services/ListService.php
Methods summary
public Array
# getLists( $accessToken, array $params = array() )

Get lists within an account

Get lists within an account

Parameters

$accessToken
Constant Contact OAuth2 access token
$params
  • associative array of query parameters and values to append to the request. Allowed parameters include: modified_since - ISO-8601 formatted timestamp.

Returns

Array
  • ContactLists

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\Contacts\ContactList
# addList( string $accessToken, Ctct\Components\Contacts\ContactList $list )

Create a new Contact List

Create a new Contact List

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$list

Returns

Ctct\Components\Contacts\ContactList

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\Contacts\ContactList
# updateList( string $accessToken, Ctct\Components\Contacts\ContactList $list )

Update a Contact List

Update a Contact List

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$list
  • ContactList to be updated

Returns

Ctct\Components\Contacts\ContactList

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\Contacts\ContactList
# deleteList( string $accessToken, $listId )

Delete a Contact List

Delete a Contact List

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$listId
list id

Returns

Ctct\Components\Contacts\ContactList

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\Contacts\ContactList
# getList( $accessToken, $listId )

Get an individual contact list

Get an individual contact list

Parameters

$accessToken
Constant Contact OAuth2 access token
$listId
list id

Returns

Ctct\Components\Contacts\ContactList

Throws

Ctct\Exceptions\CtctException
Methods inherited from Ctct\Services\BaseService
__construct(), convertException(), createBaseRequest(), getClient()
API documentation generated by ApiGen