Sample code for 30+ languages & platforms
Visual FoxPro Requires Chilkat v11.0.0+

Constant Contact V3: Find a campaign and its primary email activity

See more Constant Contact Examples

Enter the unique campaign name from the account. Follow the campaign collection’s cursor until the name matches, then fetch that campaign’s details. Select the activity whose role is primary_email. A permalink or resend can appear first.

The example writes the two IDs to newsletter-selection.json, the same file produced by the draft example. Run this lookup when selecting an existing newsletter for review or scheduling.

Authorize the application using the same account and credential store.

Constant Contact developer guide

Chilkat Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loVault
LOCAL loEntry
LOCAL loTokens
LOCAL lnLoaded
LOCAL loHttp
LOCAL loResp
LOCAL lcCampaignName
LOCAL lcCampaignId
LOCAL loUrl
LOCAL loPage
LOCAL lnCount
LOCAL i
LOCAL loCampaign
LOCAL loPrimary
LOCAL lcSelectedCampaign
LOCAL lcSelectedActivity
LOCAL loSelection

lnSuccess = 0

*  Assumes Chilkat is unlocked. See Global Unlock Sample.
loVault = CreateObject('Chilkat.Secrets')
loVault.Location = "local_manager"
loVault.AutoSplit = 1
loEntry = CreateObject('Chilkat.JsonObject')
loEntry.UpdateString("appName","ConstantContactV3")
loEntry.UpdateString("service","OAuth2")
loEntry.UpdateString("username","my-account")
loTokens = CreateObject('Chilkat.JsonObject')
lnLoaded = loVault.GetSecretJson(loEntry,loTokens)
IF (lnLoaded <> 1) THEN
    ? "Run the desktop authorization example using this account and store."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    CANCEL
ENDIF

IF (loTokens.JsonTypeOf("access_token") <> 1) THEN
    ? "The saved authorization has no access token."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    CANCEL
ENDIF

loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.AuthToken = loTokens.StringOf("access_token")
loResp = CreateObject('Chilkat.HttpResponse')

lcCampaignName = "Workshop newsletter"
lcCampaignId = ""
loUrl = CreateObject('Chilkat.StringBuilder')
loUrl.Append("https://api.cc.email/v3/emails?limit=50")
loPage = CreateObject('Chilkat.JsonObject')
DO WHILE ((loUrl.Length > 0) AND (lcCampaignId = ""))
    lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
    IF ((lnSuccess <> 1) AND (loResp.StatusCode <= 0)) THEN
        ? "Read campaigns: HTTP request failed."
        RELEASE loVault
        RELEASE loEntry
        RELEASE loTokens
        RELEASE loHttp
        RELEASE loResp
        RELEASE loUrl
        RELEASE loPage
        CANCEL
    ENDIF

    IF ((lnSuccess <> 1) OR (loResp.StatusCode <> 200)) THEN
        ? "Read campaigns: HTTP " + STR(loResp.StatusCode) + " " + loResp.BodyStr
        RELEASE loVault
        RELEASE loEntry
        RELEASE loTokens
        RELEASE loHttp
        RELEASE loResp
        RELEASE loUrl
        RELEASE loPage
        CANCEL
    ENDIF

    lnSuccess = loPage.Load(loResp.BodyStr)
    lnCount = loPage.SizeOfArray("campaigns")
    IF ((lnSuccess <> 1) OR (lnCount < 0)) THEN
        ? "Expected a page of campaigns."
        RELEASE loVault
        RELEASE loEntry
        RELEASE loTokens
        RELEASE loHttp
        RELEASE loResp
        RELEASE loUrl
        RELEASE loPage
        CANCEL
    ENDIF

    i = 0
    DO WHILE ((i < lnCount) AND (lcCampaignId = ""))
        loPage.I = i
        IF (loPage.StringOfEquals("campaigns[i].name",lcCampaignName,1) = 1) THEN
            lcCampaignId = loPage.StringOf("campaigns[i].campaign_id")
        ENDIF

        i = i + 1
    ENDDO
    loUrl.Clear()
    IF ((lcCampaignId = "") AND (loPage.JsonTypeOf("_links.next.href") = 1)) THEN
        loUrl.Append(loPage.StringOf("_links.next.href"))
        IF (loUrl.StartsWith("/v3/emails?",1) <> 1) THEN
            ? "Unexpected campaign pagination link."
            RELEASE loVault
            RELEASE loEntry
            RELEASE loTokens
            RELEASE loHttp
            RELEASE loResp
            RELEASE loUrl
            RELEASE loPage
            CANCEL
        ENDIF

        loUrl.Prepend("https://api.cc.email")
    ENDIF

