README

Swagger build version 3.0.62

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/constantcontact/constant-contact-v3api-client-php.git"
}
],
"require": {
"constantcontact/constant-contact-v3api-client-php": "*@dev"
}
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

        <?php
require_once('/path/to/constant-contact-api/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');


    
// Configure OAuth2 access token for authorization: oauth2_access_code
$config = ConstantContactApi\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2_implicit
$config = ConstantContactApi\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new ConstantContactApi\Client\Api\AccountServicesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$add_account_email_address_request = new \ConstantContactApi\Client\Model\AddAccountEmailAddressRequest(); // \ConstantContactApi\Client\Model\AddAccountEmailAddressRequest | A JSON request payload containing the new email address you want to add to the Constant Contact account.

try {
    $result = $apiInstance->addAccountEmailAddress($add_account_email_address_request);
        print_r($result);
    } catch (Exception $e) {
    echo 'Exception when calling AccountServicesApi->addAccountEmailAddress: ', $e->getMessage(), PHP_EOL;
    }

API Endpoints

All URIs are relative to https://api.cc.email/v3

Class	Method	HTTP request	Description
AccountServicesApi	addAccountEmailAddress	POST /account/emails	POST Add an Account Email Address
AccountServicesApi	addPhysicalAddress	POST /account/summary/physical_address	POST the Physical Address for the Account
AccountServicesApi	getAccountDetails	GET /account/summary	GET a Summary of Account Details
AccountServicesApi	getAccountPhysicalAddress	GET /account/summary/physical_address	GET the Physical Address for the Account
AccountServicesApi	getAllAccountEmailAddresses	GET /account/emails	GET a Collection of Account Email Addresses
AccountServicesApi	getUserPrivileges	GET /account/user/privileges	GET User Privileges
AccountServicesApi	updateAccount	PUT /account/summary	PUT (update) Account Details
AccountServicesApi	updateAccountPhysicalAddress	PUT /account/summary/physical_address	PUT (update) the Physical Address for an Account
BulkActivitiesApi	createCSVImportActivity	POST /activities/contacts_file_import	Import Contacts using a CSV File
BulkActivitiesApi	createDeleteActivity	POST /activities/contact_delete	Delete Contacts in Bulk
BulkActivitiesApi	createExportActivity	POST /activities/contact_exports	Export Contacts to a File
BulkActivitiesApi	createImportJSONActivity	POST /activities/contacts_json_import	Import Contacts using a JSON Payload
BulkActivitiesApi	createListAddActivity	POST /activities/add_list_memberships	Add Contacts to Lists
BulkActivitiesApi	createListDeleteActivity	POST /activities/list_delete	Delete Contact Lists
BulkActivitiesApi	createListRemoveActivity	POST /activities/remove_list_memberships	Remove Contacts from Lists
BulkActivitiesApi	createTagAddContactActivity	POST /activities/contacts_taggings_add	Add Tags to Contacts
BulkActivitiesApi	createTagDeleteActivity	POST /activities/contacts_tags_delete	Delete Tags
BulkActivitiesApi	createTagRemoveActivity	POST /activities/contacts_taggings_remove	Remove Tags from Contacts
BulkActivitiesApi	getActivityById	GET /activities/{activity_id}	GET an Activity Status
BulkActivitiesApi	getAllActivities	GET /activities	GET Activity Status Collection
BulkActivitiesApi	getCSVExportFile	GET /contact_exports/{file_export_id}	Retrieve Exported Contacts File
BulkActivitiesApi	postCustomFieldDelete	POST /activities/custom_fields_delete	Delete Custom Fields
ContactListsApi	createList	POST /contact_lists	POST (create) a List
ContactListsApi	deleteList	DELETE /contact_lists/{list_id}	DELETE a List
ContactListsApi	getAllLists	GET /contact_lists	GET Lists Collection
ContactListsApi	getList	GET /contact_lists/{list_id}	GET a List
ContactListsApi	getListIdXrefs	GET /contact_lists/list_id_xrefs	GET a collection of V2 and V3 API List IDs
ContactListsApi	updateList	PUT /contact_lists/{list_id}	PUT (update) a List
ContactTagsApi	deleteTag	DELETE /contact_tags/{tag_id}	DELETE a Tag
ContactTagsApi	getAllTags	GET /contact_tags	GET Details for All Tags
ContactTagsApi	getTag	GET /contact_tags/{tag_id}	GET Tag Details
ContactTagsApi	postTag	POST /contact_tags	POST (Create) a Tag
ContactTagsApi	putTag	PUT /contact_tags/{tag_id}	PUT (Update) a Tag
ContactsApi	createContact	POST /contacts	POST (create) a Contact
ContactsApi	createOrUpdateContact	POST /contacts/sign_up_form	Create or Update a Contact
ContactsApi	deleteContact	DELETE /contacts/{contact_id}	DELETE a Contact
ContactsApi	getAllContacts	GET /contacts	GET Contacts Collection
ContactsApi	getContactById	GET /contacts/{contact_id}	GET a Contact
ContactsApi	getContactCounts	GET /contacts/counts	GET Contact Consent Counts
ContactsApi	getContactIdXrefs	GET /contacts/contact_id_xrefs	GET a collection of V2 and V3 API contact IDs
ContactsApi	getSmsEngagementHistory	GET /contacts/sms_engagement_history/{contact_id}	GET SMS Engagement History for a Contact
ContactsApi	resubscribeContact	PUT /contacts/resubscribe/{contact_id}	PUT Resubscribe a Contact
ContactsApi	updateContact	PUT /contacts/{contact_id}	PUT (update) a Contact
ContactsCustomFieldsApi	createCustomFields	POST /contact_custom_fields	POST (create) a custom_field
ContactsCustomFieldsApi	deleteCustomField	DELETE /contact_custom_fields/{custom_field_id}	DELETE a custom_field
ContactsCustomFieldsApi	getAllCustomFields	GET /contact_custom_fields	GET custom_fields Collection
ContactsCustomFieldsApi	getCustomField	GET /contact_custom_fields/{custom_field_id}	GET a custom_field
ContactsCustomFieldsApi	updateCustomField	PUT /contact_custom_fields/{custom_field_id}	PUT (update) a custom_field
ContactsReportingApi	getContactOpenClickRateReport	GET /reports/contact_reports/{contact_id}/open_and_click_rates	GET Average Open and Click Rates
ContactsReportingApi	getContactTrackingCountReport	GET /reports/contact_reports/{contact_id}/activity_summary	GET Contact Action Summary
ContactsReportingApi	getContactTrackingReport	GET /reports/contact_reports/{contact_id}/activity_details	GET Contact Activity Details
EmailCampaignsApi	createEmailCampaign	POST /emails	POST (Create) a New Email Campaign
EmailCampaignsApi	createResendEmailCampaign	POST /emails/activities/{campaign_activity_id}/non_opener_resends	POST a Resend to Non-openers Campaign Activity
EmailCampaignsApi	deleteEmailCampaign	DELETE /emails/{campaign_id}	DELETE an Email Campaign
EmailCampaignsApi	deleteResendEmailCampaign	DELETE /emails/activities/{campaign_activity_id}/non_opener_resends/{resend_request_id}	DELETE a Resend to Non Openers Activity
EmailCampaignsApi	getAllEmailCampaigns	GET /emails	GET a Collection of Email Campaigns
EmailCampaignsApi	getEmailCampaignActivity	GET /emails/activities/{campaign_activity_id}	GET a Single Email Campaign Activity
EmailCampaignsApi	getEmailCampaignById	GET /emails/{campaign_id}	GET Details About a Single Email Campaign
EmailCampaignsApi	getEmailCampaignXrefs	GET /emails/campaign_id_xrefs	GET a Collection of V2 and V3 API Email Campaign Identifiers
EmailCampaignsApi	getResendEmailCampaign	GET /emails/activities/{campaign_activity_id}/non_opener_resends	GET Details for a Resend to Non-openers Campaign Activity
EmailCampaignsApi	patchEmailCampaignName	PATCH /emails/{campaign_id}	PATCH (Update) an Email Campaign Name
EmailCampaignsApi	updateEmailCampaignActivity	PUT /emails/activities/{campaign_activity_id}	PUT (Update) An Email Campaign Activity
EmailCampaignsABTestsApi	createABTestEmailCampaign	POST /emails/activities/{campaign_activity_id}/abtest	POST (Create) an A/B Test for an Email Campaign Activity
EmailCampaignsABTestsApi	deleteABTestEmailCampaign	DELETE /emails/activities/{campaign_activity_id}/abtest	DELETE an A/B Test for an Email Campaign Activity
EmailCampaignsABTestsApi	getABTestEmailCampaign	GET /emails/activities/{campaign_activity_id}/abtest	GET A/B Test Details for an Email Campaign Activity
EmailReportingApi	getBouncesReport	GET /reports/email_reports/{campaign_activity_id}/tracking/bounces	GET an Email Bounces Report
EmailReportingApi	getCampaignActivityLinkReport	GET /reports/email_reports/{campaign_activity_id}/links	GET an Email Links Report
EmailReportingApi	getClicksReport	GET /reports/email_reports/{campaign_activity_id}/tracking/clicks	GET an Email Clicks Report
EmailReportingApi	getDidNotOpensReport	GET /reports/email_reports/{campaign_activity_id}/tracking/didnotopens	GET an Email Did Not Opens Report
EmailReportingApi	getEmailCampaignActivityReport	GET /reports/stats/email_campaign_activities/{campaign_activity_ids}	GET an Email Campaign Activity Stats Report
EmailReportingApi	getEmailCampaignReport	GET /reports/summary_reports/email_campaign_summaries	GET an Email Campaigns Summary Report
EmailReportingApi	getEmailOpensReport	GET /reports/email_reports/{campaign_activity_id}/tracking/opens	GET an Email Opens Report
EmailReportingApi	getEmailSendsReport	GET /reports/email_reports/{campaign_activity_id}/tracking/sends	GET an Email Sends Report
EmailReportingApi	getEmailStatsReport	GET /reports/stats/email_campaigns/{campaign_ids}	GET an Email Campaign Stats Report
EmailReportingApi	getForwardsReport	GET /reports/email_reports/{campaign_activity_id}/tracking/forwards	GET an Email Forwards Report
EmailReportingApi	getOptoutsReport	GET /reports/email_reports/{campaign_activity_id}/tracking/optouts	GET an Email Opt-outs Report
EmailReportingApi	getUniqueOpensReport	GET /reports/email_reports/{campaign_activity_id}/tracking/unique_opens	GET an Email Unique Opens Report
EmailSchedulingApi	getEmailCampaignActivityPreview	GET /emails/activities/{campaign_activity_id}/previews	GET the HTML Preview of an Email Campaign Activity
EmailSchedulingApi	getEmailCampaignActivitySchedule	GET /emails/activities/{campaign_activity_id}/schedules	GET an Email Campaign Activity Schedule
EmailSchedulingApi	getEmailCampaignActivitySendHistory	GET /emails/activities/{campaign_activity_id}/send_history	GET the Send History of an Email Campaign Activity
EmailSchedulingApi	scheduleEmailCampaignActivity	POST /emails/activities/{campaign_activity_id}/schedules	POST (Create) an Email Campaign Activity Schedule
EmailSchedulingApi	testSendEmailCampaignActivity	POST /emails/activities/{campaign_activity_id}/tests	POST Test Send an Email Campaign Activity
EmailSchedulingApi	unscheduleEmailCampaignActivity	DELETE /emails/activities/{campaign_activity_id}/schedules	DELETE an Email Campaign Activity Schedule
LandingPagesReportingApi	getContactAdds	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_adds	GET a Unique Contacts Adds Landing Page Report
LandingPagesReportingApi	getContactOpens	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_contact_opens	GET a Contacts Opens Landing Page Report
LandingPagesReportingApi	getUniqueContactClicks	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_clicks	GET a Unique Contacts Clicks Landing Page Report
LandingPagesReportingApi	getUniqueContactOpens	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_opens	GET a Unique Contacts Opens Landing Page Report
LandingPagesReportingApi	getUniqueContactSMSOptIns	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_sms_optins	GET a Unique Contacts SMS Opt-In Landing Page Report
LandingPagesReportingApi	getUniqueContactUpdates	GET /reports/landing_pages/campaign_details/{campaign_activity_id}/p_unique_contact_updates	GET a Unique Contacts Updates Landing Page Report
SMSReportingApi	getAllBulkSmsCampaignSummaries	GET /reports/summary_reports/sms_campaign_summaries	GET an SMS Campaigns Summary Report
SegmentsApi	createSegment	POST /segments	POST (create) a Segment
SegmentsApi	deleteSegment	DELETE /segments/{segment_id}	DELETE a Segment
SegmentsApi	getAllSegments	GET /segments	GET all Segments
SegmentsApi	getSegmentById	GET /segments/{segment_id}	GET a Segment's Details
SegmentsApi	updateSegment	PUT /segments/{segment_id}	PUT (update) a Segment
SegmentsApi	updateSegmentName	PATCH /segments/{segment_id}/name	PATCH (rename) a Segment

Models

Authorization

Authentication schemes defined for the API:

oauth2_access_code

Type: OAuth
Flow: accessCode
Authorization URL: https://authz.constantcontact.com/oauth2/default/v1/authorize
Scopes:
contact_data: Read or modify contact data.
campaign_data: Read or modify email campaign data.
account_read: Read account data.
account_update: Modify account data.

Author

webservices@constantcontact.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.182
- Package version: 1.7.0
Generator version: 7.2.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

constantcontactpublicapi / constant-contact-v3api-client-php

Maintainers

Details