PHPFUI/InstaDoc
 
Copied!
CloneableInstantiable
Methods
public __construct(PHPFUI\ConstantContact\Client $client)
public get(?int $limit = NULL, ?bool $include_count = NULL, ?string $include_membership_count = NULL, ?string $name = NULL, ?string $status = NULL, ?string $channel_type = NULL, ?bool $include_sms_membership_count = NULL) : ?array
 

GET Lists Collection

Use this method to return details about all contact lists for the account.

  • param int $limit Use to specify the number of results displayed per page of output, from 1 - 500, default = 50.
  • param bool $include_count Set include_count to true to return the total number of contact lists that meet your selection criteria.
  • param string $include_membership_count Use to include the total number of contacts per list. Set to active, to count only active (mailable) contacts, or all to count all contacts.
  • param string $name Use to get details for a single list by entering the full name of the list.
  • param string $status Use to get lists by status. Accepts comma-separated status values.
  • param string $channel_type Use to return lists by channel type. The default value is email.
  • param bool $include_sms_membership_count Set to true to return the total number of SMS members in each list. Only applicable when channel_type is sms. Default is false.
public PHPFUI\ConstantContact\Base::getLastError() : string
public PHPFUI\ConstantContact\Base::getResponseText() : string
public PHPFUI\ConstantContact\Base::getStatusCode() : int
public getTyped(?int $limit = NULL, ?bool $include_count = NULL, ?string $include_membership_count = NULL, ?string $name = NULL, ?string $status = NULL, ?string $channel_type = NULL, ?bool $include_sms_membership_count = NULL) : ?PHPFUI\ConstantContact\Definition\ContactListArray
public PHPFUI\ConstantContact\Base::next() : array
 

If the endpoint is paginated, you can call next() to retrieve the next set of data. If no next is provided, an empty array is returned.

  • return array filled with next part of the response from the endpoint, or empty if no next.
public post(PHPFUI\ConstantContact\Definition\ListInput $body) : ?array
 

POST (create) a List

Create a new contact list resource

  • param \PHPFUI\ConstantContact\Definition\ListInput $body JSON payload defining the new contact list
public postTyped(PHPFUI\ConstantContact\Definition\ListInput $body) : ?PHPFUI\ConstantContact\Definition\ContactListPutPost
public PHPFUI\ConstantContact\Base::success() : bool
Properties
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
Methods
protected PHPFUI\ConstantContact\Base::doDelete(array $parameters) : ?array
protected PHPFUI\ConstantContact\Base::doGet(array $parameters) : ?array
protected PHPFUI\ConstantContact\Base::doPatch(array $parameters) : ?array
protected PHPFUI\ConstantContact\Base::doPost(array $parameters) : ?array
protected PHPFUI\ConstantContact\Base::doPut(array $parameters) : ?array
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration