Make a GET call to the /account/emails
endpoint to return a collection of email addresses for the account associated with your access token. This method also returns the status of each email address in the response body. When you Create an Email Campaign, you must use an account email address with a CONFIRMED
status in the email campaign activity from_email
and reply_to_email
headers.
This method returns all email addresses associated with the Constant Contact account owner. The contact email for other users in an account, such as account managers or campaign creators, are not returned in the response body. For more information on the different types of users in Constant Contact, see the User Roles and Privileges Overview topic.
Parameters
You can use a optional query parameter to filter the results. This method only supports one query parameter at a time.
Use the confirm_status
query parameter to search for account emails that have a specific status. Possible values are CONFIRMED
or UNCONFIRMED
.
Use the email_address
query parameter to search for a specific email address in the account.
Use the role_code
query parameter to search for account emails that have a specific role. Each email address in an account can have multiple roles or no role. Possible role values are:
CONTACT — The contact email for the Constant Contact account owner. Each account can only have one CONTACT
role email.
BILLING — The billing address for the Constant Contact account. Each account can only have one BILLING
role email.
REPLY_TO — The contact email that Constant Contact displays in the email campaign signature. Each account can only have one REPLY_TO
role email.
JOURNALING — An email address that Constant Contact forwards all sent email campaigns to as part of the partner journaling compliance feature.
OTHER — An email address that does not fit into the other categories and has the OTHER
role assigned.
Example Get Account Emails Collection Call
This example GET call uses the confirm_status
query parameter to return an array of objects containing confirmed account email addresses.
GET https://api.cc.email/v3/account/emails?confirm_status=CONFIRMED
Endpoint Requirements
User privileges: account:read
Authorization scopes: account_read
<?php
$request = new HttpRequest();
$request->setUrl('https://api.cc.email/v3/account/emails');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData(array(
'confirm_status' => 'CONFIRMED'
));
$request->setHeaders(array(
'Postman-Token' => 'af063623-26ec-40ef-a1de-746a392c7cc4',
'cache-control' => 'no-cache',
'Authorization' => 'Bearer {access_token}'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://api.cc.email/v3/account/emails?confirm_status=CONFIRMED")
.get()
.addHeader("Authorization", "Bearer {access_token}")
.addHeader("cache-control", "no-cache")
.addHeader("Postman-Token", "62333abf-da0d-4007-af76-fad814a48cf6")
.build();
Response response = client.newCall(request).execute();
curl -X GET \
'https://api.cc.email/v3/account/emails?confirm_status=CONFIRMED' \
-H 'Authorization: Bearer {access_token}' \
-H 'Postman-Token: 288cc772-f572-4367-aded-3119de481747' \
-H 'cache-control: no-cache'
Response
[
{
"email_address": "jdodge@example.com",
"email_id": 1,
"confirm_status": "CONFIRMED",
"confirm_time": "2018-06-11T14:22:30.335+0000",
"confirm_source_type": "SITE_OWNER",
"roles": [
"CONTACT",
"BILLING",
"REPLY_TO"
]
},
{
"email_address": "jdodgepancakes@example.com",
"email_id": 2,
"confirm_status": "CONFIRMED",
"confirm_time": "2018-06-13T14:16:34.450+0000",
"confirm_source_type": "SITE_OWNER",
"roles": []
}
]