PHPFUI/InstaDoc

Methods

public __construct(PHPFUI\ConstantContact\Client $client)

public delete(string $campaign_activity_id) : ?array

DELETE an Email Campaign Activity Schedule

Use this method to unschedule an email campaign activity by deleting the schedule. You can only unschedule email campaign activities that are in SCHEDULED status. Unscheduling reverts the email campaign activity to the status prior to SCHEDULED.

param string $campaign_activity_id The unique ID for an email campaign activity.

public get(string $campaign_activity_id) : ?array

GET an Email Campaign Activity Schedule

Use this method to return the current schedule for an email campaign activity. This schedule contains the date that Constant Contact will send the email campaign activity to contacts. If the email campaign activity is not in SCHEDULED status, this method returns an empty array and a 200 response code.

param string $campaign_activity_id The unique ID for an email campaign activity.

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

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

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

public getTyped(string $campaign_activity_id) : ?array

return ?\PHPFUI\ConstantContact\Definition\EmailScheduleResponse[]

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(string $campaign_activity_id, PHPFUI\ConstantContact\Definition\EmailScheduleInput $body) : ?array

POST (Create) an Email Campaign Activity Schedule

Use this method to send an email campaign activity to contacts either immediately or on a specific date. To send the email campaign activity immediately, specify 0 for the scheduled_date request property (results return an empty array). To send the email campaign activity on a specific date, specify the date using the scheduled_date request property (results return the scheduled date in an array).

Before you schedule an email campaign activity, you must update the email campaign activity and specify which contacts you want Constant Contact to send the email to. When you make a PUT call to update an email campaign activity, use the contact_list_ids or segment_ids array to add contacts.

You can only schedule email campaign activities that have the primary_email role and are in DRAFT, DONE, or ERROR status. When you schedule an email campaign activity in DONE status, Constant Contact does not send the email campaign activity to contacts that already received it. Constant Contact only sends the email campaign activity to any new contacts in the contact lists or segment you use.

param string $campaign_activity_id The unique ID for an email campaign activity. You can only schedule email campaign activities that have the primary_email role.
param \PHPFUI\ConstantContact\Definition\EmailScheduleInput $body A request body payload that contains the date that you want Constant Contact to send your email campaign activity on. Use "0" as the date to have Constant Contact immediately send the email campaign activity.

public postTyped(string $campaign_activity_id, PHPFUI\ConstantContact\Definition\EmailScheduleInput $body) : ?array

return ?\PHPFUI\ConstantContact\Definition\EmailScheduleResponse[]

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