OpenAPI\Client\EmailCampaignsApi

All URIs are relative to https://api.cc.email/v3, except if the operation defines another base path.

Method	HTTP request	Description
createEmailCampaignUsingPOST()	POST /emails	POST (Create) a New Email Campaign
createResendToNonOpenersUsingPOST()	POST /emails/activities/{campaign_activity_id}/non_opener_resends	POST a Resend to Non-openers Campaign Activity
deleteResendToNonOpenersUsingDELETE()	DELETE /emails/activities/{campaign_activity_id}/non_opener_resends/{resend_request_id}	DELETE a Resend to Non Openers Activity
removeEmailCampaignUsingDELETE()	DELETE /emails/{campaign_id}	DELETE an Email Campaign
renameEmailCampaignUsingPATCH()	PATCH /emails/{campaign_id}	PATCH (Update) an Email Campaign Name
retrieveEmailCampaignActivityUsingGET()	GET /emails/activities/{campaign_activity_id}	GET a Single Email Campaign Activity
retrieveEmailCampaignUsingGET()	GET /emails/{campaign_id}	GET Details About a Single Email Campaign
retrieveEmailCampaignsUsingGET()	GET /emails	GET a Collection of Email Campaigns
retrieveResendToNonOpenersUsingGET()	GET /emails/activities/{campaign_activity_id}/non_opener_resends	GET Details for a Resend to Non-openers Campaign Activity
retrieveXrefMappingsUsingGET()	GET /emails/campaign_id_xrefs	GET a Collection of V2 and V3 API Email Campaign Identifiers
updateEmailCampaignActivityUsingPUT()	PUT /emails/activities/{campaign_activity_id}	PUT (Update) An Email Campaign Activity

`createEmailCampaignUsingPOST()`

createEmailCampaignUsingPOST($body): \OpenAPI\Client\Model\EmailCampaign

POST (Create) a New Email Campaign

Use this method to create a new email campaign. This method also creates new primary_email and permalink email campaign activities and associates them with the new email campaign. The request body must contain the name property and the email_campaign_activities array. The name must be unique. The email_campaign_activities array contains the main content of your email campaign and must include format_type, from_name, from_email, reply_to_email, subject, and html_content properties. The from_email address you use must use a verified email address for your account. NOTE: If you create an email campaign using a legacy (V7) format, Constant Contact automatically converts it to the newer custom code format.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$body = new \OpenAPI\Client\Model\EmailCampaignComplete(); // \OpenAPI\Client\Model\EmailCampaignComplete | A JSON request body that contains the email content.

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

Parameters

Name	Type	Description	Notes
body	\OpenAPI\Client\Model\EmailCampaignComplete	A JSON request body that contains the email content.

Return type

\OpenAPI\Client\Model\EmailCampaign

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createResendToNonOpenersUsingPOST()`

createResendToNonOpenersUsingPOST($campaign_activity_id, $resend_schedule): \OpenAPI\Client\Model\ResendToNonOpenersObject

POST a Resend to Non-openers Campaign Activity

Use this POST method to resend a primary campaign activity to contacts that did not open a campaign activity that has a current status of Draft, Scheduled, or Done. You can only create one resend activity per email campaign. After an email campaign activity is sent to contacts, Constant Contact waits the specified number of delay_days or delay_minutes (properties are mutually exclusive) before resending to non-openers. If you set both delay_days or delay_minutes, delay_minutes is ignored in the request. You can resend to non-openers a minimum of twelve hours (720 minutes) and a maximum of up to 10 days (or 10 x 1440 minutes) after the initial send date.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_activity_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The unique ID for the primary email campaign activity.
$resend_schedule = new \OpenAPI\Client\Model\ResendToNonOpenersInput(); // \OpenAPI\Client\Model\ResendToNonOpenersInput | A JSON request body that specifies when to resend the campaign activity to non-openers.

try {
    $result = $apiInstance->createResendToNonOpenersUsingPOST($campaign_activity_id, $resend_schedule);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->createResendToNonOpenersUsingPOST: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_activity_id	string	The unique ID for the primary email campaign activity.
resend_schedule	\OpenAPI\Client\Model\ResendToNonOpenersInput	A JSON request body that specifies when to resend the campaign activity to non-openers.

Return type

\OpenAPI\Client\Model\ResendToNonOpenersObject

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteResendToNonOpenersUsingDELETE()`

