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

Xbase++
LOCAL nSuccess
LOCAL oVault
LOCAL oEntry
LOCAL oTokens
LOCAL nLoaded
LOCAL oHttp
LOCAL oResp
LOCAL cListName
LOCAL oQuery
LOCAL oMatches
LOCAL cListId

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

//  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()
    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()
    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()
    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()
    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()
    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()
    oQuery:destroy()
    oMatches:destroy()
    RETURN
ENDIF

? cListName + " | List ID: " + cListId + " | Mailable contacts: " + Str(oMatches:IntOf("lists[0].membership_count"))

oVault:destroy()
oEntry:destroy()
oTokens:destroy()
oHttp:destroy()
oResp:destroy()
oQuery:destroy()
oMatches:destroy()