Overview

Namespaces

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

Classes

  • Address
  • Contact
  • ContactList
  • CustomField
  • EmailAddress
  • Note
  • Overview
  • Namespace
  • Class

Class ContactList

Represents a single Contact List

Ctct\Components\Component
Extended by Ctct\Components\Contacts\ContactList
Namespace: Ctct\Components\Contacts
Package: Components\Contacts
Author: Constant Contact
Located at Components/Contacts/ContactList.php
Methods summary
public
# __construct( $list_id = null )
public static Ctct\Components\Contacts\ContactList
# create( array $props )

Factory method to create a ContactList object from an array

Factory method to create a ContactList object from an array

Parameters

$props
  • Associative array of initial properties to set

Returns

Ctct\Components\Contacts\ContactList
public
# toJson( )
Methods inherited from Ctct\Components\Component
getValue()
Properties summary
public string $id

Unique identifier of the contact list

Unique identifier of the contact list

#
public string $name

Name of the contact list

Name of the contact list

#
public string $status

Status of the contact list, must be one of "ACTIVE", "HIDDEN", "REMOVED"

Status of the contact list, must be one of "ACTIVE", "HIDDEN", "REMOVED"

#
public string $contact_count

The number of contacts in the list

The number of contacts in the list

#
public string $created_date

Date and time the list was created.

Date and time the list was created.

#
public string $modified_date

Date and time the list was last modified.

Date and time the list was last modified.

#
API documentation generated by ApiGen