Constant Contact V3: LIVE SEND - Schedule a newsletter for a named list
See more Constant Contact Examples
LIVE SEND. Scheduling this campaign delivers email to eligible contacts on the selected list at the specified time. Use the reviewer test to check the email first. Select the intended newsletter and list in the same account. The example accepts a primary draft, replaces its entire audience with one active email list, and schedules it. List lookup requires contact_data. Editing and scheduling require campaign_data and account privileges to edit and send.
Enter a future ISO 8601 timestamp with a UTC offset or Z. To cancel before delivery starts, keep the same activity selection, change action to unschedule, and run again. Cancellation removes the schedule and keeps the audience assignment. If the scheduling response is lost, check the activity’s schedule before retrying.
Authorize the application using the same account and credential store.
Constant Contact developer guide
Chilkat VB.NET Downloads
Dim success As Boolean = False
' LIVE SEND: Scheduling this activity delivers email to the selected contact list.
' Assumes Chilkat is unlocked. See Global Unlock Sample.
Dim vault As New Chilkat.Secrets
vault.Location = "local_manager"
vault.AutoSplit = True
Dim entry As New Chilkat.JsonObject
entry.UpdateString("appName","ConstantContactV3")
entry.UpdateString("service","OAuth2")
entry.UpdateString("username","my-account")
Dim tokens As New Chilkat.JsonObject
Dim loaded As Boolean = vault.GetSecretJson(entry,tokens)
If (loaded <> True) Then
Debug.WriteLine("Run the desktop authorization example using this account and store.")
Exit Sub
End If
If (tokens.JsonTypeOf("access_token") <> 1) Then
Debug.WriteLine("The saved authorization has no access token.")
Exit Sub
End If
Dim http As New Chilkat.Http
http.RequireSslCertVerify = True
http.AuthToken = tokens.StringOf("access_token")
Dim resp As New Chilkat.HttpResponse
' Use the selection file from the draft or campaign lookup example for this account.
Dim selection As New Chilkat.JsonObject
success = selection.LoadFile("newsletter-selection.json")
Dim activityId As String = selection.StringOf("campaign_activity_id")
If ((success <> True) Or (activityId = "")) Then
Debug.WriteLine("Select a campaign and save its primary activity ID first.")
Exit Sub
End If
http.SetUrlVar("activity",activityId)
Dim action As String = "schedule"
If (action = "unschedule") Then
success = http.HttpNoBody("DELETE","https://api.cc.email/v3/emails/activities/{$activity}/schedules",resp)
If ((success <> True) And (resp.StatusCode <= 0)) Then
Debug.WriteLine("Remove schedule: HTTP request failed.")
Exit Sub
End If
If ((success <> True) Or (resp.StatusCode <> 204)) Then
Debug.WriteLine("Remove schedule: HTTP " & resp.StatusCode & " " & resp.BodyStr)
Exit Sub
End If
Debug.WriteLine("Schedule removed for activity " & activityId)
Exit Sub
End If
If (action <> "schedule") Then
Debug.WriteLine("Choose schedule or unschedule.")
Exit Sub
End If
' Replace the placeholder with the intended future delivery time, e.g. 2030-05-15T09:00:00-05:00.
Dim deliveryTime As String = "ENTER_FUTURE_TIMESTAMP_WITH_OFFSET"
Dim delivery As New Chilkat.CkDateTime
Dim now As New Chilkat.CkDateTime
now.SetFromCurrentSystemTime()
success = delivery.SetFromTimestamp(deliveryTime)
If ((success <> True) Or (delivery.DiffSeconds(now) <= 0)) Then
Debug.WriteLine("Enter a valid future delivery time with a UTC offset or Z.")
Exit Sub
End If
' Use the full display name. AddParam encodes spaces and punctuation.
Dim listName As String = "Workshop announcements"
Dim query As New Chilkat.HttpRequest
query.HttpVerb = "GET"
query.AddParam("name",listName)
query.AddParam("status","active")
query.AddParam("include_membership_count","active")
success = http.HttpReq("https://api.cc.email/v3/contact_lists",query,resp)
If ((success <> True) And (resp.StatusCode <= 0)) Then
Debug.WriteLine("Look up list: HTTP request failed.")
Exit Sub
End If
If ((success <> True) Or (resp.StatusCode <> 200)) Then
Debug.WriteLine("Look up list: HTTP " & resp.StatusCode & " " & resp.BodyStr)
Exit Sub
End If
Dim matches As New Chilkat.JsonObject
success = matches.Load(resp.BodyStr)
If (success <> True) Then
Debug.WriteLine("Expected a JSON object in the response.")
Exit Sub
End If
If (matches.SizeOfArray("lists") = 0) Then
Debug.WriteLine("No active email list named " & listName)
Exit Sub
End If
If ((matches.SizeOfArray("lists") <> 1) Or (matches.StringOfEquals("lists[0].name",listName,True) <> True)) Then
Debug.WriteLine("Expected one exact list name.")
Exit Sub
End If
Dim listId As String = matches.StringOf("lists[0].list_id")
If (listId = "") Then
Debug.WriteLine("Missing list ID.")
Exit Sub
End If
Debug.WriteLine(listName & " | List ID: " & listId & " | Mailable contacts: " & matches.IntOf("lists[0].membership_count"))
' PUT replaces the activity. Read it first to preserve the subject, sender and other settings.
' Constant Contact retains omitted subresources such as html_content and the physical footer.
success = http.HttpNoBody("GET","https://api.cc.email/v3/emails/activities/{$activity}",resp)
If ((success <> True) And (resp.StatusCode <= 0)) Then
Debug.WriteLine("Read draft: HTTP request failed.")
Exit Sub
End If
If ((success <> True) Or (resp.StatusCode <> 200)) Then
Debug.WriteLine("Read draft: HTTP " & resp.StatusCode & " " & resp.BodyStr)
Exit Sub
End If
Dim draft As New Chilkat.JsonObject
success = draft.Load(resp.BodyStr)
If (success <> True) Then
Debug.WriteLine("Expected a JSON object in the response.")
Exit Sub
End If
If ((draft.StringOfEquals("role","primary_email",True) <> True) Or (draft.StringOfEquals("current_status","DRAFT",True) <> True)) Then
Debug.WriteLine("Select a primary activity in DRAFT status.")
Exit Sub
End If
Debug.WriteLine("LIVE SEND: " & draft.StringOf("subject") & " | Activity: " & activityId & " | List: " & listName & " | Delivery: " & deliveryTime)
draft.UpdateNewArray("contact_list_ids")
draft.UpdateString("contact_list_ids[0]",listId)
draft.UpdateNewArray("segment_ids")
success = http.HttpJson("PUT","https://api.cc.email/v3/emails/activities/{$activity}",draft,"application/json",resp)
If ((success <> True) And (resp.StatusCode <= 0)) Then
Debug.WriteLine("Assign audience: HTTP request failed.")
Exit Sub
End If
If ((success <> True) Or (resp.StatusCode <> 200)) Then
Debug.WriteLine("Assign audience: HTTP " & resp.StatusCode & " " & resp.BodyStr)
Exit Sub
End If
Dim updated As New Chilkat.JsonObject
success = updated.Load(resp.BodyStr)
If (success <> True) Then
Debug.WriteLine("Expected a JSON object in the response.")
Exit Sub
End If
If ((updated.SizeOfArray("contact_list_ids") <> 1) Or (updated.StringOfEquals("contact_list_ids[0]",listId,True) <> True) Or (updated.SizeOfArray("segment_ids") > 0)) Then
Debug.WriteLine("The saved audience did not match the requested list. Scheduling stopped.")
Exit Sub
End If
Dim schedule As New Chilkat.JsonObject
schedule.UpdateString("scheduled_date",delivery.GetAsTimestamp(False))
success = http.HttpJson("POST","https://api.cc.email/v3/emails/activities/{$activity}/schedules",schedule,"application/json",resp)
If ((success <> True) Or (resp.StatusCode < 200) Or (resp.StatusCode >= 300)) Then
Debug.WriteLine("Schedule not confirmed. HTTP " & resp.StatusCode)
Debug.WriteLine("The audience was saved. Check the schedule before retrying.")
Exit Sub
End If
Debug.WriteLine("Live delivery scheduled for " & schedule.StringOf("scheduled_date") & " to " & listName)