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 Xbase++ Downloads
LOCAL nSuccess
LOCAL oVault
LOCAL oEntry
LOCAL oTokens
LOCAL nLoaded
LOCAL oHttp
LOCAL oResp
LOCAL oSelection
LOCAL cActivityId
LOCAL cAction
LOCAL cDeliveryTime
LOCAL oDelivery
LOCAL oNow
LOCAL cListName
LOCAL oQuery
LOCAL oMatches
LOCAL cListId
LOCAL oDraft
LOCAL oUpdated
LOCAL oSchedule
nSuccess := 0
// LIVE SEND: Scheduling this activity delivers email to the selected contact list.
// Assumes Chilkat is unlocked. See Global Unlock Sample.
oVault := CreateObject("Chilkat.Secrets")
oVault:Location := "local_manager"
oVault:AutoSplit := 1
oEntry := CreateObject("Chilkat.JsonObject")
oEntry:UpdateString("appName", "ConstantContactV3")
oEntry:UpdateString("service", "OAuth2")
oEntry:UpdateString("username", "my-account")
oTokens := CreateObject("Chilkat.JsonObject")
nLoaded := oVault:GetSecretJson(oEntry, oTokens)
IF (nLoaded != 1)
? "Run the desktop authorization example using this account and store."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
RETURN
ENDIF
IF (oTokens:JsonTypeOf("access_token") != 1)
? "The saved authorization has no access token."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
RETURN
ENDIF
oHttp := CreateObject("Chilkat.Http")
oHttp:RequireSslCertVerify := 1
oHttp:AuthToken := oTokens:StringOf("access_token")
oResp := CreateObject("Chilkat.HttpResponse")
// Use the selection file from the draft or campaign lookup example for this account.
oSelection := CreateObject("Chilkat.JsonObject")
nSuccess := oSelection:LoadFile("newsletter-selection.json")
cActivityId := oSelection:StringOf("campaign_activity_id")
IF ((nSuccess != 1) .OR. (cActivityId == ""))
? "Select a campaign and save its primary activity ID first."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
RETURN
ENDIF
oHttp:SetUrlVar("activity", cActivityId)
cAction := "schedule"
IF (cAction == "unschedule")
nSuccess := oHttp:HttpNoBody("DELETE", "https://api.cc.email/v3/emails/activities/{$activity}/schedules", oResp)
IF ((nSuccess != 1) .AND. (oResp:StatusCode <= 0))
? "Remove schedule: HTTP request failed."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
RETURN
ENDIF
IF ((nSuccess != 1) .OR. (oResp:StatusCode != 204))
? "Remove schedule: HTTP " + Str(oResp:StatusCode) + " " + oResp:BodyStr
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
RETURN
ENDIF
? "Schedule removed for activity " + cActivityId
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
RETURN
ENDIF
IF (cAction != "schedule")
? "Choose schedule or unschedule."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
RETURN
ENDIF
// Replace the placeholder with the intended future delivery time, e.g. 2030-05-15T09:00:00-05:00.
cDeliveryTime := "ENTER_FUTURE_TIMESTAMP_WITH_OFFSET"
oDelivery := CreateObject("Chilkat.CkDateTime")
oNow := CreateObject("Chilkat.CkDateTime")
oNow:SetFromCurrentSystemTime()
nSuccess := oDelivery:SetFromTimestamp(cDeliveryTime)
IF ((nSuccess != 1) .OR. (oDelivery:DiffSeconds(oNow) <= 0))
? "Enter a valid future delivery time with a UTC offset or Z."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
RETURN
ENDIF
// Use the full display name. AddParam encodes spaces and punctuation.
cListName := "Workshop announcements"
oQuery := CreateObject("Chilkat.HttpRequest")
oQuery:HttpVerb := "GET"
oQuery:AddParam("name", cListName)
oQuery:AddParam("status", "active")
oQuery:AddParam("include_membership_count", "active")
nSuccess := oHttp:HttpReq("https://api.cc.email/v3/contact_lists", oQuery, oResp)
IF ((nSuccess != 1) .AND. (oResp:StatusCode <= 0))
? "Look up list: HTTP request failed."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
RETURN
ENDIF
IF ((nSuccess != 1) .OR. (oResp:StatusCode != 200))
? "Look up list: HTTP " + Str(oResp:StatusCode) + " " + oResp:BodyStr
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
RETURN
ENDIF
oMatches := CreateObject("Chilkat.JsonObject")
nSuccess := oMatches:Load(oResp:BodyStr)
IF (nSuccess != 1)
? "Expected a JSON object in the response."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
RETURN
ENDIF
IF (oMatches:SizeOfArray("lists") == 0)
? "No active email list named " + cListName
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
RETURN
ENDIF
IF ((oMatches:SizeOfArray("lists") != 1) .OR. (oMatches:StringOfEquals("lists[0].name", cListName, 1) != 1))
? "Expected one exact list name."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
RETURN
ENDIF
cListId := oMatches:StringOf("lists[0].list_id")
IF (cListId == "")
? "Missing list ID."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
RETURN
ENDIF
? cListName + " | List ID: " + cListId + " | Mailable contacts: " + Str(oMatches: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.
nSuccess := oHttp:HttpNoBody("GET", "https://api.cc.email/v3/emails/activities/{$activity}", oResp)
IF ((nSuccess != 1) .AND. (oResp:StatusCode <= 0))
? "Read draft: HTTP request failed."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
RETURN
ENDIF
IF ((nSuccess != 1) .OR. (oResp:StatusCode != 200))
? "Read draft: HTTP " + Str(oResp:StatusCode) + " " + oResp:BodyStr
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
RETURN
ENDIF
oDraft := CreateObject("Chilkat.JsonObject")
nSuccess := oDraft:Load(oResp:BodyStr)
IF (nSuccess != 1)
? "Expected a JSON object in the response."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
RETURN
ENDIF
IF ((oDraft:StringOfEquals("role", "primary_email", 1) != 1) .OR. (oDraft:StringOfEquals("current_status", "DRAFT", 1) != 1))
? "Select a primary activity in DRAFT status."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
RETURN
ENDIF
? "LIVE SEND: " + oDraft:StringOf("subject") + " | Activity: " + cActivityId + " | List: " + cListName + " | Delivery: " + cDeliveryTime
oDraft:UpdateNewArray("contact_list_ids")
oDraft:UpdateString("contact_list_ids[0]", cListId)
oDraft:UpdateNewArray("segment_ids")
nSuccess := oHttp:HttpJson("PUT", "https://api.cc.email/v3/emails/activities/{$activity}", oDraft, "application/json", oResp)
IF ((nSuccess != 1) .AND. (oResp:StatusCode <= 0))
? "Assign audience: HTTP request failed."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
RETURN
ENDIF
IF ((nSuccess != 1) .OR. (oResp:StatusCode != 200))
? "Assign audience: HTTP " + Str(oResp:StatusCode) + " " + oResp:BodyStr
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
RETURN
ENDIF
oUpdated := CreateObject("Chilkat.JsonObject")
nSuccess := oUpdated:Load(oResp:BodyStr)
IF (nSuccess != 1)
? "Expected a JSON object in the response."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
oUpdated:destroy()
RETURN
ENDIF
IF ((oUpdated:SizeOfArray("contact_list_ids") != 1) .OR. (oUpdated:StringOfEquals("contact_list_ids[0]", cListId, 1) != 1) .OR. (oUpdated:SizeOfArray("segment_ids") > 0))
? "The saved audience did not match the requested list. Scheduling stopped."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
oUpdated:destroy()
RETURN
ENDIF
oSchedule := CreateObject("Chilkat.JsonObject")
oSchedule:UpdateString("scheduled_date", oDelivery:GetAsTimestamp(0))
nSuccess := oHttp:HttpJson("POST", "https://api.cc.email/v3/emails/activities/{$activity}/schedules", oSchedule, "application/json", oResp)
IF ((nSuccess != 1) .OR. (oResp:StatusCode < 200) .OR. (oResp:StatusCode >= 300))
? "Schedule not confirmed. HTTP " + Str(oResp:StatusCode)
? "The audience was saved. Check the schedule before retrying."
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
oUpdated:destroy()
oSchedule:destroy()
RETURN
ENDIF
? "Live delivery scheduled for " + oSchedule:StringOf("scheduled_date") + " to " + cListName
oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oSelection:destroy()
oDelivery:destroy()
oNow:destroy()
oQuery:destroy()
oMatches:destroy()
oDraft:destroy()
oUpdated:destroy()
oSchedule:destroy()