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 DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoVault
Variant vEntry
Handle hoEntry
Variant vTokens
Handle hoTokens
Boolean iLoaded
Handle hoHttp
Variant vResp
Handle hoResp
Handle hoSelection
String sActivityId
String sAction
String sDeliveryTime
Handle hoDelivery
Variant vNow
Handle hoNow
String sListName
Variant vQuery
Handle hoQuery
Handle hoMatches
String sListId
Variant vDraft
Handle hoDraft
Handle hoUpdated
Variant vSchedule
Handle hoSchedule
String sTemp1
Integer iTemp1
Integer iTemp2
Boolean bTemp1
Boolean bTemp2
Move False To iSuccess
// LIVE SEND: Scheduling this activity delivers email to the selected contact list.
// Assumes Chilkat is unlocked. See Global Unlock Sample.
Get Create (RefClass(cComChilkatSecrets)) To hoVault
If (Not(IsComObjectCreated(hoVault))) Begin
Send CreateComObject of hoVault
End
Set ComLocation Of hoVault To "local_manager"
Set ComAutoSplit Of hoVault To True
Get Create (RefClass(cComChilkatJsonObject)) To hoEntry
If (Not(IsComObjectCreated(hoEntry))) Begin
Send CreateComObject of hoEntry
End
Get ComUpdateString Of hoEntry "appName" "ConstantContactV3" To iSuccess
Get ComUpdateString Of hoEntry "service" "OAuth2" To iSuccess
Get ComUpdateString Of hoEntry "username" "my-account" To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoTokens
If (Not(IsComObjectCreated(hoTokens))) Begin
Send CreateComObject of hoTokens
End
Get pvComObject of hoEntry to vEntry
Get pvComObject of hoTokens to vTokens
Get ComGetSecretJson Of hoVault vEntry vTokens To iLoaded
If (iLoaded <> True) Begin
Showln "Run the desktop authorization example using this account and store."
Procedure_Return
End
Get ComJsonTypeOf Of hoTokens "access_token" To iTemp1
If (iTemp1 <> 1) Begin
Showln "The saved authorization has no access token."
Procedure_Return
End
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComRequireSslCertVerify Of hoHttp To True
Get ComStringOf Of hoTokens "access_token" To sTemp1
Set ComAuthToken Of hoHttp To sTemp1
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
// Use the selection file from the draft or campaign lookup example for this account.
Get Create (RefClass(cComChilkatJsonObject)) To hoSelection
If (Not(IsComObjectCreated(hoSelection))) Begin
Send CreateComObject of hoSelection
End
Get ComLoadFile Of hoSelection "newsletter-selection.json" To iSuccess
Get ComStringOf Of hoSelection "campaign_activity_id" To sActivityId
If ((iSuccess <> True) Or (sActivityId = "")) Begin
Showln "Select a campaign and save its primary activity ID first."
Procedure_Return
End
Get ComSetUrlVar Of hoHttp "activity" sActivityId To iSuccess
Move "schedule" To sAction
If (sAction = "unschedule") Begin
Get pvComObject of hoResp to vResp
Get ComHttpNoBody Of hoHttp "DELETE" "https://api.cc.email/v3/emails/activities/{$activity}/schedules" vResp To iSuccess
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) And (iTemp1 <= 0)) Begin
Showln "Remove schedule: HTTP request failed."
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) Or (iTemp1 <> 204)) Begin
Get ComStatusCode Of hoResp To iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln "Remove schedule: HTTP " iTemp1 " " sTemp1
Procedure_Return
End
Showln "Schedule removed for activity " sActivityId
Procedure_Return
End
If (sAction <> "schedule") Begin
Showln "Choose schedule or unschedule."
Procedure_Return
End
// Replace the placeholder with the intended future delivery time, e.g. 2030-05-15T09:00:00-05:00.
Move "ENTER_FUTURE_TIMESTAMP_WITH_OFFSET" To sDeliveryTime
Get Create (RefClass(cComCkDateTime)) To hoDelivery
If (Not(IsComObjectCreated(hoDelivery))) Begin
Send CreateComObject of hoDelivery
End
Get Create (RefClass(cComCkDateTime)) To hoNow
If (Not(IsComObjectCreated(hoNow))) Begin
Send CreateComObject of hoNow
End
Get ComSetFromCurrentSystemTime Of hoNow To iSuccess
Get ComSetFromTimestamp Of hoDelivery sDeliveryTime To iSuccess
Get ComDiffSeconds Of hoDelivery Get pvComObject of hoNow to vNow
vNow To iTemp1
If ((iSuccess <> True) Or (iTemp1 <= 0)) Begin
Showln "Enter a valid future delivery time with a UTC offset or Z."
Procedure_Return
End
// Use the full display name. AddParam encodes spaces and punctuation.
Move "Workshop announcements" To sListName
Get Create (RefClass(cComChilkatHttpRequest)) To hoQuery
If (Not(IsComObjectCreated(hoQuery))) Begin
Send CreateComObject of hoQuery
End
Set ComHttpVerb Of hoQuery To "GET"
Send ComAddParam To hoQuery "name" sListName
Send ComAddParam To hoQuery "status" "active"
Send ComAddParam To hoQuery "include_membership_count" "active"
Get pvComObject of hoQuery to vQuery
Get pvComObject of hoResp to vResp
Get ComHttpReq Of hoHttp "https://api.cc.email/v3/contact_lists" vQuery vResp To iSuccess
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) And (iTemp1 <= 0)) Begin
Showln "Look up list: HTTP request failed."
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) Or (iTemp1 <> 200)) Begin
Get ComStatusCode Of hoResp To iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln "Look up list: HTTP " iTemp1 " " sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoMatches
If (Not(IsComObjectCreated(hoMatches))) Begin
Send CreateComObject of hoMatches
End
Get ComBodyStr Of hoResp To sTemp1
Get ComLoad Of hoMatches sTemp1 To iSuccess
If (iSuccess <> True) Begin
Showln "Expected a JSON object in the response."
Procedure_Return
End
Get ComSizeOfArray Of hoMatches "lists" To iTemp1
If (iTemp1 = 0) Begin
Showln "No active email list named " sListName
Procedure_Return
End
Get ComSizeOfArray Of hoMatches "lists" To iTemp1
Get ComStringOfEquals Of hoMatches "lists[0].name" sListName True To bTemp1
If ((iTemp1 <> 1) Or (bTemp1 <> True)) Begin
Showln "Expected one exact list name."
Procedure_Return
End
Get ComStringOf Of hoMatches "lists[0].list_id" To sListId
If (sListId = "") Begin
Showln "Missing list ID."
Procedure_Return
End
Get ComIntOf Of hoMatches "lists[0].membership_count" To iTemp1
Showln sListName " | List ID: " sListId " | Mailable contacts: " iTemp1
// 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.
Get pvComObject of hoResp to vResp
Get ComHttpNoBody Of hoHttp "GET" "https://api.cc.email/v3/emails/activities/{$activity}" vResp To iSuccess
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) And (iTemp1 <= 0)) Begin
Showln "Read draft: HTTP request failed."
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) Or (iTemp1 <> 200)) Begin
Get ComStatusCode Of hoResp To iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln "Read draft: HTTP " iTemp1 " " sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoDraft
If (Not(IsComObjectCreated(hoDraft))) Begin
Send CreateComObject of hoDraft
End
Get ComBodyStr Of hoResp To sTemp1
Get ComLoad Of hoDraft sTemp1 To iSuccess
If (iSuccess <> True) Begin
Showln "Expected a JSON object in the response."
Procedure_Return
End
Get ComStringOfEquals Of hoDraft "role" "primary_email" True To bTemp1
Get ComStringOfEquals Of hoDraft "current_status" "DRAFT" True To bTemp2
If ((bTemp1 <> True) Or (bTemp2 <> True)) Begin
Showln "Select a primary activity in DRAFT status."
Procedure_Return
End
Get ComStringOf Of hoDraft "subject" To sTemp1
Showln "LIVE SEND: " sTemp1 " | Activity: " sActivityId " | List: " sListName " | Delivery: " sDeliveryTime
Get ComUpdateNewArray Of hoDraft "contact_list_ids" To iSuccess
Get ComUpdateString Of hoDraft "contact_list_ids[0]" sListId To iSuccess
Get ComUpdateNewArray Of hoDraft "segment_ids" To iSuccess
Get pvComObject of hoDraft to vDraft
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "PUT" "https://api.cc.email/v3/emails/activities/{$activity}" vDraft "application/json" vResp To iSuccess
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) And (iTemp1 <= 0)) Begin
Showln "Assign audience: HTTP request failed."
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
If ((iSuccess <> True) Or (iTemp1 <> 200)) Begin
Get ComStatusCode Of hoResp To iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln "Assign audience: HTTP " iTemp1 " " sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoUpdated
If (Not(IsComObjectCreated(hoUpdated))) Begin
Send CreateComObject of hoUpdated
End
Get ComBodyStr Of hoResp To sTemp1
Get ComLoad Of hoUpdated sTemp1 To iSuccess
If (iSuccess <> True) Begin
Showln "Expected a JSON object in the response."
Procedure_Return
End
Get ComSizeOfArray Of hoUpdated "contact_list_ids" To iTemp1
Get ComStringOfEquals Of hoUpdated "contact_list_ids[0]" sListId True To bTemp1
Get ComSizeOfArray Of hoUpdated "segment_ids" To iTemp2
If ((iTemp1 <> 1) Or (bTemp1 <> True) Or (iTemp2 > 0)) Begin
Showln "The saved audience did not match the requested list. Scheduling stopped."
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoSchedule
If (Not(IsComObjectCreated(hoSchedule))) Begin
Send CreateComObject of hoSchedule
End
Get ComGetAsTimestamp Of hoDelivery False To sTemp1
Get ComUpdateString Of hoSchedule "scheduled_date" sTemp1 To iSuccess
Get pvComObject of hoSchedule to vSchedule
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "POST" "https://api.cc.email/v3/emails/activities/{$activity}/schedules" vSchedule "application/json" vResp To iSuccess
Get ComStatusCode Of hoResp To iTemp1
Get ComStatusCode Of hoResp To iTemp2
If ((iSuccess <> True) Or (iTemp1 < 200) Or (iTemp2 >= 300)) Begin
Get ComStatusCode Of hoResp To iTemp1
Showln "Schedule not confirmed. HTTP " iTemp1
Showln "The audience was saved. Check the schedule before retrying."
Procedure_Return
End
Get ComStringOf Of hoSchedule "scheduled_date" To sTemp1
Showln "Live delivery scheduled for " sTemp1 " to " sListName
End_Procedure