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
Tools (298)
Add Browse Session to Cart
Set a browse session to have addedToCart flag set to true in ActiveCampaign. This action updates an existing browse session or creates a new one with the addedToCart flag enabled for the specified email and connection. Use this to track when a customer adds items to their shopping cart during their browsing session.
Inputs: email, legacy_connection_id
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.
Inputs: note, contact_email
Add Contact to Automation
Adds an existing ActiveCampaign contact to a specific automation workflow. This action enrolls a contact in an automation by their email address. 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 Returns enrollment details including the contact ID, automation ID, status, and timestamps. Note: The automation_id must correspond to an existing, active automation in your ActiveCampaign account. You can find automation IDs through the ActiveCampaign UI or by listing automations via the GET /api/3/automations endpoint.
Inputs: automation_id, contact_email
Add contact to list
Tool to add a contact to a list in ActiveCampaign. Use when you need to subscribe or unsubscribe a contact to/from a specific list using their IDs.
Inputs: list, status, contact
Add Custom Field
Tool to add a new custom field in ActiveCampaign. Use when you need to create a custom contact field to store additional information like industry, company size, or other custom data points. Supports various field types including text, dropdown, date, and more.
Inputs: cols, rows, type, group, title, options, perstag, visible, descript, ordernum, isrequired, show_in_list
Add Custom Field Options
Tool to add custom field options in bulk to ActiveCampaign. Use when you need to create multiple options for dropdown, radio, checkbox, or listbox custom fields. The field must already exist before adding options.
Inputs: fieldOptions
Add Custom Field to Field Group
Tool to add a custom field to a field group in ActiveCampaign. Use when you need to associate a custom field with a display group to organize related fields together on contact or deal pages.
Inputs: rel_id, group_id
Add Domain to Site Tracking Whitelist
Add a domain to ActiveCampaign's site tracking whitelist. Use this to enable site tracking functionality for specific domains in your ActiveCampaign account. This action registers a domain that is allowed for site tracking. After adding a domain to the whitelist, ActiveCampaign can track visitor activity on that domain for analytics and automation purposes.
Inputs: domain_name
Add Field Relationship
Add a field relationship in ActiveCampaign. Use this to associate a custom field with a list or other entity, enabling the field to be used within that context.
Inputs: field, relid
Add Secondary Contact to Deal
Adds a secondary contact to an existing deal in ActiveCampaign. Secondary contacts are additional team members associated with a deal beyond the primary contact. You can optionally specify a job title to provide context about the contact's role in the deal. Required permissions: User must have permission to manage deals. Required parameters: contact_id, deal_id Optional parameters: job_title
Inputs: deal_id, job_title, contact_id
Add Tag to Contact
Tool to 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.
Inputs: tag, contact
Create Account
Creates a new account in ActiveCampaign. An account represents a business or organization that you want to track in your CRM. Each account must have a unique name. Required: account name Optional: account URL, owner (user ID, defaults to 1), custom fields Note: Account names must be unique. If an account with the same name already exists, the API will return an error.
Inputs: name, owner, fields, accountUrl
Create Account Contact Association
Tool to create a new account-contact association in ActiveCampaign. Use when you need to link an existing contact to an existing account, optionally specifying the contact's job title at that account.
Inputs: account, contact, jobTitle
Create Account Custom Field Data
Creates a custom field value for an account in ActiveCampaign. Use when you need to set or add a custom field value to an existing account. Requires the account ID and custom field ID.
Inputs: fieldValue, customFieldId, fieldCurrency, customerAccountId
Create Account Custom Field Metadata
Tool to create a new account custom field metadata in ActiveCampaign. Use when you need to define a new custom field for accounts. After creating the field, you must call the Add Custom Field to Field Group API to add it to a field group for visibility on record pages.
Inputs: accountCustomFieldMetum
Create Account Note
Tool to create a new note for an account in ActiveCampaign. Use when you need to add notes or comments to a specific account. The note will be associated with the account specified by the account ID.
Inputs: id, note
Create Address
Tool to create a new address in ActiveCampaign. Use when you need to add a company address for campaigns, forms, or other communications. Requires company name, primary address, and country code.
Inputs: zip, city, state, country, allgroup, district, address_1, address_2, company_name
Create a Deal Note
Tool to create a note for a specific deal in ActiveCampaign. Use when you need to add documentation, comments, or important information to a deal record.
Inputs: id, note
Create An Order
Tool to create an e-commerce order in ActiveCampaign. Use when you need to record a purchase or transaction for e-commerce tracking and automation triggers.
Inputs: email, source, currency, orderUrl, orderDate, taxAmount, customerid, externalid, totalPrice, orderNumber, connectionid, abandonedDate, orderProducts, discountAmount, shippingAmount, shippingMethod, externalcheckoutid, externalCreatedDate, externalUpdatedDate
Create Tag with Type
Tool to 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).
Inputs: tag, tag_type, description
Bulk Create Account Custom Field Data
Tool to bulk create custom field values for accounts in ActiveCampaign. Use when you need to set multiple custom field values across one or more accounts in a single request. Note: This endpoint updates the Last Modified date of associated accounts. If multiple items in the request reference the same accountId, the first item's account will show the modified timestamp.
Inputs: accountCustomFieldData
Create Calendar Feed
Tool to create a new calendar feed in ActiveCampaign. Use when you need to create a calendar feed that syncs with external calendar applications like Google Calendar or Outlook.
Inputs: type, title, notification
Create Campaign
Tool to create a new campaign in ActiveCampaign. Use when you need to create a broadcast email campaign or automation campaign.
Inputs: name, type
Create Child Schema
Tool to create a child schema in ActiveCampaign. Use when you need to create a child schema for a parent schema. Parent/child schemas allow multiple customers to share the same schema, useful for resellers and application developers. The parent schema must be public and associated with an application ID.
Inputs: parent_schema_id
Create Connection
Tool to create a new connection in ActiveCampaign. Use when you need to establish a link between an ActiveCampaign account and an external service or application.
Inputs: name, linkUrl, logoUrl, service, externalid
Create contact task
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.
Inputs: note, edate, relid, title, status, duedate, assignee, dealTasktype
Create Customer
Tool to create an e-commerce customer in ActiveCampaign. Use when you need to register a new customer from your e-commerce platform for tracking purchases and automations.
Inputs: email, externalid, connectionid, acceptsMarketing
Create Deal Custom Field Metadata
Tool to create a new deal custom field metadata in ActiveCampaign. Use when you need to define a new custom field for deals. After creating the field, you must call the Add Custom Field to Field Group API (/api/3/groupMembers) to add it to a field group for visibility on deal pages.
Inputs: dealCustomFieldMetum
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.'
Inputs: title, users, allusers, currency, allgroups, autoassign
Create Deal Role
Tool to create a new deal role in ActiveCampaign. Use when you need to define roles that contacts can have in deals, such as Decision Maker, Influencer, or Head of Sales.
Inputs: title
Create Deal Stage
Tool to create a new stage in an ActiveCampaign deal pipeline. Use when you need to add a custom stage to organize deals in a specific pipeline.
Inputs: group, order, title
Create Deal Task Type
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.
Inputs: title, status, description
Create Duplicate Campaign
Tool to duplicate an existing campaign in ActiveCampaign. Use when you need to create a copy of a campaign with the same configuration and content.
Inputs: campaign_id
Create Event Tracking Event
Tool to create a new event tracking event in ActiveCampaign. Use when you need to whitelist a new event name for tracking and use in automations.
Inputs: name
Create Form Opt-in
Submit a form opt-in for a specific form in ActiveCampaign. Use when you need to programmatically opt-in a contact to a form without requiring them to fill it out manually.
Inputs: form_id
Bulk Import Contacts
Bulk import large numbers of contacts into ActiveCampaign with a single API call. This action allows you to upload up to 250,000 contacts at once. The import is processed asynchronously - contacts are queued and imported in the background. You can optionally provide a webhook callback URL to be notified when the import completes. Use cases: - Migrate contacts from another platform - Import large CSV files of contacts - Bulk upload leads from marketing campaigns - Synchronize contacts from external databases Note: This is an asynchronous operation. The API returns immediately with a batch ID, but contacts are processed in the background. Use the callback parameter to get notified when processing completes.
Inputs: callback, contacts
Create List
Tool to create a new list in ActiveCampaign. Use when you need to create a subscriber list for organizing contacts and sending campaigns.
Inputs: list
Create List Group Permission
Creates a list group permission in ActiveCampaign by associating a list with a user group. This allows you to grant a specific group access permissions to a particular list.
Inputs: listid, groupid
Create Message
Tool to 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).
Inputs: message
Create Metrics Snapshot for Broadcasts
Tool to retrieve snapshot metrics for specified SMS broadcast IDs in ActiveCampaign. Use when you need aggregated metrics (campaigns, sends, deliveries, clicks, replies, failures, opt-outs) for specific broadcast IDs.
Inputs: ids
Create Note
Create a note and attach it to a specific entity (contact, deal, account, etc.) in ActiveCampaign. Use this when you need to add notes to track information about contacts, deals, or accounts.
Inputs: note, relid, reltype
Create or Update Contact
Create a new contact or update an existing contact in ActiveCampaign using the sync endpoint. This action uses the contact sync endpoint which automatically handles both creation and updates: - If a contact with the given email exists, it will be updated with the provided data - If no contact with the email exists, a new contact will be created This is the recommended way to ensure contact data is up-to-date without manually checking for existence.
Inputs: contact
Create or Update Custom Object Record
Tool to create or update a custom object record in ActiveCampaign. Use when you need to store custom data associated with contacts, accounts, or deals using custom object schemas. The API uses upsert logic: if external_id matches an existing record, it updates; otherwise, it creates a new record.
Inputs: fields, schema_id, external_id, relationships
Add Domain to Tracking Whitelist
Add a domain to ActiveCampaign's site tracking whitelist. Use this to enable tracking, conversations, and WordPress integration for specific domains or pages in your ActiveCampaign account. This action is required before ActiveCampaign tracking scripts will function on your domain. You can control which features (tracking, conversations, WordPress) are enabled for each whitelisted domain.
Inputs: wp_enabled, tracking_enabled, whitelisted_page, whitelisted_domain, conversations_enabled
Create Product in Catalog
Create a new product entry in the ActiveCampaign ecommerce catalog using GraphQL. This action creates a product in your ActiveCampaign ecommerce catalog with details like name, SKU, price, and variant information. The product is associated with a specific DeepData connection ID that links it to your e-commerce integration.
Inputs: variant_sku, variant_name, store_primary_id, base_product_name, legacy_connection_id, variant_price_amount, variant_price_currency
Create Saved Response
Tool to create a new saved response in ActiveCampaign. Use when you need to create a reusable email template with title, subject, and body content.
Inputs: body, title, subject
Create Segment V2
Tool to create advanced segments in ActiveCampaign using the V2 segments API. Use when you need to create flexible contact segments with complex filtering conditions based on tags, lists, fields, or other contact attributes. Only segments supported by the segment-builder UI are guaranteed to work as expected.
Inputs: data
Create Shareable Campaign Template Link
Tool to create a shareable link for a campaign template in ActiveCampaign. Use when you need to generate a URL that can be shared with others to access a specific campaign template.
Inputs: id
Create Task Outcome
Tool to create a new task outcome in ActiveCampaign. Use when you need to add a new outcome option for tasks, which helps categorize task results with associated sentiment.
Inputs: title, disabled, sentiment, created_by
Create Task Reminder
Create a new task reminder notification in ActiveCampaign. Use this action to set up notifications that will remind users about upcoming tasks before their due date.
Inputs: interval, deal_task
Create User
Creates a new user (team member/staff account) in ActiveCampaign with specified details. Use when you need to add a new team member who can log into ActiveCampaign. Note: This creates account users (staff), not contacts (marketing database entries).
Inputs: lang, email, group, lastName, password, username, firstName, localZoneid
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.
Inputs: url, name, events, listid, sources
Delete Account
Permanently deletes an account from ActiveCampaign by its ID. This action is irreversible and will remove the account and all associated data from the system. Use this when you need to clean up old or unwanted accounts. The deletion is immediate and cannot be undone. Returns the deleted account ID upon successful deletion. Raises an error if the account is not found.
Inputs: account_id
Delete Account Contact Association
Deletes an existing account-contact association in ActiveCampaign. Use when you need to remove the relationship between an account and a contact without deleting either entity.
Inputs: id
Delete Account Custom Field Data
Tool to delete a custom account field value in ActiveCampaign. Use when you need to remove a specific custom field value associated with an account. Requires permission to manage accounts.
Inputs: id
Delete Account Custom Field Meta
Tool to delete an account custom field meta definition from ActiveCampaign. Use when you need to remove a custom field definition permanently. Requires account management permissions. This action is irreversible.
Inputs: id
Delete Bulk Accounts
Tool to bulk delete multiple accounts from ActiveCampaign in a single operation. Use when you need to delete multiple accounts at once rather than deleting them individually. This action is irreversible and will permanently remove all specified accounts and their associated data. Provide a list of account IDs to delete.
Inputs: ids
Delete Address
Permanently deletes an address from ActiveCampaign by its ID. This action is irreversible and will remove the address from the system. Use this when you need to clean up old or unwanted addresses. The deletion is immediate and cannot be undone. Returns the deleted address ID upon successful deletion. Raises an error if the address is not found.
Inputs: id
Delete Address Group
Tool to delete an address group from ActiveCampaign by its ID. Use when you need to remove an address group permanently. This action is irreversible and will remove the address group from the system immediately.
Inputs: id
Delete An Order
Tool to permanently delete an e-commerce order from ActiveCampaign by its ID. Use when you need to remove an order from the system. This action is irreversible - the deleted order cannot be recovered.
Inputs: ecom_order_id
Delete Calendar Feed
Tool to permanently delete a calendar feed from ActiveCampaign by its ID. Use when you need to remove a calendar feed that is no longer needed. The deletion is immediate and cannot be undone.
Inputs: id
Delete Connection
Permanently deletes a connection from ActiveCampaign by its ID. This action is irreversible and will remove the connection from the system. Use this when you need to clean up old or unwanted connections. The deletion is immediate and cannot be undone. Returns the deleted connection ID upon successful deletion. Raises an error if the connection is not found.
Inputs: connection_id
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. Use this when you need to clean up old or unwanted contacts. The deletion is immediate and cannot be undone. Returns the deleted contact ID upon successful deletion. Raises an error if the contact is not found.
Inputs: contact_id
Delete Customer
Tool to permanently delete an e-commerce customer from ActiveCampaign by ID. Use when you need to remove a customer and all associated data. This action is irreversible and cannot be undone.
Inputs: customer_id
Delete Custom Field
Tool to delete a custom field from ActiveCampaign by its ID. Use when you need to remove an unwanted or obsolete custom field. This action is irreversible and will permanently delete the field and its associated data.
Inputs: field_id
Delete Custom Field Field Group
Tool to delete a custom field field group member in ActiveCampaign. Use when you need to remove the association between a custom field and a field group. This operation is permanent and cannot be undone.
Inputs: group_id
Delete Deal
Tool to permanently delete a deal from ActiveCampaign by its ID. Use when you need to remove unwanted or obsolete deals from the system. This action is irreversible and will permanently remove the deal and all associated data. The deletion is immediate and cannot be undone.
Inputs: id
Delete Deal Custom Field Data
Tool to delete a custom deal field value in ActiveCampaign. Use when you need to remove custom field data from a deal. Requires deal management permissions and pipeline-specific permissions.
Inputs: id
Delete Deal Custom Field Metadata
Tool to delete a custom deal field metadata from ActiveCampaign. Use when you need to remove a custom field definition from deals. Requires deal management permissions and pipeline-specific permissions.
Inputs: id
Delete Deal Pipeline
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.
Inputs: pipeline_id
Delete Deal Role
Tool to delete an existing deal role in ActiveCampaign. Use when you need to permanently remove a deal role that is no longer needed.
Inputs: id
Delete Deal Stage
This tool deletes an existing deal stage in ActiveCampaign. Before deleting the stage, it provides options to handle existing deals: use action_type='Move' to move deals to a different stage/pipeline (requires new_pipeline_id and new_stage_id), or use action_type='Delete' to delete the stage directly. This action uses the ActiveCampaign DELETE /api/3/dealStages/{id} endpoint with additional logic to safely manage deals.
Inputs: stage_id, action_type, new_stage_id, new_pipeline_id
Delete Deal Task
Permanently deletes a deal task from ActiveCampaign by its ID. Use when you need to remove a task associated with a deal. The deletion is immediate and cannot be undone.
Inputs: id
Delete Event
Tool to delete an event tracking event from ActiveCampaign. Use when you need to remove an event name from the tracking whitelist.
Inputs: event_name
Delete Field Relationship
Tool to delete a field relationship in ActiveCampaign. Use when you need to remove the association between a custom field and a list. This action is irreversible and will permanently remove the field relationship from the system.
Inputs: field_rel_id
Delete Field Value
Tool to permanently delete a custom field value from ActiveCampaign by its ID. Use when you need to remove a specific field value from a contact. This action is irreversible and will remove the field value immediately.
Inputs: id
Delete Form
Tool to permanently delete a form from ActiveCampaign by its ID. Use when you need to remove old or unwanted forms. This action is irreversible and will remove the form and all associated data from the system.
Inputs: id
Delete Group
Tool to permanently delete a permission group from ActiveCampaign by its ID. Use when you need to remove a group that is no longer needed. This action is irreversible and will remove the group from the system.
Inputs: id
Delete List
Permanently deletes a list from ActiveCampaign by its ID. This action is irreversible and will remove the list from the system. Use this when you need to clean up old or unwanted lists. The deletion is immediate and cannot be undone.
Inputs: list_id
Delete Message
Permanently deletes a message from ActiveCampaign by its ID. This action is irreversible and will remove the message from the system. Use this when you need to clean up old or unwanted messages. Returns the deleted message ID upon successful deletion. Raises an error if the message is not found.
Inputs: message_id
Delete Note
Permanently deletes a note from ActiveCampaign by its ID. This action is irreversible and will remove the note and all associated data from the system. Use this when you need to clean up old or unwanted notes. The deletion is immediate and cannot be undone. Returns the deleted note ID upon successful deletion. Raises an error if the note is not found.
Inputs: note_id
Delete Product
Permanently delete a product from ActiveCampaign's e-commerce catalog by its ID. This action removes a product from the catalog using the deleteProduct GraphQL mutation. The deletion is immediate and irreversible. Use this when you need to remove discontinued or unwanted products from your catalog.
Inputs: id
Delete Record by External ID
Permanently deletes a custom object record from ActiveCampaign by its external ID. This action is irreversible and will remove the record from the system. Use this when you need to clean up old or unwanted custom object records using their external identifier. The deletion is immediate and cannot be undone. Returns the deleted record's schema ID and external ID upon successful deletion. Raises an error if the record is not found.
Inputs: schema_id, external_id
Delete Custom Object Record
Permanently deletes a custom object record from ActiveCampaign by its ID and schema ID. This action is irreversible and will remove the record and all associated data from the custom object. Use this when you need to clean up old or unwanted custom object records. The deletion is immediate and cannot be undone. Returns the deleted record ID and schema ID upon successful deletion. Raises an error if the record or schema is not found.
Inputs: record_id, schema_id
Delete Saved Response
Tool to permanently delete a saved response from ActiveCampaign by its ID. Use when you need to remove saved response templates that are no longer needed. The deletion is immediate and cannot be undone.
Inputs: id
Delete Schema
Permanently deletes a custom object schema from ActiveCampaign by its UUID. This action is irreversible and will remove the schema and all associated data. Use with caution as deletion cannot be undone.
Inputs: schema_id
Delete Secondary Contact
Permanently deletes a secondary contact association from a deal in ActiveCampaign. This removes the link between a contact and a deal, but does not delete the contact or deal themselves. Use this when you need to remove a secondary contact from a deal. The deletion is immediate and cannot be undone.
Inputs: id
Delete Segment V2
Tool to permanently delete a segment from ActiveCampaign by its UUID. This operation removes the segment including all its historic versions and cannot be undone. Use when you need to clean up unused or outdated segments. The API returns the segment's final state before deletion as an audit trail.
Inputs: segment_id
Delete Tag
Tool to permanently delete a tag from ActiveCampaign by its ID. Use when you need to remove unused or unwanted tags from the system. This action is irreversible.
Inputs: tag_id
Delete User
Permanently deletes a user from ActiveCampaign by their ID. This action is irreversible and will remove the user account from the system. Use this when you need to remove team members or staff accounts. The deletion is immediate and cannot be undone. Returns the deleted user ID upon successful deletion. Raises an error if the user is not found.
Inputs: user_id
Delete Variable
Permanently deletes a personalization variable from ActiveCampaign by its ID. Use when you need to remove unused or unwanted personalization variables. The deletion is immediate and cannot be undone.
Inputs: variable_id
Bulk Delete Variables
Tool to bulk delete personalization variables in ActiveCampaign. Use when you need to delete multiple personalization variables at once by providing their IDs. The operation will delete existing variables and silently ignore non-existent IDs.
Inputs: ids
Delete Webhook
Permanently deletes a webhook from ActiveCampaign by its ID. Use this when you need to remove a webhook that is no longer needed. The deletion is immediate and cannot be undone.
Inputs: id
Edit Campaign
Edit an existing campaign in ActiveCampaign. Use this to modify campaign properties like the name.
Inputs: id, name
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.
Inputs: id, email, phone
Find Contact Tasks
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.
Inputs: limit, title, offset, status, contact_id
Find User by Email
Find an ActiveCampaign account user (team member/staff) by their email address. Returns user details including username, email, first name, last name, phone, signature, language preference, timezone, MFA status, and related resource links. Note: This finds account users (staff who can log into ActiveCampaign), not contacts (people in your marketing database). To find contacts, use the find contact action instead.
Inputs: email
Get Account Contact Association
Tool to retrieve an existing account-contact association in ActiveCampaign. Use when you need to get details about the relationship between a specific account and contact.
Inputs: id
Get Account Custom Field Data
Retrieves a specific account custom field data record by ID. Use when you need to get the value of a custom field associated with an account.
Inputs: id
Get Account Custom Field Metadata
Retrieve metadata for a specific account custom field by ID. Returns details including field label, type, options, default value, visibility settings, and timestamps.
Inputs: id
Get Address by ID
Retrieves a single address by ID from ActiveCampaign. Use when you need to fetch complete details of a specific address including company name, location fields, and metadata.
Inputs: id
Get All Field Relationships
Get all field relationships in ActiveCampaign. Use this to retrieve custom field associations with lists or other entities. Supports pagination via limit and offset parameters for handling large numbers of field relationships.
Inputs: limit, offset
Get Audience Segment by ID
Retrieve a specific audience segment by ID from ActiveCampaign. Returns detailed information about the segment including its conditions, groups, and metadata. Use this action when you need to inspect the configuration or criteria of a saved segment/audience.
Inputs: id
Get Branding
Tool to retrieve an existing branding resource from ActiveCampaign by its ID. Use when you need to fetch branding configuration details such as site name, logos, templates, and styling information.
Inputs: id
Get Broadcast Metrics Failures
Retrieve grouping and counts of failures for an SMS broadcast in ActiveCampaign. Use when you need to analyze failure patterns for a specific broadcast, with optional date filtering.
Inputs: end_date, start_date, broadcast_id
Get Broadcasts Metrics
Tool to retrieve metrics for specified SMS broadcast IDs in ActiveCampaign. Use when you need detailed performance data including sends, deliveries, replies, failures, opt-outs, and clicks for specific broadcasts.
Inputs: ids
Get Broadcast Recipients
Fetch all contacts who were sent a specific SMS broadcast in ActiveCampaign. Returns recipient details including delivery status, engagement metrics, and replies.
Inputs: limit, offset, search, end_date, start_date, broadcastId, order_field, filters_engagement, filters_deliverability
Get Bulk Import Status Info
Tool to retrieve the status of a specific bulk import in ActiveCampaign. Use when you need to check the progress and results of a bulk contact import, including newly created contact IDs and any failed email addresses.
Inputs: batch_id
Get Calendar Feed
Tool to retrieve a specific calendar feed from ActiveCampaign by its ID. Returns calendar details including title, type, token, notification settings, and creation/modification dates.
Inputs: id
Get Campaign Automation Campaign Lists
Tool to retrieve all lists associated with a specific campaign automation in ActiveCampaign. Use when you need to see which lists a campaign is configured to send to.
Inputs: campaign_id
Get Campaign Automations
Get automation information associated with a specific campaign in ActiveCampaign. This action retrieves automation details linked to a campaign ID.
Inputs: campaign_id
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.
Inputs: id
Get Campaign Links
Get all links associated with a specific campaign in ActiveCampaign. Use when you need to retrieve tracking links, read trackers, and other URLs associated with a campaign.
Inputs: campaign_id
Get Campaign Message
Get the message associated with a specific campaign in ActiveCampaign. Returns message details including subject, content (HTML and text), sender information, and configuration settings.
Inputs: campaign_id
Get Campaign Messages
Get campaign messages associated with a specific campaign in ActiveCampaign. Returns an array of message objects linked to the campaign ID.
Inputs: campaign_id
Get Campaign User
Get the user (account owner/staff member) associated with a specific campaign in ActiveCampaign. Returns user details including username, email, name, phone, and other account information.
Inputs: campaign_id
Get Contact Account Contacts
Retrieve all account-contact associations for a specific contact in ActiveCampaign. Use this action when you need to see which accounts a contact is associated with and their role at each account.
Inputs: contact_id
Get Contact Automation Entry Counts
Tool to retrieve the number of times a contact has entered each automation. Use when you need to understand a contact's automation engagement history.
Inputs: contact_id
Get Contact Automations
Retrieve all automations that a specific contact is enrolled in or has been enrolled in. Returns automation enrollment details including status, progress, and completion information.
Inputs: contact_id
Get contact data
Retrieve detailed data for a specific contact in ActiveCampaign. Use when you need to access a contact's geographic information, social media IDs, Google Analytics data, and tracking timestamps.
Inputs: contact_id
Get Contact Goals
Retrieve a contact's goals from ActiveCampaign. Use when you need to access goal completion data, automation goals, and goal tracking information for a specific contact.
Inputs: contact_id
Get Contact Deals
Tool to retrieve all deals associated with a specific contact in ActiveCampaign. Use when you need to see all deals linked to a particular contact, including deal details like value, stage, status, and associated metadata.
Inputs: contact_id
Get Contact Events and Activities
Tool to retrieve contact events and activities from ActiveCampaign. Use when you need to view the activity history for a specific contact or all contacts, including deal-related activities and general activities. Returns paginated results with limit and offset parameters.
Inputs: limit, offset, contact
Get Contact Field Values
Tool to retrieve all custom field values for a specific contact in ActiveCampaign. Use when you need to access a contact's custom field data such as custom text fields, dropdown selections, or other custom attributes.
Inputs: contact_id
Get Contact Geo IPs List
Retrieve all geo IP addresses associated with a specific contact in ActiveCampaign. Use when you need to view the geographic locations from which a contact has interacted with your campaigns.
Inputs: contact_id
Get Contact Lists
Tool to retrieve all list memberships for a specific contact in ActiveCampaign. Use when you need to see which lists a contact is subscribed to and their subscription details.
Inputs: contact_id
Get Contact Logs
Tool to retrieve logs for a specific contact in ActiveCampaign. Use when you need to access a contact's activity history, including subscription changes, campaign interactions, and automation events.
Inputs: contact_id
Get contact notes
Retrieve all existing notes associated with a specific contact in ActiveCampaign. Use when you need to view all notes that have been added to a contact's record.
Inputs: contact_id
Get Contact Organization
Tool to retrieve organization information associated with a specific contact in ActiveCampaign. Use when you need to get details about the organization that a contact belongs to.
Inputs: contact_id
Get Contact Plus Append
Tool to retrieve a contact's plus append enrichment data from ActiveCampaign. Use when you need to access enriched contact information including social media profiles, profile images, and demographic data from services like FullContact, Rapleaf, and Fliptop.
Inputs: contact_id
Get Contact Score Values
Tool to retrieve all score values associated with a specific contact in ActiveCampaign. Use when you need to see scoring data for a contact.
Inputs: contact_id
Get Contact Tags
Tool to retrieve all tags associated with a specific contact in ActiveCampaign. Use when you need to see which tags are applied to a contact.
Inputs: contact_id
Get contact tracking logs
Retrieve tracking logs for a specific contact in ActiveCampaign. Use when you need to view all tracking events such as page views, link clicks, and file downloads associated with a contact.
Inputs: contact_id
Get Custom Field
Retrieve a specific custom field by ID from ActiveCampaign. Returns field metadata including title, type, options, relationships, and configuration settings. Use when you need detailed information about a custom contact field.
Inputs: id
Get Deal Custom Field Data
Retrieves a specific deal custom field data record by ID. Use when you need to get the value of a custom field associated with a deal.
Inputs: id
Get Deal Custom Field Metadata
Retrieve metadata for a specific deal custom field by ID. Returns details including field label, type, options, default value, visibility settings, and timestamps. Requires deal management permission.
Inputs: id
Get Deal Pipeline
Tool to retrieve an existing pipeline (deal group) from ActiveCampaign by its ID. Use when you need to get details about a specific pipeline including its name, currency, stages, and configuration settings.
Inputs: id
Get Deal Stage
Tool to retrieve an existing deal stage from ActiveCampaign by its ID. Use when you need to get detailed information about a specific stage including its title, color, order, and card region configurations.
Inputs: id
Get Deal Task
Tool to retrieve an existing task in ActiveCampaign by its ID. Use when you need to get detailed information about a specific task including its title, status, due date, assignee, and related contact or deal information.
Inputs: id
Get Deal Task Type
Tool to retrieve an existing deal task type in ActiveCampaign by its ID. Use when you need to get details about a specific task type configuration.
Inputs: id
Get Event Tracking Status
Tool to retrieve the event tracking status for your ActiveCampaign account. Use this to check whether event tracking is enabled or disabled.
Get Field Value
Tool to retrieve a specific field value by its ID in ActiveCampaign. Use when you need to get detailed information about a particular custom field value including its contact, field, value, and timestamps.
Inputs: id
Get Form
Retrieve a single form by its ID from ActiveCampaign. Returns comprehensive form details including field configuration, styling, submission behavior, and metadata.
Inputs: id
Get Group By ID
Retrieve a specific group by ID in ActiveCampaign. Use this to get detailed information about a single group including its title, description, settings, and associated resource links.
Inputs: group_id
Get Group Limits
Tool to retrieve group limits configured for different groups in ActiveCampaign account. Use when you need to check limits for emails, contacts, lists, campaigns, users, and other resources per group.
Get Lists
Tool to retrieve all mailing lists in ActiveCampaign. Use when you need to fetch list IDs or list information for subscription management.
Inputs: limit, offset, filters_name
Get Logged-In User
Retrieve information about the currently authenticated user (the user whose API token is being used). Use when you need to identify the current user or access their account details.
Get Note
Tool to retrieve a specific note from ActiveCampaign by its ID. Use when you need to get details about a particular note including its content, creation date, and related entity.
Inputs: id
Get Order from ActiveCampaign
Retrieve a single order from ActiveCampaign by legacy connection ID and store order ID. Use this to fetch complete order details including customer information, line items, addresses, and order status.
Inputs: store_order_id, legacy_connection_id
Get Product By ID
Retrieve a single product by its ID from ActiveCampaign's e-commerce catalog. Use when you need to fetch detailed information about a specific product, including its name, SKU, pricing, and description.
Inputs: id
Get Recent Segment Counts
Retrieve the most recent result count for segments that were run without additional criteria. Use when you need to check segment sizes or monitor segment growth over time.
Inputs: segment_ids
Get Record by External ID
Tool to retrieve a custom object record from ActiveCampaign by its external ID. Use when you need to get detailed information about a specific custom object record using its external identifier.
Inputs: schema_id, external_id
Get Custom Object Record By ID
Tool to retrieve a custom object record from ActiveCampaign by schema ID and record ID. Use when you need to get detailed information about a specific custom object record including its fields, values, and timestamps.
Inputs: record_id, schema_id
Get Saved Response
Tool to retrieve a specific saved response from ActiveCampaign by its ID. Use when you need to fetch details of a saved response including title, subject, and body content.
Inputs: id
Get Schema by ID
Retrieve a specific custom object schema by ID in ActiveCampaign. Use this to get detailed information about a schema including its fields, relationships, and metadata. Optionally include deleted fields by setting show_fields to 'all'.
Inputs: schema_id, show_fields
Get Secondary Contact
Tool to retrieve a specific secondary contact (contact-deal association) by ID in ActiveCampaign. Use when you need to get details about a particular secondary contact associated with a deal.
Inputs: id
Get Segment Count by Timestamp
Tool to retrieve all result counts for a segment that were run without an AdditionalCriteria. Use when you need to access historical segment count data before a specific timestamp. Returns up to 50 segment count history records.
Inputs: timestamp, segment_id
Get Segment Count History
Tool to retrieve all historical result counts for a given segment that were run without additional criteria. Use when you need to track segment size changes over time or audit segment evaluation history. Returns up to 50 results with data available for the past 90 days.
Inputs: segment_id
Get Segment Match
Retrieve segment match evaluation for a contact in ActiveCampaign. Use this to determine if a specific contact matches the criteria of a given segment.
Inputs: contact_id, segment_id
Get Segment Match-All Result Set
Tool to retrieve segment match-all result set by ID. Use when you need to check the status and results of a segment match-all request. The is_ready attribute indicates if results are complete (true) or still processing (false). If is_ready is false and run_id_end is populated, the request has errored.
Inputs: page, sort, run_id, page_size, segment_id
Get Segment Match by External ID
Check if a contact matches a segment using segment ID, contact ID, and external ID. Use when you need to verify if a specific contact belongs to a segment and get match evaluation details.
Inputs: contact_id, segment_id, external_id
Get Segment Match Result
Tool to retrieve segment match result set by run ID in ActiveCampaign. Use when you need to fetch the results of a segment evaluation request, including which contacts match the segment criteria. The is_ready field indicates if results are available.
Inputs: page, run_id, page_size, segment_id
Get Segment V2
Tool to retrieve a specific segment by its ID in ActiveCampaign. Use when you need detailed information about a segment including its conditions, groups, and metadata.
Inputs: segment_id
Get Historic Segment by Timestamp
Tool to retrieve a segment as it existed at a given point in time in ActiveCampaign. Use when you need to access the historical state of a segment definition. Only supports segments with non-numeric segment IDs.
Inputs: timestamp, segment_id
Get Site Tracking Code
Tool to retrieve the site tracking JavaScript code for your ActiveCampaign account. Use when you need to get the tracking code snippet to embed on your website for visitor tracking and behavior monitoring. The returned code enables site tracking features like page view tracking, visitor identification, and site-based automation triggers.
Get Site Tracking Status
Tool to retrieve the site tracking status for your ActiveCampaign account. Use this to check whether site tracking is enabled or disabled.
Get SMS Broadcast Metrics Snapshot
Tool to retrieve snapshot data for all SMS broadcasts in ActiveCampaign. Use when you need aggregate metrics including campaigns, sends, deliveries, clicks, replies, failures, and opt-outs.
Inputs: end_date, start_date
Get SMS Credits
Tool to retrieve the current period's SMS credit usage and remaining balance. Use when you need to check how many SMS credits are available, used, or included in the billing cycle.
Get Tag
Tool to retrieve a tag from ActiveCampaign by its ID. Use when you need to get detailed information about a specific tag including its name, type, description, and subscriber count.
Inputs: id
Get Task Outcome
Tool to retrieve a specific task outcome from ActiveCampaign by its ID. Use when you need to get details about a task outcome including its title, sentiment, and associated deal task types.
Inputs: id
Get Template
Retrieve a single template by its ID from ActiveCampaign. Returns comprehensive template details including content, subject, and configuration settings.
Inputs: id
Get User by ID
Tool to retrieve a specific ActiveCampaign account user (team member/staff) by their ID. Use when you need to get detailed information about a specific user including username, email, name, phone, signature, language, timezone, and MFA status.
Inputs: user_id
Get User by Username
Tool to retrieve an ActiveCampaign account user (team member/staff) by their username. Use when you need to get detailed information about a specific user by username.
Inputs: username
Get Users
Tool to retrieve all ActiveCampaign account users (team members/staff). Use when you need to list all users in the account with pagination and sorting options.
Inputs: limit, offset, orders
Get Users By Group
Tool to retrieve all users associated with a specific group in ActiveCampaign. Use when you need to get the list of users who belong to a particular group.
Inputs: group_id
Get Variable
Tool to retrieve a personalization variable from ActiveCampaign by its ID. Use when you need to get details about a specific variable including its name, tag, content, format, and associated lists.
Inputs: variable_id
Get Personalization Variables
Tool to retrieve personalization variables from ActiveCampaign. Use when you need to list or search for custom variables that can be used for personalization in campaigns and automations.
Inputs: limit, offset
Get Webhook
Retrieve an existing webhook by ID from ActiveCampaign. Use this when you need to get detailed information about a specific webhook including its URL, events, sources, and current state.
Inputs: id
List Account Contact Associations
Tool to retrieve all existing account-contact associations in ActiveCampaign. Use when you need to list relationships between accounts and contacts, with optional filters.
Inputs: limit, offset, filters_account, filters_contact
List Account Custom Field Data
Tool to list all custom field values for accounts in ActiveCampaign. Use when you need to retrieve account custom field data including field IDs, values, account associations, and timestamps.
Inputs: limit
List Account Custom Field Metadata
Tool to list all account custom field metadata in ActiveCampaign. Use when you need to retrieve information about custom fields available for accounts, including field types, labels, options, and validation requirements.
Inputs: limit, offset
List Addresses
Tool to list all addresses in the ActiveCampaign account. Use when you need to retrieve all configured addresses. Returns an array of address objects with company name, address details, and metadata.
List All Accounts
Tool to list all accounts in ActiveCampaign. Use when you need to retrieve all existing accounts, optionally filtered by name search. Can include contact and deal counts for each account.
Inputs: limit, offset, search, count_deals
List all contacts
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
Inputs: limit, tagid, listid, orders, search, filters, id_less, segmentid, email_like, id_greater
List All Custom Fields (with pagination)
Tool to list all custom fields in ActiveCampaign with pagination support. Use when you need to retrieve information about custom fields with control over the number of results returned per request.
Inputs: limit, offset
List All Custom Field Values
Tool to list all custom field values in ActiveCampaign. Use when you need to retrieve all custom field values across all contacts including field IDs, values, contact associations, and timestamps.
Inputs: limit
List All Event Tracking Events
Tool to list all whitelisted event tracking events in ActiveCampaign. Use when you need to retrieve the names of all events that are whitelisted for tracking and can be used in automations.
List All Schemas
Tool to list all custom object schemas in ActiveCampaign. Use when you need to retrieve all schema definitions including their fields, relationships, and metadata.
Inputs: showFields
List All Tags
Tool to retrieve all tags in ActiveCampaign with search functionality. Use when you need to list or search for tags.
Inputs: limit, offset, search
List All Whitelisted Domains
Tool to list all whitelisted domains for site tracking in ActiveCampaign. Use when you need to retrieve all domains that are allowed for site tracking.
List Audiences
Retrieve all saved segment summaries (audiences) from ActiveCampaign. Returns a list of all saved segments with their configurations, conditions, and metadata.
Inputs: page, page_size
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.
Inputs: limit, offset
List Bulk Import Status
Tool to monitor bulk import progress in ActiveCampaign. Use this after sending bulk data via POST endpoint to track the status of outstanding and recently completed batches. Requires the batchId returned from the bulk import POST request.
Inputs: batchId
List Bulk Import Status Aggregate
Tool to retrieve aggregate progress data for all bulk import jobs in ActiveCampaign. Returns daily summaries of outstanding and recently completed batch jobs in a rolling 7-day window. Use this to monitor overall bulk import progress across all batches without needing a specific batch ID.
List All Calendar Feeds
Tool to list all calendar feeds in ActiveCampaign. Use when you need to retrieve all available calendar feeds for the account.
List Campaigns
Tool to list all campaigns in ActiveCampaign. Use when you need to retrieve campaign information including standard campaigns and automation campaigns.
Inputs: limit, offset, orders, filters
List Contact Automations
List all automations that contacts are enrolled in. Returns enrollment details including status, dates, and progress for each contact-automation pair.
Inputs: limit, offset
List All Secondary Contacts
Tool to retrieve all secondary contacts (contact-deal associations) in ActiveCampaign. Use when you need to list all additional contacts associated with deals, beyond the primary contacts.
Inputs: limit, offset
List All Deal Activities
Tool to retrieve all recent activities for deals in ActiveCampaign. Use when you need to view activity history across deals, including notes, tasks, and other interactions.
Inputs: limit, offset
List Deal Custom Field Data
Tool to list all custom field values for deals in ActiveCampaign. Use when you need to retrieve deal custom field data including field IDs, values, deal associations, and timestamps.
Inputs: limit, offset
List Deal Custom Field Metadata
Tool to list all deal custom field metadata in ActiveCampaign. Use when you need to retrieve information about custom fields available for deals, including field types, labels, options, and validation requirements. Requires deal management permissions.
Inputs: limit, offset
List Deal Pipelines
Tool to retrieve all existing deal pipelines from ActiveCampaign. Use when you need to list all pipelines in the account or filter pipelines by title.
Inputs: limit, offset, filters_title
List All Deal Roles
Tool to retrieve all deal roles in ActiveCampaign. Use when you need to view available deal roles that can be assigned to contacts in deals.
List All Deals (Search & Filter)
Tool to 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.
Inputs: limit, offset, filters_group, filters_owner, filters_stage, filters_search, filters_status
List Deal Stages
Tool to list all deal stages (pipeline stages) in ActiveCampaign. Use when you need to retrieve stage information for mapping stage titles to stage IDs before updating or moving deals. Optionally filter by pipeline/group ID or stage title.
Inputs: limit, title, offset, pipeline_id
List All Deal Task Types
Tool to retrieve all existing task types for deals in ActiveCampaign. Use when you need to view available task type categories that can be assigned to deal tasks.
List Email Activities
Tool to list all email activities in ActiveCampaign. Use when you need to retrieve email activity records for a specific subscriber or deal. At least one filter parameter (subscriber ID or deal ID) should be provided for optimal performance.
Inputs: limit, offset, filters_dealId, filters_subscriberid
List Forms
Tool to list all forms in ActiveCampaign. Use when you need to retrieve form information including form configurations, fields, and styling.
Inputs: limit, offset
List All Group Members
Tool to list all group members in ActiveCampaign. Use when you need to retrieve the relationships between custom fields and field groups. Group members link custom fields to their display groups.
Inputs: limit, offset
List Groups
Tool to retrieve all permission groups from ActiveCampaign. Use when you need to list user groups with their permission settings. Supports pagination via limit and offset parameters.
Inputs: limit, offset
List Messages
Tool to list all messages in ActiveCampaign. Use when you need to retrieve message information including email content, sender details, and metadata.
Inputs: limit, tagid, formid, listid, offset, search, waitid, seriesid, segmentid
List all notes
Retrieve a list of all notes in ActiveCampaign. Use when you need to view all notes across all contacts and activities in the account.
Inputs: limit, offset
List Order Products
Tool to list all e-commerce order products in ActiveCampaign. Use when you need to retrieve all order products with pagination support.
Inputs: limit, offset
List Prism URL Whitelistings
Tool to list all whitelisted site tracking domains in ActiveCampaign. Use when you need to retrieve domains that are allowed for site tracking.
List Records for Schema
Tool to list custom object records for a specific schema in ActiveCampaign. Use when you need to retrieve records created from a custom object schema. Note: Non-admin users must provide a filter parameter for contact, account, or deal.
Inputs: limit, offset, filters, schema_id
List Saved Responses
Tool to list all saved responses in ActiveCampaign. Use when you need to retrieve saved response templates for one-off personal emails.
Inputs: limit, offset
List All Scores
Tool to list all scoring rules configured in ActiveCampaign. Use when you need to retrieve all available scores for contacts or deals.
List Segment Match All Contacts
Initiate a match-all request for contacts in a segment. If results are not ready within 4 seconds, returns immediately with is_ready=False and a run_id. Use when you need to retrieve all contacts that match a specific segment's criteria, especially for large segments where immediate results may not be available.
Inputs: page, sort, instant, page_size, segment_id
List SMS Broadcast Lists
Tool to retrieve a paged list of all SMS broadcast lists in ActiveCampaign. Use when you need to view available SMS broadcast lists, optionally filtered by name.
Inputs: limit, offset, filters_name
List SMS Broadcasts
Tool to list all SMS broadcasts in ActiveCampaign with optional filtering and pagination. Use when you need to retrieve broadcast messages, check their status, or search for specific broadcasts by name or date range.
Inputs: limit, offset, end_date, start_date, filters_name, filters_type, orders_field, filters_status, orders_direction
List Task Outcomes
Tool to retrieve all existing task outcomes from ActiveCampaign. Use when you need to list all available task outcome options that can be assigned to tasks.
List Webhook Events
List all available webhook events in ActiveCampaign. Use this action when you need to discover what webhook events are available for subscription.
List Webhooks
Tool to list all existing webhooks in ActiveCampaign. Use when you need to retrieve all configured webhooks including their names, URLs, events, and sources.
Lock Personalization Variable
Tool to lock a personalization variable in ActiveCampaign. Use when you need to prevent modifications to a personalization variable. Once locked, the variable cannot be edited.
Inputs: id
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.
Inputs: tags, action, contact_id, contact_email
Remove Contact from Automation
Removes a contact from a specified automation in ActiveCampaign. This action looks up the contact by their email address to get their ID, then removes them from the specified automation. A contact can be enrolled in the same automation multiple times (different runs), and you can choose to remove them from all runs or just the most recent run using the run_remove_option parameter. Use this when you need to unenroll a contact from an automation workflow they're currently enrolled in. This is a destructive operation that cannot be undone. Technical details: Uses /api/3/contacts to find the contact, /api/3/contactAutomations to list their enrollments, and DELETE /api/3/contactAutomations/{id} to remove each enrollment.
Inputs: automation_id, contact_email, run_remove_option
Remove Domain from Whitelist
Remove a domain from ActiveCampaign's URL whitelist. Use this to revoke site tracking access for a specific domain that was previously whitelisted.
Inputs: domain_id
Remove Tag from Contact
Tool to remove a tag from a contact in ActiveCampaign. Use when you need to disassociate a tag from a contact. Requires the contactTag ID (the relationship ID, not the tag ID itself).
Inputs: tag_id
Retrieve Account
Tool to retrieve an account from ActiveCampaign by its ID. Use when you need to get detailed information about a specific account including its name, URL, timestamps, and custom fields.
Inputs: id
Retrieve a Deal
Tool to retrieve a specific deal by its ID in ActiveCampaign. Use when you need detailed information about a single deal including its title, value, stage, status, and associated contacts or organizations.
Inputs: id
Retrieve All Connections
Tool to retrieve all Deep Data connection resources in ActiveCampaign. Use when you need to list connections between the ActiveCampaign account and external services like Shopify or other e-commerce platforms.
Retrieve All E-Commerce Customers
Tool to retrieve all e-commerce customer resources from ActiveCampaign. Use when you need to list customers from external e-commerce services like Shopify, including aggregated metrics such as total revenue, orders, and products.
Inputs: limit, offset
Retrieve All Deals
Tool to retrieve all deals from ActiveCampaign with filtering and pagination support. Use when you need to list deals, optionally filtered by stage, contact, organization, status, or value range.
Inputs: limit, offset, orders, filters
Retrieve All E-Commerce Orders
Tool to retrieve all e-commerce orders from ActiveCampaign with pagination support. Use when you need to list orders from external e-commerce platforms like Shopify, including order details such as total price, products, and customer information.
Inputs: limit, offset
Retrieve All Products for Order
Tool to retrieve all products associated with a specific e-commerce order in ActiveCampaign. Use when you need to list all products that belong to a particular order.
Inputs: order_id
Retrieve An Order
Tool to retrieve an e-commerce order from ActiveCampaign by its ID. Use when you need to get detailed information about a specific order including customer, pricing, products, and order status.
Inputs: ecom_order_id
Retrieve an Order Product
Tool to retrieve an ecommerce order product from ActiveCampaign by its ID. Use when you need to get detailed information about a specific order product including SKU, price, quantity, and related order details.
Inputs: productId
Retrieve Connection
Tool to retrieve a connection from ActiveCampaign by its ID. Use when you need to get detailed information about a specific connection including service type, status, and synchronization details.
Inputs: id
Retrieve Customer
Tool to retrieve an e-commerce customer from ActiveCampaign by their ID. Use when you need to get detailed information about a specific customer including email, revenue, order statistics, and connection details.
Inputs: customer_id
Retrieve Deal Activities
Tool to retrieve all activities associated with a deal in ActiveCampaign. Use when you need to track changes, interactions, and history for a specific deal including contact additions, notes, stage changes, and custom field updates.
Inputs: id, limit, offset
Retrieve List
Tool to retrieve a specific list from ActiveCampaign by its ID. Use when you need to get detailed information about a list including its name, description, tracking settings, and configuration.
Inputs: id
Retrieve Message
Tool to retrieve a specific message by its ID in ActiveCampaign. Use when you need detailed information about a single message including its subject, content (HTML and text), sender information, and configuration settings.
Inputs: id
Save Browse Session
Create a browse session in ActiveCampaign for testing purposes. Use this to simulate customer browsing behavior in a specified state. This action creates a new browse session with the specified status, products, and metadata. It is intended for testing and development purposes only, not for production integrations. The action will always create a new session rather than updating an existing one. Note that sessions created in an ABANDONED state will NOT generate Browse Abandonment custom objects.
Inputs: email, products, to_abandon_date, normalized_status, legacy_connection_id
Search Browse Sessions
Search for browse sessions matching specified criteria in ActiveCampaign. Use when you need to find browse sessions for a specific contact, connection, and status combination.
Inputs: email, normalized_status, legacy_connection_id
Search Products
Search for products using filter criteria in ActiveCampaign's e-commerce catalog. Use when you need to find products by name, status, or other attributes with pagination support.
Inputs: limit, offset, status_sort, status_value, base_product_name_sort, status_filter_operator, base_product_name_value, base_product_name_filter_operator
Search Recurring Payments
Search for recurring payment records based on filter criteria. Use when you need to find subscription payments by email, status, connection, or other attributes.
Inputs: filter
Test Tracking Event
Simulate a tracking event coming into the Browse Session system with debug output for testing URL patterns. This action allows you to test how ActiveCampaign's Browse Session system will process tracking events and identify products from URLs. It's useful for validating URL patterns and understanding how browsing events will be handled before implementing live tracking.
Inputs: url, email, event_date
Track Event in ActiveCampaign
Track custom events for contacts in ActiveCampaign to trigger automations and monitor user engagement. This action records specific user actions (e.g., file downloads, button clicks, logins) for existing contacts. Events can be used to trigger automation workflows in ActiveCampaign. Prerequisites: - Event Tracking must be enabled in ActiveCampaign (Settings > Tracking > Site Tracking) - The contact must already exist in ActiveCampaign - Event names should be whitelisted in ActiveCampaign for automation usage Use cases: - Track user behavior on your website or application - Trigger targeted email campaigns based on user actions - Monitor engagement and build user profiles - Create conditional automation workflows
Inputs: event_key, event_name, event_actid, event_value, event_contact_email
Unlock Personalization Variable
Tool to unlock a personalization variable in ActiveCampaign. Use when you need to allow modifications to a personalization variable. Once unlocked, the variable can be edited.
Inputs: id
Update Account
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.
Inputs: name, owner, fields, accountUrl, account_id
Update Account Contact Association
Tool to update an existing account-contact association in ActiveCampaign. Use when you need to modify the relationship between an account and contact, such as updating the contact's job title at that account.
Inputs: id, account, contact, jobTitle
Update Account Custom Field Data
Updates a custom account field value in ActiveCampaign. Use when you need to modify an existing custom field value for an account. Requires account permission to manage accounts.
Inputs: id, fieldValue, customFieldId, fieldCurrency, customerAccountId
Bulk Update Account Custom Field Data
Tool to bulk update multiple custom account field values in a single request. Use when you need to update existing accountCustomFieldData records by their IDs with new field values. This is more efficient than making individual update requests when modifying multiple field values.
Inputs: updates
Update Account Custom Field Metadata
Update metadata for an account custom field. Allows modification of field label, options, default value, visibility, and display order.
Inputs: id, fieldLabel, displayOrder, fieldDefault, fieldOptions, isFormVisible
Update Account Note
Tool to update an existing account note in ActiveCampaign. Use when you need to modify the content of an existing note attached to a specific account. The note will be updated for the account specified by the account ID and note ID.
Inputs: id, note, note_id
Update Address
Tool to update an existing address in ActiveCampaign. Use when you need to modify address details such as company name, street address, city, state, zip code, or country for an existing address record.
Inputs: id, address
Update a Deal
Tool to update an existing deal in ActiveCampaign. Use when you need to modify deal properties such as title, value, stage, or status.
Inputs: id, group, owner, stage, title, value, status, account, contact, percent, currency, description
Update a Deal Note
Tool to update an existing note for a specific deal in ActiveCampaign. Use when you need to modify the content of an existing note attached to a deal record.
Inputs: note, deal_id, note_id
Update An Order
Tool to update an existing e-commerce order in ActiveCampaign. Use when you need to modify order details such as pricing, shipping, or customer information.
Inputs: email, source, currency, orderUrl, orderDate, taxAmount, customerid, externalid, totalPrice, ecomOrderId, orderNumber, connectionid, abandonedDate, discountAmount, shippingAmount, shippingMethod, externalcheckoutid, externalCreatedDate, externalUpdatedDate
Update a Tag
Tool to update an existing tag in ActiveCampaign. Use when you need to modify a tag's name, type, or description. Requires the tag ID and at least the tag name and type.
Inputs: tag, tag_id, tag_type, description
Update Branding
Tool to update an existing branding resource in ActiveCampaign. Use when you need to modify branding configuration such as site name, logos, templates, styling, or other branding-related settings.
Inputs: id, help, favicon, groupid, license, version, siteLogo, siteName, copyright, siteLogoSmall, footerHtmlValue, footerTextValue, headerHtmlValue, headerTextValue, adminTemplateCss, adminTemplateHtm, publicTemplateCss, publicTemplateHtm
Update Calendar Feed
Tool to update an existing calendar feed in ActiveCampaign. Use when you need to modify calendar properties like title, type, or notification settings.
Inputs: id, type, title, notification
Update Configuration
Tool to update an existing configuration in ActiveCampaign. Use when you need to modify configuration settings like pagination preferences or onboarding states for users.
Inputs: config, config_id
Update Connection
Tool to update an existing connection in ActiveCampaign. Use when you need to modify connection details such as service name, external ID, display name, logo URL, or link URL.
Inputs: name, linkUrl, logoUrl, service, externalid, connection_id
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.
Inputs: id, email, phone, lastName, firstName
Update Secondary Contact
Tool to update an existing secondary contact (contact-deal association) in ActiveCampaign. Use when you need to modify the contact, deal, or role assignment for a secondary contact.
Inputs: id, deal, role, contact
Update Customer
Tool to update an existing e-commerce customer in ActiveCampaign. Use when you need to modify customer details such as email, external ID, connection ID, or marketing preferences.
Inputs: email, externalid, customer_id, connectionid, acceptsMarketing
Update Custom Field
Tool to update an existing custom field in ActiveCampaign. Use when you need to modify field properties such as label, type, options, default value, visibility, or display order.
Inputs: fieldId, fieldType, fieldLabel, isRequired, displayOrder, fieldDefault, fieldOptions, isFormVisible, fieldDefaultCurrency
Update Custom Field Field Group
Tool to update a custom field field group member in ActiveCampaign. Use when you need to change the display order or group association of a custom field within a field group.
Inputs: rel_id, group_id, ordernum, group_member_id
Update Custom Field Value For Contact
Tool to update a custom field value for a contact in ActiveCampaign. Use when you need to set or modify a specific custom field's value for a given contact, such as updating subscription tier, preferences, or custom data.
Inputs: field, value, contact, fieldCurrency, field_value_id
Update Deal Custom Field Data
Updates a custom deal field value in ActiveCampaign. Use when you need to modify an existing custom field value for a deal. Requires deal permission and pipeline-specific permission.
Inputs: id, fieldValue, fieldCurrency
Update Deal Custom Field Metadata
Updates a custom deal field metadata in ActiveCampaign. Use when you need to modify the definition of a custom field (label, options, default value, visibility, display order). Requires deal management permission and pipeline-specific permission.
Inputs: id, fieldLabel, displayOrder, fieldDefault, fieldOptions, isFormVisible
Update Deal Pipeline
Tool to update an existing pipeline (deal group) in ActiveCampaign. Use when you need to modify pipeline properties such as the title, currency, or permission settings. Only the fields provided in the dealGroup object will be updated; other fields remain unchanged.
Inputs: id, dealGroup
Bulk Update Deal Owners
Tool to bulk update deal owners in ActiveCampaign. Use when you need to reassign multiple deals to new owners in a single API call. Requires deal management permissions, pipeline-specific permissions, and deal reassign permission.
Inputs: deals
Update Deal Stage
Tool to update an existing stage in an ActiveCampaign deal pipeline. Use when you need to modify a stage's title, move it to a different pipeline, or change its display order.
Inputs: id, title, pipeline, displayOrder
Update Deal Stage Deals
Tool to move all deals from one stage to another stage in ActiveCampaign. Use when you need to bulk-move all deals in a specific stage to a different stage within the same pipeline. The source and target stages must belong to the same pipeline, otherwise a 422 error will be returned.
Inputs: id, deal
Update Deal Task
Tool to update an existing task in ActiveCampaign. Use when you need to modify task details such as title, description, due date, assignee, status, or associated records (deal, contact, account).
Inputs: id, deal, note, owner, title, account, contact, duedate, tasktype, dealTaskStatus
Update Deal Task Type
Tool to update an existing deal task type in ActiveCampaign. Use when you need to modify the title or status of a task type used for categorizing deal tasks.
Inputs: id, title, status
Update Edit Variable
Tool to edit an existing personalization variable in ActiveCampaign. Use when you need to update the name, tag, content, format, or associated lists of a variable.
Inputs: variable_id, personalization
Update Event Tracking Status
Tool to enable or disable event tracking for your ActiveCampaign account. Use this to toggle event tracking on or off based on your tracking requirements.
Inputs: eventTracking
Update Field Value
Tool to update a custom field value by its field value ID in ActiveCampaign. Use when you need to modify an existing field value record directly. Datetime field values are converted to the account's timezone when saved.
Inputs: id, field, value, contact, currency
Update Group
Tool to update an existing permission group in ActiveCampaign. Use when you need to modify a group's title or description.
Inputs: id, title, descript
Update Message
Tool to update an existing message in ActiveCampaign. Use when you need to modify message properties such as subject line, sender information, content, or other email configuration settings.
Inputs: id, html, name, text, format, reply2, charset, subject, encoding, fromname, priority, fromemail, preheader_text
Update Note
Tool to update an existing note in ActiveCampaign by its ID. Use when you need to modify the content of any existing note. This is a generic note update tool that works for notes related to contacts, deals, or accounts.
Inputs: id, note
Update Product
Tool to update an existing product in ActiveCampaign's e-commerce system using GraphQL. Use when you need to modify product details like name, store ID, or connection association.
Inputs: id, product
Update Saved Response
Tool to update an existing saved response in ActiveCampaign. Use when you need to modify the title, subject, or body of a saved response template.
Inputs: id, savedResponse
Update Schema
Tool to update a custom object schema in ActiveCampaign. Use when you need to modify schema properties or add new options to dropdown/multi-select fields. Note: For child schemas, you can only add new options to existing dropdown/multi-select fields.
Inputs: schema, schema_id
Update Segment V2
Tool to update existing segments in ActiveCampaign using the V2 segments API. Use when you need to modify segment configurations, including filtering conditions, descriptions, or metadata. The segment ID must be in UUID format (e.g., 'f0390c20-ce33-46ae-8c19-468f770fd1f7'), not numeric format.
Inputs: data, segment_id
Revert Segment to Historic State
Tool to revert a segment to how it looked at a specific point in time in ActiveCampaign. Use when you need to restore a segment to a previous state using a historic timestamp. Only segments with non-numeric segment IDs are supported.
Inputs: segment, timestamp, segment_id
Update Site Tracking Status
Tool to enable or disable site tracking for your ActiveCampaign account. Use this when you need to toggle site tracking functionality on or off.
Inputs: enabled
Update User
Tool to update an existing ActiveCampaign user (team member/staff account) by ID. Use when you need to modify user details such as name, email, phone, username, or group assignment. Group assignment is required.
Inputs: email, group, phone, user_id, lastName, username, firstName
Update Webhook
Update an existing webhook in ActiveCampaign to modify its configuration such as URL, events, or sources. Use this when you need to change the settings of an already created webhook.
Inputs: id, url, name, events, actions, sources, externalid
Upsert Account
Creates a new account or updates an existing one in ActiveCampaign based on the account name. This action searches for an account by name and either: - Updates the existing account if found (modifies URL, owner, and custom fields) - Creates a new account if not found Use this when you want to ensure an account exists with specific properties without worrying about duplicate creation. The account name is used as the unique identifier for matching existing accounts.
Inputs: name, owner, fields, accountUrl
Upsert Order
Create a new order or update an existing order in ActiveCampaign. Existence is determined by the combination of legacyConnectionId and storeOrderId. Use this to sync order data from your e-commerce platform.
Inputs: email, notes, cart_id, currency, order_url, location_id, final_amount, order_number, store_status, is_test_order, sales_channel, store_order_id, creation_source, customer_locale, shipping_amount, shipping_method, accepts_marketing, normalized_status, store_customer_id, store_created_date, store_modified_date, legacy_connection_id, store_external_order_id, created_by_recurring_payment
Bulk Upsert Orders
Insert multiple orders or update them if they already exist in ActiveCampaign. This action uses the GraphQL bulkUpsertOrders mutation to synchronously create or update multiple e-commerce orders in a single request. Orders are matched by storeOrderId - if an order with the same storeOrderId exists for the given connection, it will be updated; otherwise, a new order will be created. Use this action when you need to sync multiple orders from your e-commerce system to ActiveCampaign in an efficient manner. This is ideal for batch imports, periodic syncs, or processing multiple orders at once.
Inputs: orders
Bulk Upsert Orders Async
Tool to insert or update multiple orders asynchronously in ActiveCampaign with high throughput. This action performs data store writes completely asynchronously, making it much faster than synchronous bulk operations. Recommended for all stores processing large volumes of orders. Use when you need to import historical orders or sync real-time order data from e-commerce platforms.
Inputs: orders
Bulk Upsert Products
Create or update multiple products in a single request using ActiveCampaign's GraphQL API. This action uses the bulkUpsertProducts mutation to efficiently create or update multiple products at once. The API automatically deduplicates entries with identical storePrimaryId and legacyConnectionId combinations, ensuring no duplicate products are created.
Inputs: products
Upsert Recurring Payments Bulk
Create or update multiple recurring payments asynchronously in ActiveCampaign. Use this action to sync subscription data from your e-commerce platform to ActiveCampaign for automated marketing and customer tracking.
Inputs: recurring_payments