PHPFUI/InstaDoc

CloneableInstantiable

Extends
PHPFUI\ConstantContact\Base

Public
Protected

Methods

public __construct(PHPFUI\ConstantContact\Client $client)

public delete(string $contact_id) : ?array

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, and taggings.

public PHPFUI\ConstantContact\Base::getLastError() : string

public PHPFUI\ConstantContact\Base::getResponseText() : string

public PHPFUI\ConstantContact\Base::getStatusCode() : int

public getTyped(string $contact_id, ?string $include = NULL) : ?PHPFUI\ConstantContact\Definition\ContactResource

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. If email_address is specified: **Only use this method when a contact gives you their explicit permission to send them an email. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.

If sms_channel is specified: Only use this method when a contact gives you their explicit permission to send them an SMS. It is a violation of anti-spam and telemarketing laws, as well as a serious violation of the Constant Contact Terms of Service to use the Opt-in features of the API to opt a contact back in without his or her own action and consent.

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 putTyped(string $contact_id, PHPFUI\ConstantContact\Definition\ContactPutRequest $body) : ?PHPFUI\ConstantContact\Definition\ContactResource

public PHPFUI\ConstantContact\Base::success() : bool

Properties

Methods

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only