public __construct(PHPFUI\ConstantContact\Client $client)
public delete(string $contact_id) : bool

DELETE a Contact

Deletes the contact identified by the contact_id path parameter. Deleted
contacts won't receive email from you, and they don't count as active
contacts. Unlike unsubscribed contacts, deleted contacts can be revived,
or added back to an account. Learn how to revive deleted contacts.

  • param string $contact_id Unique ID of contact to DELETE
public get(string $contact_id, ?string $include = NULL) : array

GET a Contact

This endpoint GETs a specific contact resource (contact_id). Use the
include query parameter to add any of the available contact sub-resources
to the response payload.

  • param string $contact_id Unique ID of contact to GET
  • param string $include Use include to specify which contact sub-resources to include in the response. Use a comma to separate multiple sub-resources. Valid values: custom_fields, list_memberships, phone_numbers, street_addresses, notes, sms_channel, and taggings.
public PHPFUI\ConstantContact\Base::getLastError() : string
public PHPFUI\ConstantContact\Base::getResponseText() : string
public PHPFUI\ConstantContact\Base::getStatusCode() : int
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 put(string $contact_id, PHPFUI\ConstantContact\Definition\ContactPutRequest $body) : array

PUT (update) a Contact

The PUT method updates an existing contact. You must include the update_source
property in the PUT request payload. To restore a deleted contact you
must specify the update_source as Account. When updating any resource
using PUT, all properties are updated, overwriting all previous values.
Any properties left blank or not included in the request are overwritten
with null value - however this does not apply to contact subresources.
Add or change any of the subresources by including them in the PUT request
payload. Omitted subresources are not overwritten with null. If the
contact being updated is deleted, the contact will be revived.

  • param string $contact_id Unique ID of contact to update
  • param \PHPFUI\ConstantContact\Definition\ContactPutRequest $body JSON payload defining the contact object, with updates. Any properties left blank or not included in the PUT payload are overwritten with null value - does not apply to contact subresources.
public PHPFUI\ConstantContact\Base::success() : bool
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
protected PHPFUI\ConstantContact\Base::doDelete(array $parameters) : bool
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
© 2023 Bruce Wells
Search Namespaces \ Classes