Overview

Namespaces

  • Ctct
    • Auth
    • Components
      • Account
      • Activities
      • Contacts
      • EmailMarketing
      • Tracking
    • Exceptions
    • Services
  • PHP

Classes

  • AccountService
  • ActivityService
  • BaseService
  • CampaignScheduleService
  • CampaignTrackingService
  • ContactService
  • ContactTrackingService
  • EmailMarketingService
  • ListService
  • Overview
  • Namespace
  • Class
  • Tree

Class CampaignScheduleService

Performs all actions pertaining to scheduling Constant Contact Campaigns

Ctct\Services\BaseService
Extended by Ctct\Services\CampaignScheduleService
Namespace: Ctct\Services
Package: Services
Author: Constant Contact
Located at Ctct/Services/CampaignScheduleService.php
Methods summary
public Campaign
# addSchedule( string $accessToken, integer $campaignId, Ctct\Components\EmailMarketing\Schedule $schedule )

Create a new schedule for a campaign

Create a new schedule for a campaign

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$campaignId
integer
$campaignId - Campaign id to be scheduled
$schedule
Ctct\Components\EmailMarketing\Schedule
$schedule - Schedule to be created

Returns

Campaign
public array
# getSchedules( string $accessToken, integer $campaignId )

Get a list of schedules for a campaign

Get a list of schedules for a campaign

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$campaignId
integer
$campaignId - Campaign id to be scheduled

Returns

array
public Ctct\Components\EmailMarketing\Schedule
# getSchedule( string $accessToken, integer $campaignId, integer $scheduleId )

Get a specific schedule for a campaign

Get a specific schedule for a campaign

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$campaignId
integer
$campaignId - Campaign id to be get a schedule for
$scheduleId
integer
$scheudle_id - Schedule id to retrieve

Returns

Ctct\Components\EmailMarketing\Schedule
public Ctct\Components\EmailMarketing\Schedule
# updateSchedule( string $accessToken, integer $campaignId, Ctct\Components\EmailMarketing\Schedule $schedule )

Update a specific schedule for a campaign

Update a specific schedule for a campaign

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$campaignId
integer
$campaignId - Campaign id to be scheduled
$schedule
Ctct\Components\EmailMarketing\Schedule
$schedule - Schedule to retrieve

Returns

Ctct\Components\EmailMarketing\Schedule
public Ctct\Components\EmailMarketing\Schedule
# deleteSchedule( string $accessToken, integer $campaignId, integer $scheduleId )

Get a specific schedule for a campaign

Get a specific schedule for a campaign

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$campaignId
integer
$campaignId - Campaign id
$scheduleId
integer
$scheduleId - Schedule id to delete

Returns

Ctct\Components\EmailMarketing\Schedule
public Ctct\Components\EmailMarketing\TestSend
# sendTest( string $accessToken, integer $campaignId, Ctct\Components\EmailMarketing\TestSend $test_send )

Send a test send of a campaign

Send a test send of a campaign

Parameters

$accessToken
string
$accessToken - Constant Contact OAuth2 access token
$campaignId
integer
$campaignId - Id of campaign to send test of
$test_send
Ctct\Components\EmailMarketing\TestSend
$test_send - Test send details

Returns

Ctct\Components\EmailMarketing\TestSend
Methods inherited from Ctct\Services\BaseService
__construct(), buildUrl(), getHeaders(), getRestClient()
Properties inherited from Ctct\Services\BaseService
$apiKey, $rest_client
Appconnect PHP SDK API documentation generated by ApiGen 2.8.0