deleteResendToNonOpenersUsingDELETE($campaign_activity_id, $resend_request_id)

DELETE a Resend to Non Openers Activity

Use this DELETE method to delete (unschedule) a resend to non openers activity.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_activity_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The unique ID for the primary email campaign activity.
$resend_request_id = 389093; // string | The unique ID associated with the resend for the email campaign activity (for example: `389093`). If the email campaign activity is currently in draft status, specify `DRAFT` as the ID.

try {
    $apiInstance->deleteResendToNonOpenersUsingDELETE($campaign_activity_id, $resend_request_id);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->deleteResendToNonOpenersUsingDELETE: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_activity_id	string	The unique ID for the primary email campaign activity.
resend_request_id	string	The unique ID associated with the resend for the email campaign activity (for example: `389093`). If the email campaign activity is currently in draft status, specify `DRAFT` as the ID.

Return type

void (empty response body)

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`removeEmailCampaignUsingDELETE()`

removeEmailCampaignUsingDELETE($campaign_id)

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.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The unique ID for the email campaign you are deleting.

try {
    $apiInstance->removeEmailCampaignUsingDELETE($campaign_id);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->removeEmailCampaignUsingDELETE: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The unique ID for the email campaign you are deleting.

Return type

void (empty response body)

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`renameEmailCampaignUsingPATCH()`

renameEmailCampaignUsingPATCH($campaign_id, $body): \OpenAPI\Client\Model\EmailCampaign

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.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The unique identifier for an email campaign.
$body = new \OpenAPI\Client\Model\EmailCampaignName(); // \OpenAPI\Client\Model\EmailCampaignName | A JSON payload that contains the new email campaign name.

try {
    $result = $apiInstance->renameEmailCampaignUsingPATCH($campaign_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->renameEmailCampaignUsingPATCH: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The unique identifier for an email campaign.
body	\OpenAPI\Client\Model\EmailCampaignName	A JSON payload that contains the new email campaign name.

Return type

\OpenAPI\Client\Model\EmailCampaign

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveEmailCampaignActivityUsingGET()`

retrieveEmailCampaignActivityUsingGET($campaign_activity_id, $include): \OpenAPI\Client\Model\EmailCampaignActivity

GET a Single Email Campaign Activity

Use this method to return a specific email campaign activity. Each email campaign activity contains the email content, metadata, and styling information of an email. Email campaign activities can also contain either contact lists or segments. Constant Contact uses this information to determine who to send the email campaign activity to when you schedule it. You cannot get email campaign activities that have a REMOVED status.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_activity_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The unique ID for an email campaign activity.
$include = 'include_example'; // string | Use the `include` query parameter to enter a comma separated list of additional email campaign activity properties for the V3 API to return. Valid values are `physical_address_in_footer`, `permalink_url`, `html_content`, and `document_properties`.

try {
    $result = $apiInstance->retrieveEmailCampaignActivityUsingGET($campaign_activity_id, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->retrieveEmailCampaignActivityUsingGET: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_activity_id	string	The unique ID for an email campaign activity.
include	string	Use the `include` query parameter to enter a comma separated list of additional email campaign activity properties for the V3 API to return. Valid values are `physical_address_in_footer`, `permalink_url`, `html_content`, and `document_properties`.	[optional]

Return type

\OpenAPI\Client\Model\EmailCampaignActivity

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveEmailCampaignUsingGET()`

retrieveEmailCampaignUsingGET($campaign_id): \OpenAPI\Client\Model\EmailCampaign

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.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The ID (UUID format) that uniquely identifies this email campaign.

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

Parameters

Name	Type	Description	Notes
campaign_id	string	The ID (UUID format) that uniquely identifies this email campaign.

Return type

\OpenAPI\Client\Model\EmailCampaign

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveEmailCampaignsUsingGET()`

retrieveEmailCampaignsUsingGET($limit, $before_date, $after_date): \OpenAPI\Client\Model\PagedEmailCampaignResponse

GET a Collection of Email Campaigns

Use this method to list and get details about your email campaigns. By default, this method returns all email campaigns for the user account including deleted email campaigns. To get email campaigns within a date-range, use the after_date and before_date query parameters. This endpoint does not return campaign activity details for each email campaign in the collection. To get email campaign activity details for a single email campaign, use the GET /emails/{campaign_id} endpoint." <div class="Msg"><p class="note-text">This method does not currently support filtering results using the email campaign creation date.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$limit = 50; // int | Specifies the number of campaigns to display on each page of output that is returned (from return 1 - 500). The default returns 50 campaigns per page.
$before_date = 2021-01-10T11:42:57.000Z; // \DateTime | Use to return email campaigns with `updated_at` timestamps that are before a specific date and time (in ISO-8601 format). Use with the `after_date` query parameter to get email campaigns sent within a specific date range.
$after_date = 2021-03-10T11:42:57.000Z; // \DateTime | Use to return email campaigns with last `updated_at` timestamps that are after a specific date and time (in ISO-8601 format). Use with the `before_date` query parameter to get email campaigns sent within a specific date range.

try {
    $result = $apiInstance->retrieveEmailCampaignsUsingGET($limit, $before_date, $after_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->retrieveEmailCampaignsUsingGET: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
limit	int	Specifies the number of campaigns to display on each page of output that is returned (from return 1 - 500). The default returns 50 campaigns per page.	[optional] [default to 50]
before_date	\DateTime	Use to return email campaigns with `updated_at` timestamps that are before a specific date and time (in ISO-8601 format). Use with the `after_date` query parameter to get email campaigns sent within a specific date range.	[optional]
after_date	\DateTime	Use to return email campaigns with last `updated_at` timestamps that are after a specific date and time (in ISO-8601 format). Use with the `before_date` query parameter to get email campaigns sent within a specific date range.	[optional]

Return type

\OpenAPI\Client\Model\PagedEmailCampaignResponse

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveResendToNonOpenersUsingGET()`

retrieveResendToNonOpenersUsingGET($campaign_activity_id): \OpenAPI\Client\Model\ResendToNonOpenersInner[]

GET Details for a Resend to Non-openers Campaign Activity

Get details about a resend to non-openers campaign activity. If resend activity does not exist for the specified campaign_activity_id, an empty list is returned in the results. You can only create one resend activity per email campaign.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_activity_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The unique ID for the primary email campaign activity.

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

Parameters

Name	Type	Description	Notes
campaign_activity_id	string	The unique ID for the primary email campaign activity.

Return type

\OpenAPI\Client\Model\ResendToNonOpenersInner[]

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveXrefMappingsUsingGET()`

retrieveXrefMappingsUsingGET($v2_email_campaign_ids): \OpenAPI\Client\Model\CrossReferenceResponse

GET a Collection of V2 and V3 API Email Campaign Identifiers

Use this endpoint to migrate your locally stored V2 email campaign data to the new V3 format. Developers are expected to use this endpoint sparingly. This endpoint is NOT intended for regular or repeated use. Constant Contact will eventually deprecate and remove this endpoint.

Use this method to migrate your local V2 API email data to the V3 API format. For each value that you provide in the `v2_email_campaign_ids` query parameter, this method returns the corresponding V3 `campaign_id` and V3 `campaign_activity_id` UUID value. For more information on the changes to the email campaign resource model, see [V3 Email Campaign Resource Changes](/api_guide/v3_v2_email_campaign_deltas.html) in the API guide.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$v2_email_campaign_ids = 1100567546598,1604567396117,12002485195578; // string | Comma separated list of V2 API `campaignId` values. You can enter up to 50 V2 `campaignId` values in each request.

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

Parameters

Name	Type	Description	Notes
v2_email_campaign_ids	string	Comma separated list of V2 API `campaignId` values. You can enter up to 50 V2 `campaignId` values in each request.

Return type

\OpenAPI\Client\Model\CrossReferenceResponse

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateEmailCampaignActivityUsingPUT()`

updateEmailCampaignActivityUsingPUT($campaign_activity_id, $body): \OpenAPI\Client\Model\EmailCampaignActivity

PUT (Update) An Email Campaign Activity

Use this method to update an email campaign activity by including the complete email campaign activity with your changes in the request body. The request body requires the from_name, from_email, reply_to_email, and subject properties. You can only update email campaign activities that have the primary_email role and that are in DRAFT or Done status. When you use a PUT method to update a resource, the V3 API overwrites any properties that are missing in the request body. However, the V3 API does not overwrite subresources that you omit in the request body or missing properties in subresources. This method considers physical_address_in_footer, document_properties, html_content, and permalink_url subresources of the email campaign activity.

Example

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


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

// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\EmailCampaignsApi(
    // 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
);
$campaign_activity_id = 91569d46-00e4-4a4d-9a4c-d17d98740d04; // string | The unique ID for the email campaign activity you are updating.
$body = new \OpenAPI\Client\Model\EmailCampaignActivity(); // \OpenAPI\Client\Model\EmailCampaignActivity | A request body payload that contains the complete email campaign activity with your changes.

try {
    $result = $apiInstance->updateEmailCampaignActivityUsingPUT($campaign_activity_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailCampaignsApi->updateEmailCampaignActivityUsingPUT: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_activity_id	string	The unique ID for the email campaign activity you are updating.
body	\OpenAPI\Client\Model\EmailCampaignActivity	A request body payload that contains the complete email campaign activity with your changes.

Return type

\OpenAPI\Client\Model\EmailCampaignActivity

Authorization

oauth2_access_code, api_key, oauth2_implicit

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

EmailCampaignsApi.md

Latest commit

History

EmailCampaignsApi.md

File metadata and controls

OpenAPI\Client\EmailCampaignsApi

createEmailCampaignUsingPOST()

Example

Parameters

Return type

Authorization

HTTP request headers

createResendToNonOpenersUsingPOST()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteResendToNonOpenersUsingDELETE()

Example

Parameters

Return type

Authorization

HTTP request headers

removeEmailCampaignUsingDELETE()

Example

Parameters

Return type

Authorization

HTTP request headers

renameEmailCampaignUsingPATCH()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveEmailCampaignActivityUsingGET()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveEmailCampaignUsingGET()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveEmailCampaignsUsingGET()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveResendToNonOpenersUsingGET()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveXrefMappingsUsingGET()

Example

Parameters

Return type

Authorization

HTTP request headers

updateEmailCampaignActivityUsingPUT()

Example

Parameters

Return type

Authorization

HTTP request headers

`createEmailCampaignUsingPOST()`

`createResendToNonOpenersUsingPOST()`

`deleteResendToNonOpenersUsingDELETE()`

`removeEmailCampaignUsingDELETE()`

`renameEmailCampaignUsingPATCH()`

`retrieveEmailCampaignActivityUsingGET()`

`retrieveEmailCampaignUsingGET()`

`retrieveEmailCampaignsUsingGET()`

`retrieveResendToNonOpenersUsingGET()`

`retrieveXrefMappingsUsingGET()`

`updateEmailCampaignActivityUsingPUT()`