Active Campaign

Learn how to use Active Campaign with Composio

Overview

Enum

ACTIVE_CAMPAIGN

Description

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

Authentication Details

api_key
stringRequired
api_url
stringRequired

Actions

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.

Action Parameters

contact_email
stringRequired
note
stringRequired

Action Response

data
object
error
successful
boolean

This tool adds an existing contact to a specific automation in activecampaign. it first looks up the contact by email address to get their id, then adds them to the specified automation using the /api/3/contactautomations endpoint.

Action Parameters

automation_id
stringRequired
contact_email
stringRequired

Action Response

data
object
error
successful
boolean

This tool adds a secondary contact to an existing deal in activecampaign. if the deal has no primary contact set, this contact will be set as primary if no role is specified. the tool requires the user to have permission to manage deals and expects parameters like contact id (required), deal id (required), and role id (optional).

Action Parameters

contact_id
integerRequired
deal_id
integerRequired
role_id
integer

Action Response

data
object
error
successful
boolean

This tool creates a new account in activecampaign. it represents a business or organization and allows programmatic account creation. the tool requires the account name and optionally accepts parameters such as account url, owner, and custom fields.

Action Parameters

accountUrl
string
fields
array
name
stringRequired
owner
integer

Action Response

data
object
error
successful
boolean

Creates a new contact in activecampaign with the specified details. this action allows you to create a new contact with basic information like email, name, phone, organization details, and tags. the email address is the only required field, while all other fields are optional.

Action Parameters

email
stringRequired
first_name
string
job_title
string
last_name
string
organization_name
string
phone
string
tags
string

Action Response

data
object
error
successful
boolean

Create a task associated with a contact in activecampaign. this action allows you to create a new task that will be associated with a specific contact in your activecampaign account. the task can include details such as due date, title, description, and can be assigned to a specific user.

Action Parameters

assignee
integer
dealTasktype
stringRequired
duedate
stringRequired
edate
string
note
string
relid
integerRequired
status
integer
title
string

Action Response

data
object
error
successful
boolean

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

Action Parameters

allgroups
integer
allusers
integer
autoassign
integer
currency
string
title
stringRequired
users
array

Action Response

data
object
error
successful
boolean

This tool creates a new deal task type in activecampaign. deal task types are used to categorize and organize tasks associated with deals, and they are an important feature for maintaining a structured task management system within the deals pipeline. this action complements the existing active campaign create deal task action by enabling the creation of custom task types that can be used when creating deal tasks.

Action Parameters

description
string
status
integer
title
stringRequired

Action Response

data
object
error
successful
boolean

This tool deletes an existing account in activecampaign. it complements the existing active campaign create account and active campaign update account actions, providing full crud capabilities for account management. the action is irreversible and will permanently remove the account from the system.

Action Parameters

account_id
integerRequired

Action Response

data
object
error
successful
boolean

This tool deletes an existing deal pipeline in activecampaign. when deleting a pipeline that has existing deals and stages associated with it, the delete request will remove all stages and deals associated with it. this tool complements the existing active campaign create deal pipeline action and provides the ability to manage the full lifecycle of deal pipelines in activecampaign.

Action Parameters

pipeline_id
integerRequired

Action Response

data
object
error
successful
boolean

This tool deletes an existing deal stage in activecampaign. it offers the ability to either move associated deals to a new pipeline and stage (when type is ‘move’) or completely delete the deals (when type is ‘delete’). it complements the active campaign create deal stage action, ensuring full crud functionality for deal stages.

Action Parameters

action_type
stringRequired
new_pipeline_id
integer
new_stage_id
integer
stage_id
integerRequired

Action Response

data
object
error
successful
boolean

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.

Action Parameters

email
string
id
string
phone
string

Action Response

data
object
error
successful
boolean

This tool allows you to find tasks associated with a specific contact in activecampaign. it searches for tasks using the contact task title and optionally filters by contact id. it returns an object with details such as task id, title, description, status, due date, owner type (which is subscriber for contact tasks), related id, created date, and updated date.

Action Parameters

contact_id
integer
status
integer
title
string

Action Response

data
object
error
successful
boolean

This tool allows you to find a user in activecampaign by their email address, returning detailed information including first name, last name, email, phone, organization details, and related resource links.

Action Parameters

email
stringRequired

Action Response

data
object
error
successful
boolean

List all contacts in activecampaign. this action allows you to: 1. list all contacts with pagination 2. search contacts by name, organization, phone, or email 3. filter contacts by email pattern 4. sort contacts by various fields 5. filter contacts by creation and update dates 6. filter contacts by list, tag, or segment

Action Parameters

email_like
string
filters
object
id_greater
integer
id_less
integer
limit
integerDefaults to 20
listid
string
orders
object
search
string
segmentid
integer
tagid
integer

Action Response

data
object
error
successful
boolean

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.

Action Parameters

action
stringRequired
contact_email
string
contact_id
string
tags
stringRequired

Action Response

data
error
message
string
success
boolean
successful
boolean

Subscribe or unsubscribe a contact from a list in activecampaign. the tool requires either a contact’s email address or contact id, and can perform either a subscribe or unsubscribe action on a specified list.

Action Parameters

action
stringRequired
contact_id
string
email
string
list_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool removes a contact from a specified automation in activecampaign. it first looks up the contact by email address to get their id, then removes them from the specified automation using the /api/3/contactautomations endpoint. the run remove option parameter determines whether to remove them from all runs or just the latest run of the automation.

Action Parameters

automation_id
stringRequired
contact_email
stringRequired
run_remove_option
stringDefaults to all

Action Response

data
object
error
successful
boolean

This tool creates a custom website or application event in activecampaign by recording events through a post api endpoint. it allows tracking of specific actions performed by contacts, and includes parameters such as event key, event actid, event name, event value, and event contact email for authentication, recording, and contextual information. the tool aids in automating workflows and monitoring user engagement.

Action Parameters

event_actid
stringRequired
event_contact_email
stringRequired
event_key
stringRequired
event_name
stringRequired
event_value
string

Action Response

data
object
error
successful
boolean

This tool updates an existing account in activecampaign. it allows modification of account details such as name, website url, and custom fields. it complements the existing active campaign create account action and provides the ability to modify account details after creation, which is a crucial functionality for account management.

Action Parameters

accountUrl
string
account_id
stringRequired
fields
array
name
string
owner
integer

Action Response

data
object
error
successful
boolean

This tool creates a new account if it doesn’t exist or updates an existing account in activecampaign. it is particularly useful to ensure an account exists without creating duplicates, combining the functionality of create and update operations into a single action.

Action Parameters

accountUrl
stringRequired
fields
array
name
stringRequired
owner
integer

Action Response

data
object
error
successful
boolean