OpenAPI\Client\AccountServicesApi

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

Method	HTTP request	Description
addAccountEmailAddress()	POST /account/emails	POST Add an Account Email Address
getAccountById()	GET /account/summary	GET a Summary of Account Details
getPhysicalAddress()	GET /account/summary/physical_address	GET the Physical Address for the Account
getUserPrivileges()	GET /account/user/privileges	GET User Privileges
putCustomerById()	PUT /account/summary	PUT (update) Account Details
putPhysicalAddress()	PUT /account/summary/physical_address	PUT (update) the Physical Address for an Account
retrieveEmailAddresses()	GET /account/emails	GET a Collection of Account Email Addresses

`addAccountEmailAddress()`

addAccountEmailAddress($body): 'ConstantContact\Client\Model\AccountEmailCreateResponse

POST Add an Account Email Address

Use this method to add a new email address to a Constant Contact account. If the email address you are adding already exists in the account the API will return a 409 conflict error. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. After a user clicks that link, the account email status changes from UNCONFIRMED to CONFIRMED. You can use confirmed account email addresses in the email campaign from_email and reply_to_email headers. For more use case information, see Add an Account Email Address 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\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
);
$body = new 'ConstantContact\Client\Model\AccountEmailInput(); // 'ConstantContact\Client\Model\AccountEmailInput | A JSON request payload containing the new email address you want to add to the Constant Contact account.

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

Parameters

Name	Type	Description	Notes
body	\OpenAPI\Client\Model\AccountEmailInput	A JSON request payload containing the new email address you want to add to the Constant Contact account.

Return type

\OpenAPI\Client\Model\AccountEmailCreateResponse

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]

`getAccountById()`

getAccountById($extra_fields): 'ConstantContact\Client\Model\Customer

GET a Summary of Account Details

Get account related details for a Constant Contact user account. Use the extra_fields query parameter to include the company_logo and/or physical_address details in the response body. For more details, see Get Account Summary Details.

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\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
);
$extra_fields = company_logo; // string | Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo).

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

Parameters

Name	Type	Description	Notes
extra_fields	string	Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo).	[optional]

Return type

\OpenAPI\Client\Model\Customer

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]

`getPhysicalAddress()`

getPhysicalAddress(): 'ConstantContact\Client\Model\AccountPhysicalAddress

GET the Physical Address for the Account

Use this method to get the address where the account's organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account.

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\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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\AccountPhysicalAddress

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]

`getUserPrivileges()`

getUserPrivileges(): 'ConstantContact\Client\Model\UserPrivilegesResourceInner[]

GET User Privileges

Use this method to return the user privileges associated with your access token as an array of objects. This method returns all user privileges, including privileges the V3 API does not currently use. Constant Contact requires specific user privileges to make requests using the V3 API. For more information, see the User Privileges and Roles Overview.

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\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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\UserPrivilegesResourceInner[]

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]

`putCustomerById()`

putCustomerById($body): 'ConstantContact\Client\Model\CustomerPut

PUT (update) Account Details

Use this method to update account details for a Constant Contact account, such as the email address or phone number. This PUT method provides a partial update where only valid properties that you include in the request body are updated and excluded properties are not overwritten. For more details, see Put (update) Account Summary Details.

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\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
);
$body = new 'ConstantContact\Client\Model\CustomerPut(); // 'ConstantContact\Client\Model\CustomerPut | In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored.

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

Parameters

Name	Type	Description	Notes
body	\OpenAPI\Client\Model\CustomerPut	In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored.

Return type

\OpenAPI\Client\Model\CustomerPut

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]

`putPhysicalAddress()`

putPhysicalAddress($body): 'ConstantContact\Client\Model\AccountPhysicalAddress

PUT (update) the Physical Address for an Account

Use this method to update the organization's physical address for the Constant Contact user account. The physical address is required to send emails and displays on the footer of every email that is sent from the account. To get the current physical address, make a GET call to /account/summary/physical_address. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. For more details, see Put (update) the Physical Address for the Account. You must have the role of Account Owner assigned to update account level details.

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\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
);
$body = new 'ConstantContact\Client\Model\AccountPhysicalAddress(); // 'ConstantContact\Client\Model\AccountPhysicalAddress | Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.

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

Parameters

Name	Type	Description	Notes
body	\OpenAPI\Client\Model\AccountPhysicalAddress	Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address.

Return type

\OpenAPI\Client\Model\AccountPhysicalAddress

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]

`retrieveEmailAddresses()`

retrieveEmailAddresses($confirm_status, $role_code, $email_address): 'ConstantContact\Client\Model\AccountEmailsInner[]

GET a Collection of Account Email Addresses

Use this method to return a collection of email addresses for the account associated with your access token. When you <a href="https://v3.developer.constantcontact.com/api_reference/index.html#!/Email_Campaigns/createEmailCampaignUsingPOST\" target="_blank">Create an Email Campaign, you must use an account email address with a CONFIRMED status in the email campaign from_email and reply_to_email headers. Use the query parameters to filter results. You can filter using confirm_status, role_code, or email_address. For example, searching with confirm_status=CONFIRMED returns all confirmed email addresses in the account. This method only supports one query parameter at a time.

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\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
);
$confirm_status = 'confirm_status_example'; // string | Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`.
$role_code = 'role_code_example'; // string | Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`.
$email_address = 'email_address_example'; // string | Use the `email_address` query parameter to search for a specific account email address.

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

Parameters

Name	Type	Description	Notes
confirm_status	string	Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`.	[optional]
role_code	string	Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`.	[optional]
email_address	string	Use the `email_address` query parameter to search for a specific account email address.	[optional]

Return type

\OpenAPI\Client\Model\AccountEmailsInner[]

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]

Files

AccountServicesApi.md

Latest commit

History

AccountServicesApi.md

File metadata and controls

OpenAPI\Client\AccountServicesApi

addAccountEmailAddress()

Example

Parameters

Return type

Authorization

HTTP request headers

getAccountById()

Example

Parameters

Return type

Authorization

HTTP request headers

getPhysicalAddress()

Example

Parameters

Return type

Authorization

HTTP request headers

getUserPrivileges()

Example

Parameters

Return type

Authorization

HTTP request headers

putCustomerById()

Example

Parameters

Return type

Authorization

HTTP request headers

putPhysicalAddress()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveEmailAddresses()

Example

Parameters

Return type

Authorization

HTTP request headers

`addAccountEmailAddress()`

`getAccountById()`

`getPhysicalAddress()`

`getUserPrivileges()`

`putCustomerById()`

`putPhysicalAddress()`

`retrieveEmailAddresses()`