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

DataFlex
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
    String sListName
    Variant vQuery
    Handle hoQuery
    Handle hoMatches
    String sListId
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    Move False To iSuccess

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


End_Procedure