Sign in

v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Email Campaigns

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.

get/emails/{campaign_id}

Path parameters

campaign_idstring required

The ID (UUID format) that uniquely identifies this email campaign.

Response

Request successful.

campaign_idstring

The unique ID used to identify the email campaign (UUID format).

created_atstring date-time

The system generated date and time that this email campaign was created. This string is readonly and is in ISO-8601 format.

current_statusstring

The current status of the email campaign. Valid values are: <ul>

<li>Draft — An email campaign that you have created but have not sent to contacts.</li> <li>Scheduled — An email campaign that you have scheduled for Constant Contact to send to contacts.</li> <li>Executing — An email campaign that Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.</li> <li>Done — An email campaign that you successfully sent to contacts.</li> <li>Error — An email campaign activity that encountered an error.</li> <li>Removed — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.</li> </ul>
namestring

The descriptive name the user provides to identify this campaign. Campaign names must be unique for each account ID.

typestring

Identifies the type of campaign that you select when creating the campaign. Newsletter and Custom Code email campaigns are the primary types.

type_codeinteger

The code used to identify the email campaign type. <ul>

<li> 1 (Default) </li> <li> 2 (Bulk Email) </li> <li> 10 (Newsletter) </li> <li> 11 (Announcement) </li> <li> 12 (Product/Service News) </li> <li> 14 (Business Letter) </li> <li> 15 (Card) </li> <li> 16 (Press release)</li> <li> 17 (Flyer) </li> <li> 18 (Feedback Request) </li> <li> 19 (Ratings and Reviews) </li> <li> 20 (Event Announcement) </li> <li> 21 (Simple Coupon) </li> <li> 22 (Sale Promotion) </li> <li> 23 (Product Promotion) </li> <li> 24 (Membership Drive) </li> <li> 25 (Fundraiser) </li> <li> 26 (Custom Code Email)</li> <li> 57 (A/B Test)</li> </ul>
updated_atstring date-time

The system generated date and time showing when the campaign was last updated. This string is read only and is in ISO-8601 format.

Example response

{
  "campaign_activities": [
    {
      "campaign_activity_id": "0e3feddd-c8da-4d53-a507-aae5082b8b75",
      "role": "primary_email",
      "document_id": "21babb03-8385-4739-b9cc-n6cce44633a7"
    }
  ],
  "campaign_id": "8987dc1a-48ef-433a-b836-7ca4f9aa3481",
  "created_at": "2018-02-06T22:09:15.000Z",
  "current_status": "Draft",
  "name": "December Newsletter for Dog Lovers",
  "type": "NEWSLETTER",
  "type_code": 10,
  "updated_at": "2018-06-27T10:28:09.000Z"
}