ENDDO
IF (lcCampaignId = "") THEN
    ? "No campaign named " + lcCampaignName
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loUrl
    RELEASE loPage
    CANCEL
ENDIF

loHttp.SetUrlVar("campaign",lcCampaignId)
lnSuccess = loHttp.HttpNoBody("GET","https://api.cc.email/v3/emails/{$campaign}",loResp)
IF ((lnSuccess <> 1) AND (loResp.StatusCode <= 0)) THEN
    ? "Read campaign: HTTP request failed."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loUrl
    RELEASE loPage
    CANCEL
ENDIF

IF ((lnSuccess <> 1) OR (loResp.StatusCode <> 200)) THEN
    ? "Read campaign: HTTP " + STR(loResp.StatusCode) + " " + loResp.BodyStr
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loUrl
    RELEASE loPage
    CANCEL
ENDIF

loCampaign = CreateObject('Chilkat.JsonObject')
lnSuccess = loCampaign.Load(loResp.BodyStr)
IF (lnSuccess <> 1) THEN
    ? "Expected a JSON object in the response."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loUrl
    RELEASE loPage
    RELEASE loCampaign
    CANCEL
ENDIF

*  The campaign identifies the newsletter. The primary activity identifies the email to test or schedule.
loPrimary = CreateObject('Chilkat.JsonObject')
lnSuccess = loCampaign.FindRecord2("campaign_activities","role","primary_email",1,loPrimary)
IF ((lnSuccess <> 1) OR (loPrimary.JsonTypeOf("campaign_activity_id") <> 1)) THEN
    ? "No primary email activity ID in the response."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loUrl
    RELEASE loPage
    RELEASE loCampaign
    RELEASE loPrimary
    CANCEL
ENDIF

lcSelectedCampaign = loCampaign.StringOf("campaign_id")
lcSelectedActivity = loPrimary.StringOf("campaign_activity_id")
IF ((lcSelectedCampaign = "") OR (lcSelectedActivity = "")) THEN
    ? "Missing campaign or activity ID."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loUrl
    RELEASE loPage
    RELEASE loCampaign
    RELEASE loPrimary
    CANCEL
ENDIF

? "Campaign ID: " + lcSelectedCampaign
? "Primary activity ID: " + lcSelectedActivity
loSelection = CreateObject('Chilkat.JsonObject')
loSelection.UpdateString("name",loCampaign.StringOf("name"))
loSelection.UpdateString("campaign_id",lcSelectedCampaign)
loSelection.UpdateString("campaign_activity_id",lcSelectedActivity)
lnSuccess = loSelection.WriteFile("newsletter-selection.json")
IF (lnSuccess <> 1) THEN
    ? "Could not save newsletter-selection.json. Keep the IDs printed above."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loUrl
    RELEASE loPage
    RELEASE loCampaign
    RELEASE loPrimary
    RELEASE loSelection
    CANCEL
ENDIF

? "Saved newsletter-selection.json."

RELEASE loVault
RELEASE loEntry
RELEASE loTokens
RELEASE loHttp
RELEASE loResp
RELEASE loUrl
RELEASE loPage
RELEASE loCampaign
RELEASE loPrimary
RELEASE loSelection