Sample code for 30+ languages & platforms
Xbase++ 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 Xbase++ Downloads

Xbase++
LOCAL nSuccess
LOCAL oVault
LOCAL oEntry
LOCAL oTokens
LOCAL nLoaded
LOCAL oHttp
LOCAL oResp
LOCAL cCampaignName
LOCAL cCampaignId
LOCAL oUrl
LOCAL oPage
LOCAL nCount
LOCAL i
LOCAL oCampaign
LOCAL oPrimary
LOCAL cSelectedCampaign
LOCAL cSelectedActivity
LOCAL oSelection

nSuccess := 0

//  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")

cCampaignName := "Workshop newsletter"
cCampaignId := ""
oUrl := CreateObject("Chilkat.StringBuilder")
oUrl:Append("https://api.cc.email/v3/emails?limit=50")
oPage := CreateObject("Chilkat.JsonObject")
DO WHILE ((oUrl:Length > 0) .AND. (cCampaignId == ""))
    nSuccess := oHttp:HttpNoBody("GET", oUrl:GetAsString(), oResp)
    IF ((nSuccess != 1) .AND. (oResp:StatusCode <= 0))
        ? "Read campaigns: HTTP request failed."
        oVault:destroy()
        oEntry:destroy()
        oTokens:destroy()
        oHttp:destroy()
        oResp:destroy()
        oUrl:destroy()
        oPage:destroy()
        RETURN
    ENDIF

    IF ((nSuccess != 1) .OR. (oResp:StatusCode != 200))
        ? "Read campaigns: HTTP " + Str(oResp:StatusCode) + " " + oResp:BodyStr
        oVault:destroy()
        oEntry:destroy()
        oTokens:destroy()
        oHttp:destroy()
        oResp:destroy()
        oUrl:destroy()
        oPage:destroy()
        RETURN
    ENDIF

    nSuccess := oPage:Load(oResp:BodyStr)
    nCount := oPage:SizeOfArray("campaigns")
    IF ((nSuccess != 1) .OR. (nCount < 0))
        ? "Expected a page of campaigns."
        oVault:destroy()
        oEntry:destroy()
        oTokens:destroy()
        oHttp:destroy()
        oResp:destroy()
        oUrl:destroy()
        oPage:destroy()
        RETURN
    ENDIF

    i := 0
    DO WHILE ((i < nCount) .AND. (cCampaignId == ""))
        oPage:I := i
        IF (oPage:StringOfEquals("campaigns[i].name", cCampaignName, 1) == 1)
            cCampaignId := oPage:StringOf("campaigns[i].campaign_id")
        ENDIF

        i := i + 1
    ENDDO
    oUrl:Clear()
    IF ((cCampaignId == "") .AND. (oPage:JsonTypeOf("_links.next.href") == 1))
        oUrl:Append(oPage:StringOf("_links.next.href"))
        IF (oUrl:StartsWith("/v3/emails?", 1) != 1)
            ? "Unexpected campaign pagination link."
            oVault:destroy()
            oEntry:destroy()
            oTokens:destroy()
            oHttp:destroy()
            oResp:destroy()
            oUrl:destroy()
            oPage:destroy()
            RETURN
        ENDIF

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

ENDDO
IF (cCampaignId == "")
    ? "No campaign named " + cCampaignName
    oVault:destroy()
    oEntry:destroy()
    oTokens:destroy()
    oHttp:destroy()
    oResp:destroy()
    oUrl:destroy()
    oPage:destroy()
    RETURN
ENDIF

oHttp:SetUrlVar("campaign", cCampaignId)
nSuccess := oHttp:HttpNoBody("GET", "https://api.cc.email/v3/emails/{$campaign}", oResp)
IF ((nSuccess != 1) .AND. (oResp:StatusCode <= 0))
    ? "Read campaign: HTTP request failed."
    oVault:destroy()
    oEntry:destroy()
    oTokens:destroy()
    oHttp:destroy()
    oResp:destroy()
    oUrl:destroy()
    oPage:destroy()
    RETURN
ENDIF

IF ((nSuccess != 1) .OR. (oResp:StatusCode != 200))
    ? "Read campaign: HTTP " + Str(oResp:StatusCode) + " " + oResp:BodyStr
    oVault:destroy()
    oEntry:destroy()
    oTokens:destroy()
    oHttp:destroy()
    oResp:destroy()
    oUrl:destroy()
    oPage:destroy()
    RETURN
ENDIF

oCampaign := CreateObject("Chilkat.JsonObject")
nSuccess := oCampaign:Load(oResp:BodyStr)
IF (nSuccess != 1)
    ? "Expected a JSON object in the response."
    oVault:destroy()
    oEntry:destroy()
    oTokens:destroy()
    oHttp:destroy()
    oResp:destroy()
    oUrl:destroy()
    oPage:destroy()
    oCampaign:destroy()
    RETURN
ENDIF

//  The campaign identifies the newsletter. The primary activity identifies the email to test or schedule.
oPrimary := CreateObject("Chilkat.JsonObject")
nSuccess := oCampaign:FindRecord2("campaign_activities", "role", "primary_email", 1, oPrimary)
IF ((nSuccess != 1) .OR. (oPrimary:JsonTypeOf("campaign_activity_id") != 1))
    ? "No primary email activity ID in the response."
    oVault:destroy()
    oEntry:destroy()
    oTokens:destroy()
    oHttp:destroy()
    oResp:destroy()
    oUrl:destroy()
    oPage:destroy()
    oCampaign:destroy()
    oPrimary:destroy()
    RETURN
ENDIF

cSelectedCampaign := oCampaign:StringOf("campaign_id")
cSelectedActivity := oPrimary:StringOf("campaign_activity_id")
IF ((cSelectedCampaign == "") .OR. (cSelectedActivity == ""))
    ? "Missing campaign or activity ID."
    oVault:destroy()
    oEntry:destroy()
    oTokens:destroy()
    oHttp:destroy()
    oResp:destroy()
    oUrl:destroy()
    oPage:destroy()
    oCampaign:destroy()
    oPrimary:destroy()
    RETURN
ENDIF

? "Campaign ID: " + cSelectedCampaign
? "Primary activity ID: " + cSelectedActivity
oSelection := CreateObject("Chilkat.JsonObject")
oSelection:UpdateString("name", oCampaign:StringOf("name"))
oSelection:UpdateString("campaign_id", cSelectedCampaign)
oSelection:UpdateString("campaign_activity_id", cSelectedActivity)
nSuccess := oSelection:WriteFile("newsletter-selection.json")
IF (nSuccess != 1)
    ? "Could not save newsletter-selection.json. Keep the IDs printed above."
    oVault:destroy()
    oEntry:destroy()
    oTokens:destroy()
    oHttp:destroy()
    oResp:destroy()
    oUrl:destroy()
    oPage:destroy()
    oCampaign:destroy()
    oPrimary:destroy()
    oSelection:destroy()
    RETURN
ENDIF

? "Saved newsletter-selection.json."

oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oUrl:destroy()
oPage:destroy()
oCampaign:destroy()
oPrimary:destroy()
oSelection:destroy()