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

Constant Contact V3: Find a contact list by name

See more Constant Contact Examples

Start with the full list name from the Constant Contact account. Read its list_id and the number of active, mailable contacts. Use the ID for list membership operations or campaign targeting. This lookup requires contact_data.

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 lcListName
LOCAL loQuery
LOCAL loMatches
LOCAL lcListId

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')

*  Use the full display name. AddParam encodes spaces and punctuation.
lcListName = "Workshop announcements"
loQuery = CreateObject('Chilkat.HttpRequest')
loQuery.HttpVerb = "GET"
loQuery.AddParam("name",lcListName)
loQuery.AddParam("status","active")
loQuery.AddParam("include_membership_count","active")
lnSuccess = loHttp.HttpReq("https://api.cc.email/v3/contact_lists",loQuery,loResp)
IF ((lnSuccess <> 1) AND (loResp.StatusCode <= 0)) THEN
    ? "Look up list: HTTP request failed."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loQuery
    CANCEL
ENDIF

IF ((lnSuccess <> 1) OR (loResp.StatusCode <> 200)) THEN
    ? "Look up list: HTTP " + STR(loResp.StatusCode) + " " + loResp.BodyStr
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loQuery
    CANCEL
ENDIF

loMatches = CreateObject('Chilkat.JsonObject')
lnSuccess = loMatches.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 loQuery
    RELEASE loMatches
    CANCEL
ENDIF

IF (loMatches.SizeOfArray("lists") = 0) THEN
    ? "No active email list named " + lcListName
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loQuery
    RELEASE loMatches
    CANCEL
ENDIF

IF ((loMatches.SizeOfArray("lists") <> 1) OR (loMatches.StringOfEquals("lists[0].name",lcListName,1) <> 1)) THEN
    ? "Expected one exact list name."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loQuery
    RELEASE loMatches
    CANCEL
ENDIF

lcListId = loMatches.StringOf("lists[0].list_id")
IF (lcListId = "") THEN
    ? "Missing list ID."
    RELEASE loVault
    RELEASE loEntry
    RELEASE loTokens
    RELEASE loHttp
    RELEASE loResp
    RELEASE loQuery
    RELEASE loMatches
    CANCEL
ENDIF

? lcListName + " | List ID: " + lcListId + " | Mailable contacts: " + STR(loMatches.IntOf("lists[0].membership_count"))

RELEASE loVault
RELEASE loEntry
RELEASE loTokens
RELEASE loHttp
RELEASE loResp
RELEASE loQuery
RELEASE loMatches