{
  "opencollection": "1.0.0",
  "info": {
    "name": "AppConnect V3 Account Services Email Campaigns API",
    "version": "3.0.149"
  },
  "items": [
    {
      "info": {
        "name": "Email Campaigns",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GET a Collection of Email Campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/emails",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "before_date",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "after_date",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ]
          },
          "docs": "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.\n\nThis 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.\"\n<div cla"
        },
        {
          "info": {
            "name": "POST (Create) a New Email Campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/emails"
          },
          "docs": "Use this method to create a new email campaign. You must include a tracking image (`[[trackingImage]]`) in the email body in order for Constant Contact to report on the email performance. This method also creates new `primary_email` and `permalink` email campaign activities and associates them with the new email campaign.\nThe 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 "
        },
        {
          "info": {
            "name": "GET Details About a Single Email Campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/emails/:campaign_id",
            "params": [
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "The ID (UUID format) that uniquely identifies this email campaign."
              }
            ]
          },
          "docs": "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`."
        },
        {
          "info": {
            "name": "PATCH (Update) an Email Campaign Name",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/emails/:campaign_id",
            "params": [
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier for an email campaign."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "DELETE an Email Campaign",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/emails/:campaign_id",
            "params": [
              {
                "name": "campaign_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the email campaign you are deleting."
              }
            ]
          },
          "docs": "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.\n\nConstant Contact users can restore deleted email campaigns using the UI.\n"
        },
        {
          "info": {
            "name": "GET a Collection of V2 and V3 API Email Campaign Identifiers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/emails/campaign_id_xrefs",
            "params": [
              {
                "name": "v2_email_campaign_ids",
                "value": "",
                "type": "query",
                "description": "Comma separated list of V2 API `campaignId` values. You can enter up to 50 V2 `campaignId` values in each request."
              }
            ]
          },
          "docs": "<div class=\"Msg Msg--warning\"><p class=\"note-text\">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.</p></div>\n\nUse 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, th"
        },
        {
          "info": {
            "name": "GET a Single Email Campaign Activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/emails/activities/:campaign_activity_id",
            "params": [
              {
                "name": "campaign_activity_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for an email campaign activity."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "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`."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "PUT (Update) An Email Campaign Activity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/emails/activities/:campaign_activity_id",
            "params": [
              {
                "name": "campaign_activity_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the email campaign activity you are updating."
              }
            ]
          },
          "docs": "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.\n\nYou can only update email campaign activities that have the `primary_email` role and that are in `DRAFT` or `Done` status.\nWhen you use a PUT method to update a resource, the V3 API overwrites any properties that are missing in the request body. However, t"
        },
        {
          "info": {
            "name": "GET Details for a Resend to Non-openers Campaign Activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/non_opener_resends",
            "params": [
              {
                "name": "campaign_activity_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the primary email campaign activity."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "POST a Resend to Non-openers Campaign Activity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/non_opener_resends",
            "params": [
              {
                "name": "campaign_activity_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the primary email campaign activity."
              }
            ]
          },
          "docs": "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.\n \n 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_minute"
        },
        {
          "info": {
            "name": "DELETE a Resend to Non Openers Activity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/non_opener_resends/:resend_request_id",
            "params": [
              {
                "name": "campaign_activity_id",
                "value": "",
                "type": "path",
                "description": "The unique ID for the primary email campaign activity."
              },
              {
                "name": "resend_request_id",
                "value": "",
                "type": "path",
                "description": "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."
              }
            ]
          },
          "docs": "Use this `DELETE` method to delete (unschedule) a resend to non openers activity."
        }
      ]
    }
  ],
  "bundled": true
}