Account Lists Overview

When you curate Account Lists in our application according to various criteria, there is value in sharing specific details from those Account Lists to your integrations, marketing automation providers, print fulfillment services, data warehouses, CRM systems, and other systems.

The Account List APIs allow you to manage Account Lists, Account List Folders, and Accounts on Account Lists. These endpoints allow for programmatic interactions with Account Lists, such as synchronizing Account List membership with external applications like marketing automation tools.

Example Scenario

A marketer creates a folder to store associated Account Lists in.

curl --location --request POST 'https://api.terminusplatform.com/accountLists/v2/folders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY_GOES_HERE' \
--data-raw '{
    "folderName": "North East Prospects",
    "folderAccess": "PUBLIC"
}'

Once the folder is created, the marketer can create an Account List.

curl --location --request POST 'https://api.terminusplatform.com/accountLists/v2/accountLists' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY_GOES_HERE' \
--data-raw '{
    "listName": "Paper Companies",
    "folderId": "FOLDER_ID_RETURNED_FROM_ABOVE"
}'

Now that the marketer has an Account List created, they can start adding accounts to it.

curl --location --request POST 'https://api.terminusplatform.com/accountLists/v2/accountLists/ID_RETURNED_FROM_ABOVE/accounts/add' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY_GOES_HERE' \
--data-raw '{
    "accounts": [
        {
            "id": "001894851uUa9vQAC",
            "name": "Dunder Mifflin",
            "crmOrgId": "DFS76NCHFUEI",
            "crmType": "SALESFORCE"
        },
        {
            "id": "0010487rh874a9vQAC",
            "name": "Staples",
            "crmOrgId": "DFS76NCHFUEI",
            "crmType": "SALESFORCE"
        }
    ]
}'