Email Scheduling

GET the Send History of an Email Campaign Activity

Changed on

Use this method to return the send history of an email campaign activity. This method returns the send history as an array containing an object for each time you sent a specific email campaign activity to contacts.

Each send history object contains the email campaign activity send date, the number of contacts it was sent to, and the contact lists or segments used to send it. Each send history object also includes if the send attempt completed or encountered an error, and the reason why each error occurred. This method returns results in ascending order starting with the first send attempt.

If the email campaign activity has not been sent to contacts, this method returns a 200 response and an empty array.

get/emails/activities/{campaign_activity_id}/send_history

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/emails/activities/{campaign_activity_id}/send_history
  • Auth
    • OAuth 2
      Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Scopes: campaign_data
    • or OAuth 2
      Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Token URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: campaign_data

Path parameters

campaign_activity_idstring required

The unique ID for an email campaign activity. You can return the send history for primary_email and resend role email campaign activities.

Response

Request successful.

send_idinteger

Uniquely identifies each send history object using the number of times that you sent the email campaign activity as a sequence starting at <code>1</code>. For example, when you send a specific email campaign activity twice this method returns an object with a <code>send_id</code> of 1 for the first send and an object with a <code>send_id</code> of 2 for the second send.

contact_list_idsstring[]

The contacts lists that Constant Contact sent email campaign activity to as an array of contact <code>list_id</code> strings.

segment_idsinteger[]

The contact segments that Constant Contact sent the email campaign activity to as an array of <code>segment_id</code> integers.

countinteger

The number of contacts that Constant Contact sent this email campaign activity to. This property is specific to each send history object. When you resend an email campaign activity, Constant Contact only sends it to new contacts in the contact lists or segments you are using.

run_datestring date-time

The system generated date and time that Constant Contact sent the email campaign activity to contacts in ISO-8601 format.

send_statusstring

The send status for the email campaign activity. Valid values are: <ul>

<li><code>COMPLETED</code>: Constant Contact successfully sent the email campaign activity.</li> <li><code>ERRORED</code>: Constant Contact encountered an error when sending the email campaign activity.<li> </ul>
reason_codeinteger

The reason why the send attempt completed or encountered an error. This method returns <code>0</code> if Constant Contact successfully sent the email campaign activity to contacts. Possible <code>reason_code</code> values are: <ul> <li>0 — Constant Contact successfully sent the email to contacts.</li> <li>1 — An error occurred when sending this email. Try scheduling it again, or contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a>.</li> <li>2 — We were unable to send the email. Please contact our <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/5782-contact-an-account-review-and-deliverability-specialist' target='_blank'>Account Review Team</a> for more information.</li> <li>3 — This Constant Contact account cannot currently send emails. This can be due to billing or product expiration.</li> <li>4 — You're not able to send the email to that many contacts. Remove contacts from the contact lists you are using or select a list with fewer contacts.</li> <li>5 — The email is currently in staging. For more information, see the <a href='http://knowledgebase.constantcontact.com/articles/KnowledgeBase/7402-email-staging' target='_blank>Email Staging Knowledge Base article</a>.</li> <li>6 — Constant Contact was unable to finish sending this email to all of the contacts on your list. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li> <li>7 — The email contains invalid images. This can be caused when one or more images in the email are longer available in your image library.</li> <li>8 — The email contains a link URL that exceeds 1005 characters.</li> <li>9 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li> <li>10 — Constant Contact was unable to verify your authenticated Sender address. Please contact <a href='http://support.constantcontact.com' target='_blank'>Customer Support</a> for more information.</li> <li>11 — This Constant Contact account cannot send survey invitations.</li> <li>12 — Constant Contact attempted to send the email, but there were no eligible contacts to send it to. This can be caused by an invalid contact list, a contact list with no contacts, or a contact list with no new contacts during a resend. This method displays <code>reason_code</code> 12 as a send attempt with a <code>send_status</code> of COMPLETED and a <code>count</code> of 0.</li>

</ul>

Example response

[
  {
    "send_id": 1,
    "contact_list_ids": [
      "72876990-b664-11e5-844a-00163e0cb6a5"
    ],
    "segment_ids": [
      57
    ],
    "count": 200,
    "run_date": "2018-06-27T10:28:09.000Z",
    "send_status": "COMPLETED"
  }
]

Changes