Skip to content

ActiveCampaign

ActiveCampaign

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.

This tool uses API key (API_KEY) to connect.

You will need the following fields:

FieldRequiredDescription
api_keyYesAPI key generated in the ActiveCampaign dashboard under Settings → Developer → API Access.
api_urlYesBase URL of your ActiveCampaign account, in the format https://<your-account>.api-us1.com.
  1. Go to app.activecampaign.com and log in to your account.
  2. Click the profile icon in the lower-left corner and go to Settings.
  3. In the side menu, click Developer.
  4. Copy the API URL and the Key values — these are the two values needed to connect.
  1. Go to Tools in the side menu (/admin/tools).
  2. Open the Available tab and search for ActiveCampaign.
  3. Click the card to open the details modal and hit Connect.
  4. You’re taken to the secure connection page hosted by Composio, where you enter the credentials obtained above.
  5. 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.)

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.

NameTypeRequiredDescription
idstringNoThe ActiveCampaign ID of the contact.
emailstringNoThe email address of the contact.
phonestringNoThe 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.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
limitintegerNoNumber of contacts to return per page.
tagidintegerNoFilter contacts associated with the given tag.
listidstringNoFilter contacts associated with the given list.
ordersobjectNoOrders model for sorting contacts.
searchstringNoFilter contacts by searching in names, organization, phone, or email.
filtersobjectNoFilters model for filtering contacts by date.
id_lessintegerNoOnly include contacts with an ID less than the given ID.
segmentidintegerNoReturn only contacts that match a list segment.
email_likestringNoFilter contacts that contain the given value in the email address.
id_greaterintegerNoOnly include contacts with an ID greater than the given ID.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
contactobjectYesContact 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.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
idintegerYesThe ID of the contact to update.
emailstringNoThe updated email address of the contact.
phonestringNoThe updated phone number of the contact.
lastNamestringNoThe updated last name of the contact.
firstNamestringNoThe updated first name of the contact.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
contact_idintegerYesThe ID of the contact to delete. Contact IDs can be obtained from creation, find, or list contact actions.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
listintegerYesThe ID of the list to add the contact to.
statusintegerYesThe subscription status. Use 1 for subscribed, 2 for unsubscribed.
contactintegerYesThe ID of the contact to add to the list.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
automation_idstringYesID of the automation to add the contact to.
contact_emailstringYesEmail address of the contact to add to automation.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
notestringYesThe content of the note to be added. This should be plain text as HTML will be stripped.
contact_emailstringYesThe email address of the contact to associate the note with.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
tagstringYesID of the tag to add to the contact.
contactstringYesID of the contact to add the tag to.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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

NameTypeRequiredDescription
tag_idstringYesThe 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.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
tagsstringYesTags to add/remove. Can be a comma-separated string or list of strings.
actionstring ("Add" or "Remove")YesThe action to perform on the tags.
contact_idstringNoThe ID of the contact to manage tags for.
contact_emailstringNoThe email of the contact (used if contact_id is not provided).
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

ACTIVE_CAMPAIGN_CREATE_CAMPAIGN

Create a new campaign in ActiveCampaign. Use when you need to create a broadcast email campaign or automation campaign.

NameTypeRequiredDescription
namestringYesName of the campaign to create. Must be unique.
typestring ("single", "recurring", "split", "responder", "reminder", "special", "activerss", "automation")YesType of campaign to create. "single" is for broadcast emails, "automation" for automated campaigns.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

ACTIVE_CAMPAIGN_LIST_CAMPAIGNS

List all campaigns in ActiveCampaign, including standard campaigns and automation campaigns. Supports pagination and filters.

NameTypeRequiredDescription
limitintegerNoMaximum number of campaigns to return (default is 20).
offsetintegerNoNumber of campaigns to skip for pagination.
ordersobjectNoOrders model for sorting campaigns.
filtersobjectNoFilters model for filtering campaigns.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
idintegerYesThe campaign ID to retrieve.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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

NameTypeRequiredDescription
messageobjectYesThe message object containing all message properties.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.”

NameTypeRequiredDescription
titlestringYesThe name of the pipeline.
usersarrayNoArray 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.
allusersintegerNoSet to 1 to allow all users to manage the pipeline.
currencystringYesThe default currency for deals in this pipeline (ISO 4217 currency code, e.g., "usd", "eur", "gbp").
allgroupsintegerNoSet to 1 to allow all user groups to manage the pipeline.
autoassignintegerNoSet to 1 to enable automatic assignment of new deals to owners.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
limitintegerNoNumber of deals to return per page. Maximum value is typically 100.
offsetintegerNoPagination offset — number of records to skip before returning results.
filters_groupintegerNoFilter by pipeline ID (also called group).
filters_ownerintegerNoFilter by owner ID (user ID).
filters_stageintegerNoFilter by deal stage ID.
filters_searchstringNoSearch deals by title.
filters_statusintegerNoFilter by deal status. Use 0 for open deals, 1 for won deals, 2 for lost deals.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
idintegerYesThe ID of the deal to retrieve.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
idintegerYesThe ID of the deal to update.
groupstringNoThe ID of the pipeline (deal group) for this deal.
ownerstringNoThe ID of the user who owns this deal.
stageintegerNoThe ID of the stage within the pipeline.
titlestringNoThe updated title of the deal.
valueintegerNoThe updated value of the deal in cents (e.g., $1850.00 should be 185000).
statusintegerNoThe status of the deal. Use 0 for open, 1 for won, 2 for lost.
accountstringNoThe ID of the account associated with this deal.
contactstringNoThe ID of the primary contact associated with this deal.
percentintegerNoThe percentage of completion for the deal.
currencystringNoThe currency code in 3-digit ISO format, lowercase (e.g., "usd", "eur", "gbp").
descriptionstringNoA description of the deal.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
idintegerYesThe ID of the deal to delete. Deal IDs can be obtained from creation, update, or list deal operations.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
listobjectYesList object containing the details of the list to create.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
limitintegerNoNumber of automations to return per page.
offsetintegerNoPagination offset for retrieving additional results.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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

NameTypeRequiredDescription
tagstringYesThe name of the tag to create.
tag_typestring ("contact" or "template")YesThe type of tag to create. Use "contact" for tags applied to contacts or "template" for template-related tags.
descriptionstringNoOptional description for the tag to provide context about its purpose.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

ACTIVE_CAMPAIGN_LIST_ALL_TAGS2

Retrieve all tags in ActiveCampaign with search functionality. Use when you need to list or search for existing tags.

NameTypeRequiredDescription
limitintegerNoNumber of tags to return per request (default: 20).
offsetintegerNoNumber of items to skip for pagination.
searchstringNoSearch by tag name to filter results.
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.

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.

NameTypeRequiredDescription
urlstringYesThe URL endpoint where webhook data will be posted. Must be a valid HTTP/HTTPS URL that can accept POST requests.
namestringYesThe name of the webhook to identify it.
eventsarrayYesArray 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.
listidstringNoThe list ID to associate with the webhook. If provided, the webhook will only trigger for events related to this specific list.
sourcesarrayYesArray of sources that can trigger the webhook. Common sources: "public", "system", "admin", "api".
NameTypeRequiredDescription
datastringYesData from the action execution.
errorstringNoError if any occurred during the execution of the action.
successfulbooleanYesWhether or not the action execution was successful.