ActiveCampaign
Overview
Section titled “Overview”ActiveCampaign is a marketing automation and CRM platform enabling businesses to manage email campaigns, sales pipelines, and customer segmentation to boost engagement and drive growth. With the integration in SquadOS, your agents can create and update contacts, trigger automations, send campaigns, and manage deals in the sales funnel without leaving the workflow.
- Official website: https://www.activecampaign.com/
- Composio documentation: docs.composio.dev/toolkits/active_campaign
Authentication
Section titled “Authentication”This tool uses API key (API_KEY) to connect.
You will need the following fields:
| Field | Required | Description |
|---|---|---|
api_key | Yes | API key generated in the ActiveCampaign dashboard under Settings → Developer → API Access. |
api_url | Yes | Base URL of your ActiveCampaign account, in the format https://<your-account>.api-us1.com. |
How to get credentials
Section titled “How to get credentials”- Go to app.activecampaign.com and log in to your account.
- Click the profile icon in the lower-left corner and go to Settings.
- In the side menu, click Developer.
- Copy the API URL and the Key values — these are the two values needed to connect.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
ActiveCampaign. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the credentials obtained above.
- Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)
Available actions
Section titled “Available actions”Find contact
Section titled “Find contact”ACTIVE_CAMPAIGN_FIND_CONTACT
Find a specific contact in ActiveCampaign using either their email address, ID, or phone number. This action provides a more efficient way to find a specific contact instead of listing all contacts.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | The ActiveCampaign ID of the contact. |
email | string | No | The email address of the contact. |
phone | string | No | The phone number of the contact. Note: Phone search uses the general search parameter internally, which may return partial matches. When combined with email, results are filtered client-side to match both criteria. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List all contacts
Section titled “List all contacts”ACTIVE_CAMPAIGN_LIST_ALL_CONTACTS
List all contacts in ActiveCampaign. This action allows you to: list all contacts with pagination, search contacts by name/organization/phone/email, filter by email pattern, sort by various fields, filter by creation and update dates, and filter by list, tag, or segment.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of contacts to return per page. |
tagid | integer | No | Filter contacts associated with the given tag. |
listid | string | No | Filter contacts associated with the given list. |
orders | object | No | Orders model for sorting contacts. |
search | string | No | Filter contacts by searching in names, organization, phone, or email. |
filters | object | No | Filters model for filtering contacts by date. |
id_less | integer | No | Only include contacts with an ID less than the given ID. |
segmentid | integer | No | Return only contacts that match a list segment. |
email_like | string | No | Filter contacts that contain the given value in the email address. |
id_greater | integer | No | Only include contacts with an ID greater than the given ID. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create or Update Contact
Section titled “Create or Update Contact”ACTIVE_CAMPAIGN_CREATE_OR_UPDATE_CONTACT
Create a new contact or update an existing contact in ActiveCampaign using the sync endpoint. If a contact with the given email exists, it will be updated; otherwise, a new contact will be created. This is the recommended way to ensure contact data is up-to-date without manually checking for existence.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
contact | object | Yes | Contact object containing email and other fields to sync. The email is used to match existing contacts — if found, the contact is updated; otherwise, a new contact is created. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update Contact
Section titled “Update Contact”ACTIVE_CAMPAIGN_UPDATE_CONTACT
Update an existing contact in ActiveCampaign by ID. Use when you need to modify specific fields of a contact such as email, name, or phone number. Note: Contact-Organization relationships are now managed through Account-Contact endpoints.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The ID of the contact to update. |
email | string | No | The updated email address of the contact. |
phone | string | No | The updated phone number of the contact. |
lastName | string | No | The updated last name of the contact. |
firstName | string | No | The updated first name of the contact. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Contact
Section titled “Delete Contact”ACTIVE_CAMPAIGN_DELETE_CONTACT
Permanently deletes a contact from ActiveCampaign by its ID. This action is irreversible and will remove the contact and all associated data from the system. The deletion is immediate and cannot be undone.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
contact_id | integer | Yes | The ID of the contact to delete. Contact IDs can be obtained from creation, find, or list contact actions. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Add contact to list
Section titled “Add contact to list”ACTIVE_CAMPAIGN_ADD_CONTACT_TO_LIST
Add or remove a contact subscription to a list in ActiveCampaign. Use when you need to subscribe or unsubscribe a contact to/from a specific list using their IDs.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
list | integer | Yes | The ID of the list to add the contact to. |
status | integer | Yes | The subscription status. Use 1 for subscribed, 2 for unsubscribed. |
contact | integer | Yes | The ID of the contact to add to the list. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Add Contact to Automation
Section titled “Add Contact to Automation”ACTIVE_CAMPAIGN_ADD_CONTACT_TO_AUTOMATION
Adds an existing ActiveCampaign contact to a specific automation workflow. The contact must already exist in ActiveCampaign, and the automation must be created beforehand (automations can only be created through the ActiveCampaign UI, not via API). The action performs two steps: (1) looks up the contact by email to retrieve their contact ID; (2) enrolls the contact in the specified automation.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
automation_id | string | Yes | ID of the automation to add the contact to. |
contact_email | string | Yes | Email address of the contact to add to automation. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Add contact note
Section titled “Add contact note”ACTIVE_CAMPAIGN_ADD_CONTACT_NOTE
Add a note to a contact in ActiveCampaign. The note will be associated with a contact as a subscriber type. The tool will first find the contact ID using the provided email address and then create the note.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
note | string | Yes | The content of the note to be added. This should be plain text as HTML will be stripped. |
contact_email | string | Yes | The email address of the contact to associate the note with. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Add Tag to Contact
Section titled “Add Tag to Contact”ACTIVE_CAMPAIGN_ADD_TAG_TO_CONTACT
Add a tag to a contact in ActiveCampaign. Use when you need to directly associate a tag with a contact using their IDs. Both contact ID and tag ID must already exist.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag | string | Yes | ID of the tag to add to the contact. |
contact | string | Yes | ID of the contact to add the tag to. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Remove Tag from Contact
Section titled “Remove Tag from Contact”ACTIVE_CAMPAIGN_REMOVE_TAG_FROM_CONTACT
Remove a tag from a contact in ActiveCampaign. Requires the contactTag ID (the relationship ID between contact and tag, not the tag ID itself).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag_id | string | Yes | The contactTag ID (association ID between contact and tag) to remove. This is NOT the tag ID itself, but the ID of the contact-tag relationship. You can obtain this ID from ACTIVE_CAMPAIGN_GET_CONTACT_TAGS or ACTIVE_CAMPAIGN_ADD_TAG_TO_CONTACT actions. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Manage contact tag
Section titled “Manage contact tag”ACTIVE_CAMPAIGN_MANAGE_CONTACT_TAG
Manage tags for a contact in ActiveCampaign. This action allows adding or removing tags from a contact. The action can be performed using either the contact’s ID or email address.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tags | string | Yes | Tags to add/remove. Can be a comma-separated string or list of strings. |
action | string ("Add" or "Remove") | Yes | The action to perform on the tags. |
contact_id | string | No | The ID of the contact to manage tags for. |
contact_email | string | No | The email of the contact (used if contact_id is not provided). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Campaign
Section titled “Create Campaign”ACTIVE_CAMPAIGN_CREATE_CAMPAIGN
Create a new campaign in ActiveCampaign. Use when you need to create a broadcast email campaign or automation campaign.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the campaign to create. Must be unique. |
type | string ("single", "recurring", "split", "responder", "reminder", "special", "activerss", "automation") | Yes | Type of campaign to create. "single" is for broadcast emails, "automation" for automated campaigns. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Campaigns
Section titled “List Campaigns”ACTIVE_CAMPAIGN_LIST_CAMPAIGNS
List all campaigns in ActiveCampaign, including standard campaigns and automation campaigns. Supports pagination and filters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of campaigns to return (default is 20). |
offset | integer | No | Number of campaigns to skip for pagination. |
orders | object | No | Orders model for sorting campaigns. |
filters | object | No | Filters model for filtering campaigns. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Campaign By ID
Section titled “Get Campaign By ID”ACTIVE_CAMPAIGN_GET_CAMPAIGN_BY_ID
Retrieve a single campaign by its ID from ActiveCampaign. Returns comprehensive campaign details including engagement metrics, content configuration, and automation settings.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The campaign ID to retrieve. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Message
Section titled “Create Message”ACTIVE_CAMPAIGN_CREATE_MESSAGE
Create a message in ActiveCampaign. Use when you need to create an email message template that can be used in campaigns or automations. The message must include a subject, sender information (name and email), reply-to address, and content (HTML and/or text).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message | object | Yes | The message object containing all message properties. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Deal Pipeline
Section titled “Create Deal Pipeline”ACTIVE_CAMPAIGN_CREATE_DEAL_PIPELINE
Creates a new deal pipeline in ActiveCampaign. A deal pipeline is a visual representation of your sales process that helps organize and track deals through different stages. When you create a new pipeline, it automatically comes with three default stages: “To Contact,” “In Contact,” and “Follow Up.”
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
title | string | Yes | The name of the pipeline. |
users | array | No | Array of user IDs who are allowed to manage the pipeline. Note: This parameter may cause API errors in some configurations and should be used with caution. |
allusers | integer | No | Set to 1 to allow all users to manage the pipeline. |
currency | string | Yes | The default currency for deals in this pipeline (ISO 4217 currency code, e.g., "usd", "eur", "gbp"). |
allgroups | integer | No | Set to 1 to allow all user groups to manage the pipeline. |
autoassign | integer | No | Set to 1 to enable automatic assignment of new deals to owners. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Deals (Search & Filter)
Section titled “List All Deals (Search & Filter)”ACTIVE_CAMPAIGN_LIST_DEALS2
List all deals from ActiveCampaign with search and filtering capabilities. Use when you need to retrieve deals with search by title or filter by stage, pipeline, owner, or status.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of deals to return per page. Maximum value is typically 100. |
offset | integer | No | Pagination offset — number of records to skip before returning results. |
filters_group | integer | No | Filter by pipeline ID (also called group). |
filters_owner | integer | No | Filter by owner ID (user ID). |
filters_stage | integer | No | Filter by deal stage ID. |
filters_search | string | No | Search deals by title. |
filters_status | integer | No | Filter by deal status. Use 0 for open deals, 1 for won deals, 2 for lost deals. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve a Deal
Section titled “Retrieve a Deal”ACTIVE_CAMPAIGN_RETRIEVE_A_DEAL
Retrieve a specific deal by its ID in ActiveCampaign. Returns detailed information including title, value, stage, status, and associated contacts or organizations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The ID of the deal to retrieve. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update a Deal
Section titled “Update a Deal”ACTIVE_CAMPAIGN_UPDATE_A_DEAL
Update an existing deal in ActiveCampaign. Use when you need to modify deal properties such as title, value, stage, or status.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The ID of the deal to update. |
group | string | No | The ID of the pipeline (deal group) for this deal. |
owner | string | No | The ID of the user who owns this deal. |
stage | integer | No | The ID of the stage within the pipeline. |
title | string | No | The updated title of the deal. |
value | integer | No | The updated value of the deal in cents (e.g., $1850.00 should be 185000). |
status | integer | No | The status of the deal. Use 0 for open, 1 for won, 2 for lost. |
account | string | No | The ID of the account associated with this deal. |
contact | string | No | The ID of the primary contact associated with this deal. |
percent | integer | No | The percentage of completion for the deal. |
currency | string | No | The currency code in 3-digit ISO format, lowercase (e.g., "usd", "eur", "gbp"). |
description | string | No | A description of the deal. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Deal
Section titled “Delete Deal”ACTIVE_CAMPAIGN_DELETE_DEAL
Permanently delete a deal from ActiveCampaign by its ID. This action is irreversible and will remove the deal and all associated data. The deletion is immediate and cannot be undone.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The ID of the deal to delete. Deal IDs can be obtained from creation, update, or list deal operations. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create List
Section titled “Create List”ACTIVE_CAMPAIGN_CREATE_LIST
Create a new subscriber list in ActiveCampaign. Use when you need to create a list for organizing contacts and sending campaigns.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
list | object | Yes | List object containing the details of the list to create. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Automations
Section titled “List Automations”ACTIVE_CAMPAIGN_LIST_AUTOMATIONS
List all automations in ActiveCampaign. Use this to retrieve all automation workflows in your account. Supports pagination via limit and offset parameters for handling large numbers of automations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of automations to return per page. |
offset | integer | No | Pagination offset for retrieving additional results. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Tag with Type
Section titled “Create Tag with Type”ACTIVE_CAMPAIGN_CREATE_A_TAG2
Create a new tag in ActiveCampaign with explicit tag type specification. Use when you need to create a tag with a specific type (contact or template).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag | string | Yes | The name of the tag to create. |
tag_type | string ("contact" or "template") | Yes | The type of tag to create. Use "contact" for tags applied to contacts or "template" for template-related tags. |
description | string | No | Optional description for the tag to provide context about its purpose. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Tags
Section titled “List All Tags”ACTIVE_CAMPAIGN_LIST_ALL_TAGS2
Retrieve all tags in ActiveCampaign with search functionality. Use when you need to list or search for existing tags.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of tags to return per request (default: 20). |
offset | integer | No | Number of items to skip for pagination. |
search | string | No | Search by tag name to filter results. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Webhook
Section titled “Create Webhook”ACTIVE_CAMPAIGN_CREATE_WEBHOOK
Create a new webhook in ActiveCampaign to receive real-time notifications when specific events occur. Use this when you need to set up automated notifications for contact activities like subscriptions, email interactions, or other events.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | The URL endpoint where webhook data will be posted. Must be a valid HTTP/HTTPS URL that can accept POST requests. |
name | string | Yes | The name of the webhook to identify it. |
events | array | Yes | Array of event types that will trigger the webhook. Common events include "subscribe", "unsubscribe", "sent", "open", "click", "bounce", "reply". Use the List Webhook Events action to see all available events. |
listid | string | No | The list ID to associate with the webhook. If provided, the webhook will only trigger for events related to this specific list. |
sources | array | Yes | Array of sources that can trigger the webhook. Common sources: "public", "system", "admin", "api". |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |