PHPFUI/InstaDoc

CloneableInstantiable

Extends
PHPFUI\ConstantContact\Base

Public
Protected

Methods

public __construct(PHPFUI\ConstantContact\Client $client)

public delete(string $campaign_id) : bool

DELETE an Email Campaign

Use this method to delete an email campaign and the email campaign activities
associated with the email campaign. You cannot delete an email campaign
when it has a Scheduled status.

Constant Contact users can restore deleted email campaigns using the
UI.

param phpDocumentor\Reflection\Types\String_ $campaign_id The unique ID for the email campaign you are deleting.

public get(string $campaign_id) : array

GET Details About a Single Email Campaign

Use this method to get details about a single email campaign and campaign
related activities. Details include the email campaign name, current
status, create date, last update date, and a list of campaign activities;
including the campaign_activity_id and role.

param phpDocumentor\Reflection\Types\String_ $campaign_id The ID (UUID format) that uniquely identifies this email campaign.

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 phpDocumentor\Reflection\Types\Array_ filled with next part of the response from the endpoint, or empty if no next.

public patch(string $campaign_id, PHPFUI\ConstantContact\Definition\EmailCampaignName $body) : array

PATCH (Update) an Email Campaign Name

Use this method to rename an email campaign. The name is not visible
to contacts. The name must be unique and cannot exceed 80 characters.
You cannot rename email campaigns that have a Removed status.

param phpDocumentor\Reflection\Types\String_ $campaign_id The unique identifier for an email campaign.
param phpDocumentor\Reflection\Types\Object_ $body A JSON payload that contains the new email campaign name.

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

Properties

Methods

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