ActiveCampaign Lists
ActiveCampaign Lists manages the lists of your ActiveCampaign account, the groups of contacts you send your campaigns to. You can create a list, look up one or all of them, change its details and delete it.
To subscribe a contact to a list or remove them from it, use ActiveCampaign Contacts with Add to List or Remove from List.
When to use it
- You launch a new product and want to create a list for interested people.
- You need a list’s ID to subscribe contacts from another component.
- You want to review the lists in your account to see which ones are still in use.
- A list from a past event is no longer useful and you want to delete it.
Configuration
You need an ActiveCampaign credential with the API URL and the API key of your account. You find them in ActiveCampaign under Settings > Developer. See Credentials.
| Field | What it does |
|---|---|
| Credential (required) | The ActiveCampaign credential used to access your account. |
| Operation (required) | What the component does. See Operations. Default: Get Lists. |
| Get By | Only in Get Lists. By ID fetches one list and All fetches all of them. Default: All. |
| List Name | The list’s name. Required in Create List and Update List. |
| List ID | The list’s ID. Required in Update List, Delete List and in Get Lists with By ID. |
| Limit | Only in Get Lists with All. The maximum number of lists to fetch. Default: 10. |
| Sender URL | Your company’s website or the page where subscribers sign up. ActiveCampaign requires it. Required in Create List and Update List. Default: https://yoursite.com; change it to your website. |
| Sender Reminder | A short text reminding subscribers why they are on the list, for example You signed up on our website. ActiveCampaign requires it. Required in Create List and Update List. |
Operations
| Operation | What it does |
|---|---|
Create List | Creates a new list. |
Update List | Changes the name, website and reminder of an existing list. |
Get Lists | Fetches one list or all of them. |
Delete List | Deletes a list. |
Output
The Data output returns the list you worked with, with its ID and name. With Get Lists set to All you get one item per list. In Delete List it returns a confirmation with the ID.
You can pass the list ID to ActiveCampaign Contacts to subscribe contacts. The component can also be connected to an Agent as a tool, so the agent decides when to look up or create lists. See Tool Mode.
Example
A yoga studio opens a new course and wants a list for interested people.
- Add ActiveCampaign Lists with
Create List. - In List Name put
Beginner yoga course, in Sender URL the studio’s website, and in Sender ReminderYou signed up to receive information about the course. - Use the ID it returns to subscribe every person who asks for information with ActiveCampaign Contacts.
Related components
- ActiveCampaign Contacts: subscribe contacts to lists.
- ActiveCampaign Campaigns: look up the campaigns you send to your lists.